stanford.androidlib

Class SimpleEvents

java.lang.Object

stanford.androidlib.SimpleEvents

public final class SimpleEvents
extends Object

A utility class for event handling.

 SimpleEvents.with(context).handleEnterKeyPress(myEditText);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimpleEvents.EnterKeyPressListener A simple event listening interface that listens for Enter keypresses on an editable text view.
static class	SimpleEvents.EnterKeyPressSuppressor

Method Summary

Modifier and Type	Method and Description
void	handleEnterKeyPress(View editText) Attaches a listener so that this activity's onEnterKeyPress method will be called when the Enter key is pressed on the given view.
void	listen(int viewID, String eventName) Attaches an event listener for the appropriate event that will call a method whose name is the same as the given event name, passing it the given parameters as appropriate.
void	listen(int viewID, String eventName, String methodName, Object... params) Attaches an event listener for the appropriate event that will call the method with the given name, passing it the given parameters as appropriate.
void	listen(View view, String eventName) Attaches an event listener for the appropriate event that will call a method whose name is the same as the given event name, passing it the given parameters as appropriate.
void	listen(View view, String eventName, String methodName, Object... params) Attaches an event listener for the appropriate event that will call the method with the given name, passing it the given parameters as appropriate.
static SimpleEvents	with(Context context) Returns a singleton SimpleEvents instance bound to the given context.
static SimpleEvents	with(Fragment context) Returns a singleton SimpleEvents instance bound to the given fragment's context.
static SimpleEvents	with(View context) Returns a singleton SimpleEvents instance bound to the given view's context.

Methods inherited from class java.lang.Object

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

Method Detail

with

public static SimpleEvents with(Context context)

Returns a singleton SimpleEvents instance bound to the given context.

with

public static SimpleEvents with(Fragment context)

Returns a singleton SimpleEvents instance bound to the given fragment's context.

with

public static SimpleEvents with(View context)

Returns a singleton SimpleEvents instance bound to the given view's context.

handleEnterKeyPress

public void handleEnterKeyPress(View editText)

Attaches a listener so that this activity's onEnterKeyPress method will be called when the Enter key is pressed on the given view. Now also supports keyboard cursor movement with arrow keys and Home/End for physical keyboards.

listen

public void listen(@IdRes
                   int viewID,
                   String eventName)

Attaches an event listener for the appropriate event that will call a method whose name is the same as the given event name, passing it the given parameters as appropriate.

Parameters:

viewID - the ID of the widget on which to listen for the event

eventName - event's name such as "click" or "onClick" (case-insensitive);

Throws:

IllegalArgumentException - if the given event is not supported, the given method does not exist, is static, abstract, non-accessible, or does not accept the given number of parameters

RuntimeException - if the given method experiences any run-time error related to its reflection.

listen

public void listen(View view,
                   String eventName)

Attaches an event listener for the appropriate event that will call a method whose name is the same as the given event name, passing it the given parameters as appropriate.

Parameters:

view - the widget on which to listen for the event

eventName - event's name such as "click" or "onClick" (case-insensitive);

Throws:

IllegalArgumentException - if the given event is not supported, the given method does not exist, is static, abstract, non-accessible, or does not accept the given number of parameters

RuntimeException - if the given method experiences any run-time error related to its reflection.

listen

public void listen(@IdRes
                   int viewID,
                   String eventName,
                   String methodName,
                   Object... params)

Attaches an event listener for the appropriate event that will call the method with the given name, passing it the given parameters as appropriate.

Parameters:

viewID - the ID of the widget on which to listen for the event

eventName - event's name such as "click" or "onClick" (case-insensitive); currently supported events are "click", ...

methodName - the exact name of the method to invoke on the context object (case-sensitive) such as "fooBar" for "public void fooBar()"

params - any parameters that you would like to pass to the given method (can be omitted if it accepts no parameters or only a View arg)

Throws:

IllegalArgumentException - if the given event is not supported, the given method does not exist, is static, abstract, non-accessible, or does not accept the given number of parameters

RuntimeException - if the given method experiences any run-time error related to its reflection.

listen

public void listen(View view,
                   String eventName,
                   String methodName,
                   Object... params)

Attaches an event listener for the appropriate event that will call the method with the given name, passing it the given parameters as appropriate.

Parameters:

view - the widget on which to listen for the event

eventName - event's name such as "click" or "onClick" (case-insensitive); currently supported events are "click", ...

methodName - the exact name of the method to invoke on the context object (case-sensitive) such as "fooBar" for "public void fooBar()"

params - any parameters that you would like to pass to the given method (can be omitted if it accepts no parameters or only a View arg)

Throws:

IllegalArgumentException - if the given event is not supported, the given method does not exist, is static, abstract, non-accessible, or does not accept the given number of parameters

RuntimeException - if the given method experiences any run-time error related to its reflection.