com.esri.adf.web.faces.event
Class ClientActionArgs

java.lang.Object
  com.esri.adf.web.faces.event.ClientActionArgs

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CircleArgs, DragImageArgs, DragRectangleArgs, OvalArgs, PointArgs, PolygonArgs, PolylineArgs

public abstract class ClientActionArgs
extends java.lang.Object
implements java.io.Serializable

ClientActionArgs can be created for known client actions (on the map controls) such as EsriMapPoint, EsriMapLine, EsriMapOval etc. Concrete sub-classes of this class represent the actual client action arguments. They construct themselves by extracting the required parameters from the request. Below is a table of the client actions and their corresponding ClientActionArgs classes:

Client JavaScript Action	ClientActionArgs Class
ClientActions.MAP_POINT(EsriMapPoint)	PointArgs
ClientActions.MAP_LINE(EsriMapLine)	LineArgs
ClientActions.MAP_RECTANGLE(EsriMapRectangle)	DragRectangleArgs
ClientActions.MAP_CIRCLE(EsriMapCircle)	CircleArgs
ClientActions.MAP_OVAL(EsriMapOval)	OvalArgs
ClientActions.MAP_POLYLINE(EsriMapPolyline)	PolylineArgs
ClientActions.MAP_POLYGON(EsriMapPolygon)	PolygonArgs
ClientActions.MAP_PAN(EsriMapPan)	DragImageArgs

You can add to the table of client actions by calling the addClientActionArgs method.

See Also:

Serialized Form

Field Summary

protected java.lang.String	controlId
protected java.util.Map<?,?>	requestParameters The associated request parameters.

Constructor Summary

ClientActionArgs()

Method Summary

static void	addClientActionArgs(java.lang.String clientAction, java.lang.String argsClassName) Add a client action and ClientActionArgs class mapping.
static ClientActionArgs	getClientActionArgs(java.lang.String clientAction, java.util.Map<?,?> requestParameters, java.lang.String controlId) Retrieves the ClientActionArgs responsible for the specified client action.
java.lang.String	getControlId()
abstract WebGeometry	getMapGeometry()
java.util.Map<?,?>	getRequestParameters() Returns the request parameters for this client action.
abstract WebGeometry	getWebGeometry()
abstract void	init() Initialize the sub-class of ClientActionArgs.
void	init(java.util.Map<?,?> parameters, java.lang.String controlId) Initialize the request parameters and call the abstract init method implemented by all concrete sub-classes of ClientActionArgs.

Methods inherited from class java.lang.Object

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

Field Detail

controlId

protected java.lang.String controlId

requestParameters

protected java.util.Map<?,?> requestParameters

The associated request parameters.

Constructor Detail

ClientActionArgs

public ClientActionArgs()

Method Detail

getClientActionArgs

public static ClientActionArgs getClientActionArgs(java.lang.String clientAction,
                                                   java.util.Map<?,?> requestParameters,
                                                   java.lang.String controlId)

Retrieves the ClientActionArgs responsible for the specified client action. The ClientActionArgs object is initialized with the needed request parameters.

Parameters:

clientAction - a client action string

requestParameters - the request parameters

Returns:

ClientActionArgs- the ClientActionArgs object

addClientActionArgs

public static void addClientActionArgs(java.lang.String clientAction,
                                       java.lang.String argsClassName)

Add a client action and ClientActionArgs class mapping. Users can also replace an existing mapping by using their own class for an existing client action.

Parameters:

clientAction - the client action (usually a Javascript method)

argsClassName - a concrete sub-class of ClientActionArgs associated with this client action

init

public final void init(java.util.Map<?,?> parameters,
                       java.lang.String controlId)
                throws java.lang.Exception

Initialize the request parameters and call the abstract init method implemented by all concrete sub-classes of ClientActionArgs.

Parameters:

parameters - the request parameters

Throws:

java.lang.Exception

init

public abstract void init()
                   throws java.lang.Exception

Initialize the sub-class of ClientActionArgs.

Throws:

java.lang.Exception

getRequestParameters

public java.util.Map<?,?> getRequestParameters()

Returns the request parameters for this client action.

Returns:

Map- the associated request parameters.

getControlId

public java.lang.String getControlId()

getWebGeometry

public abstract WebGeometry getWebGeometry()

getMapGeometry

public abstract WebGeometry getMapGeometry()