com.percolate.caffeine

Class ViewUtils

java.lang.Object

com.percolate.caffeine.ViewUtils

public class ViewUtils
extends java.lang.Object

Utility methods that make working with views easier, less error prone, and more concise.

Common uses:

TextView textView = ViewUtils.findViewById(this, R.id.my_text_view); //no more casting!
TextView textView = ViewUtils.findViewById(parentView, R.id.my_text_view); //no more casting!
String text = ViewUtils.getText(this, R.id.my_text_view);
ViewUtils.setText(this, R.id.my_text_vew, "new text");
ViewUtils.setText(textView, "new text");
ViewUtils.appendText(textView, "appended");
ViewUtils.hideView(this, R.id.my_text_view);
ViewUtils.showView(this, R.id.my_text_view);
Bitmap bitmap = ViewUtils.viewToImage(this, R.id.my_layout);
ViewUtils.showKeyboard(this, R.id.my_text_view);
ViewUtils.closeKeyboard(this, R.id.my_text_view);

Constructor Summary

Constructors

Constructor and Description
ViewUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	appendText(android.widget.TextView view, java.lang.String toAppend) Append given text String to the provided view (one of TextView or EditText).
static void	closeKeyboard(android.content.Context context, android.view.View field) Go away keyboard, nobody likes you.
static <T extends android.view.View> T	findViewById(android.app.Activity context, int id) Utility method to make getting a View via findViewById() more safe & simple.
static <T extends android.view.View> T	findViewById(android.view.View parentView, int id) Utility method to make getting a View via findViewById() more safe & simple.
static java.lang.String	getText(android.app.Activity context, int id) Get text as String from EditView.
static java.lang.String	getText(android.widget.TextView view) Get text as String from EditView.
static void	hideView(android.app.Activity context, int id) Sets visibility of the given view to View.GONE.
static void	setText(android.app.Activity context, int field, java.lang.String text) Method used to set text for a TextView
static void	setText(android.view.View parentView, int field, java.lang.String text) Method used to set text for a TextView
static void	showKeyboard(android.content.Context context, android.view.View field) Show the pop-up keyboard
static void	showView(android.app.Activity context, int id) Sets visibility of the given view to View.VISIBLE.
static android.graphics.Bitmap	viewToImage(android.content.Context context, android.webkit.WebView viewToBeConverted) Convert view to an image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewUtils

public ViewUtils()

Method Detail

findViewById

public static <T extends android.view.View> T findViewById(android.app.Activity context,
                                           int id)

Utility method to make getting a View via findViewById() more safe & simple.

- Casts view to appropriate type based on expected return value - Handles & logs invalid casts

Parameters:

context - The current Context or Activity that this method is called from

id - R.id value for view

Returns:

View object, cast to appropriate type based on expected return value.

Throws:

java.lang.ClassCastException - if cast to the expected type breaks.

findViewById

public static <T extends android.view.View> T findViewById(android.view.View parentView,
                                           int id)

Utility method to make getting a View via findViewById() more safe & simple.

- Casts view to appropriate type based on expected return value - Handles & logs invalid casts

Parameters:

parentView - Parent View containing the view we are trying to get

id - R.id value for view

Returns:

View object, cast to appropriate type based on expected return value.

Throws:

java.lang.ClassCastException - if cast to the expected type breaks.

getText

public static java.lang.String getText(android.widget.TextView view)

Get text as String from EditView. Note: returns "" for null EditText, not a NullPointerException

Parameters:

view - EditView to get text from

Returns:

the text

getText

public static java.lang.String getText(android.app.Activity context,
                       int id)

Get text as String from EditView. Note: returns "" for null EditText, not a NullPointerException

Parameters:

context - The current Context or Activity that this method is called from

id - Id for the TextView/EditView to get text from

Returns:

the text

appendText

public static void appendText(android.widget.TextView view,
              java.lang.String toAppend)

Append given text String to the provided view (one of TextView or EditText).

Parameters:

view - View to update

toAppend - String text

closeKeyboard

public static void closeKeyboard(android.content.Context context,
                 android.view.View field)

Go away keyboard, nobody likes you.

Parameters:

context - The current Context or Activity that this method is called from

field - field that holds the keyboard focus

showKeyboard

public static void showKeyboard(android.content.Context context,
                android.view.View field)

Show the pop-up keyboard

Parameters:

context - Activity/Context

field - field that requests focus

viewToImage

public static android.graphics.Bitmap viewToImage(android.content.Context context,
                                  android.webkit.WebView viewToBeConverted)

Convert view to an image. Can be used to make animations smoother.

Parameters:

context - The current Context or Activity that this method is called from

viewToBeConverted - View to convert to a Bitmap

Returns:

Bitmap object that can be put in an ImageView. Will look like the converted viewToBeConverted.

setText

public static void setText(android.app.Activity context,
           int field,
           java.lang.String text)

Method used to set text for a TextView

Parameters:

context - The current Context or Activity that this method is called from

field - R.id.xxxx value for the text field.

text - Text to place in the text field.

setText

public static void setText(android.view.View parentView,
           int field,
           java.lang.String text)

Method used to set text for a TextView

Parameters:

parentView - The View used to call findViewId() on

field - R.id.xxxx value for the text field.

text - Text to place in the text field.

hideView

public static void hideView(android.app.Activity context,
            int id)

Sets visibility of the given view to View.GONE.

Parameters:

context - The current Context or Activity that this method is called from

id - R.id.xxxx value for the view to hide"expected textView to throw a ClassCastException" + textView

showView

public static void showView(android.app.Activity context,
            int id)

Sets visibility of the given view to View.VISIBLE.

Parameters:

context - The current Context or Activity that this method is called from

id - R.id.xxxx value for the view to show