atg.droplet
Interface EventReceiver

All Known Implementing Classes:

AnchorTag, FormEventReceiver, InputTag

public interface EventReceiver

An EventReceiver is a tag that receives events from requests (either Anchor events or Form events).

This interface is implemented by the AnchorTag and the FormEventReceiver tags: InputTag, SelectTag, and TextAreaTag.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

java.lang.String	getComponentPath() Return the path name of the component
TagConverter	getConverter() The converter to apply to any set accesses to this value
java.util.Properties	getConverterArgs() The arguments for the converter
java.lang.String	getDefault()
java.lang.String	getName() Get the name of the parameter that identifies this event as occuring
int[][]	getPathDims() Return the dimensions for each entry in the path.
java.lang.String[]	getPathNames() Return the array of path names that reference the properties
java.lang.String	getPropertyPath() Return the complete path name of the property
java.lang.String	getSubmitValue()
boolean	isImage() Is this handler expecting an image expecting .x and .y args?
void	setPathDims(int[][] pPathNames) Sets the dimensions for each entry of the path (could be null if no path entries have dimensions).
void	setPathNames(java.lang.String[] pPathNames) Sets the list of path names

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getDefault

java.lang.String getDefault()

Returns:

the default value to use in a set event if no value was specified

getSubmitValue

java.lang.String getSubmitValue()

Returns:

the value to use when the submit occurs (overriding the value in the form). If this returns null, we use the value in the form.

getName

java.lang.String getName()

Get the name of the parameter that identifies this event as occuring

getPropertyPath

java.lang.String getPropertyPath()

Return the complete path name of the property

getPathNames

java.lang.String[] getPathNames()

Return the array of path names that reference the properties

setPathNames

void setPathNames(java.lang.String[] pPathNames)

Sets the list of path names

getPathDims

int[][] getPathDims()

Return the dimensions for each entry in the path. If this returns null, there are no dimensions for any of the path dimensions.

setPathDims

void setPathDims(int[][] pPathNames)

Sets the dimensions for each entry of the path (could be null if no path entries have dimensions).

getComponentPath

java.lang.String getComponentPath()

Return the path name of the component

isImage

boolean isImage()

Is this handler expecting an image expecting .x and .y args?

getConverter

TagConverter getConverter()

The converter to apply to any set accesses to this value

getConverterArgs

java.util.Properties getConverterArgs()

The arguments for the converter