org.javarosa.core.model.actions

Class Action

java.lang.Object

org.javarosa.core.model.actions.Action

All Implemented Interfaces:

Externalizable

Direct Known Subclasses:

SetGeopointAction, SetValueAction

public abstract class Action
extends Object
implements Externalizable

Author:

ctsims

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_JR_INSERT Deprecated. because it was never documented. Use EVENT_ODK_NEW_REPEAT instead.
static String	EVENT_ODK_INSTANCE_FIRST_LOAD Dispatched the first time a form instance is loaded.
static String	EVENT_ODK_NEW_REPEAT
static String	EVENT_QUESTION_VALUE_CHANGED
static String	EVENT_XFORMS_READY Deprecated. because as W3C XForms defines it, it should be dispatched any time the XForms engine is ready. In JavaRosa, it was dispatched only on first load of a form instance. Use EVENT_ODK_INSTANCE_FIRST_LOAD instead.
static String	EVENT_XFORMS_REVALIDATE

Constructor Summary

Constructors

Constructor and Description
Action()
Action(String name)

Method Summary

Modifier and Type	Method and Description
String	getName()
static boolean	isValidEvent(String actionEventAttribute)
abstract TreeReference	processAction(FormDef model, TreeReference context) Process actions that were triggered in the form.
void	readExternal(DataInputStream in, PrototypeFactory pf)
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_ODK_INSTANCE_FIRST_LOAD

public static final String EVENT_ODK_INSTANCE_FIRST_LOAD

Dispatched the first time a form instance is loaded.

See Also:

Constant Field Values

EVENT_XFORMS_READY

@Deprecated
public static final String EVENT_XFORMS_READY

Deprecated. because as W3C XForms defines it, it should be dispatched any time the XForms engine is ready. In JavaRosa, it was dispatched only on first load of a form instance. Use EVENT_ODK_INSTANCE_FIRST_LOAD instead.

See Also:

Constant Field Values

EVENT_XFORMS_REVALIDATE

public static final String EVENT_XFORMS_REVALIDATE

See Also:

Constant Field Values

EVENT_ODK_NEW_REPEAT

public static final String EVENT_ODK_NEW_REPEAT

See Also:

Constant Field Values

EVENT_JR_INSERT

public static final String EVENT_JR_INSERT

Deprecated. because it was never documented. Use EVENT_ODK_NEW_REPEAT instead.

See Also:

Constant Field Values

EVENT_QUESTION_VALUE_CHANGED

public static final String EVENT_QUESTION_VALUE_CHANGED

See Also:

Constant Field Values

Constructor Detail

Action

public Action()

Action

public Action(String name)

Method Detail

getName

public String getName()

processAction

public abstract TreeReference processAction(FormDef model,
                                            TreeReference context)

Process actions that were triggered in the form. NOTE: Currently actions are only processed on nodes that are WITHIN the context provided, if one is provided. This will need to get changed possibly for future action types.

Returns:

TreeReference targeted by the action or null if the action wasn't completed.

readExternal

public void readExternal(DataInputStream in,
                         PrototypeFactory pf)
                  throws IOException,
                         DeserializationException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

isValidEvent

public static boolean isValidEvent(String actionEventAttribute)