com.sas.actionprovider.support
Class ESRIToolbarSupport

com.sas.actionprovider.support.ESRIToolbarSupport

All Implemented Interfaces:

MapActionValueKeys

public class ESRIToolbarSupport
implements MapActionValueKeys

Field Summary

static java.lang.String

ACTION_ATTRIBUTE_VIEWER_ID

Fields inherited from class com.sas.actionprovider.support.BaseActionProviderSupport

AREA_DISABLED, AREA_VALUE_ATTRKEY, DISABLED, ENABLED, IS_CURRENT_STATE_DISABLED, MODEL_MEMBER_DISABLED, MODEL_STATE_DISABLED, MODEL_TYPE_DISABLED, NON_SPECIFIC_AREA, UNSUPPORTED, VIEWER_DISABLED

Fields inherited from interface com.sas.actionprovider.strategies.MapActionValueKeys

CLICKX, CLICKY, CONTROLPRESSED, DATA_VALUE_AREA, HEIGHT, JS_FUNCTION_NAME, MAP_AREA, MAP_OTHER_AREA, MAP_TOOLBAR_AREA, MEASURE, RESIZE_GRAPH_ACTION, WIDTH

Constructor Summary

ESRIToolbarSupport(java.lang.Class actionClass)
Constructor

Method Summary

protected BaseAction	createAndRegisterAction(java.lang.String areaType, java.lang.String actionType)
protected java.util.Map	getAreaScopeAttributeMap(ActionSupportFilter filter) Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area.
void	initialize() Initializes the support class.
protected java.util.Map	initializeShortActionTypeMap() This method is called by the constructor and used to initiallize the actionTypeToShortActionTypeMap map.
BaseAction	newActionInstance(java.lang.String actionArea, java.lang.String actionType) Return a newly instantiated default Action based on the specified actionType or return null if actionType not recognized.
protected void	registerDynamicValueInfo() Registers, via addDynamicValueInfo method, the dynamic value information for different areas.
protected boolean	validArea(Area area, ActionSupportFilter filter) Validates that the given Area's 'type' and, if specified, its 'value' constraints are met by the information provided on the action filter.

Methods inherited from class com.sas.actionprovider.support.BaseActionProviderSupport

addDefaultAction, getAction, getActionId, getActionOrderList, getActionProvider, getActions, getActionScopeAttribute, getActionScopeAttributeMap, getDefaultAction, getLocale, listActionTypes, listAreaTypes, listDefaultActions, reset, setAction, setActionOrderList, setActionProvider, setLocale

Field Detail

ACTION_ATTRIBUTE_VIEWER_ID

public static final java.lang.String ACTION_ATTRIBUTE_VIEWER_ID

See Also:

Constant Field Values

Constructor Detail

ESRIToolbarSupport

public ESRIToolbarSupport(java.lang.Class actionClass)

Constructor

Parameters:

actionClass - The class used to instantiate new actions.

Method Detail

createAndRegisterAction

protected BaseAction createAndRegisterAction(java.lang.String areaType,
                                             java.lang.String actionType)

registerDynamicValueInfo

protected void registerDynamicValueInfo()

Registers, via addDynamicValueInfo method, the dynamic value information for different areas.

newActionInstance

public BaseAction newActionInstance(java.lang.String actionArea,
                                    java.lang.String actionType)

Return a newly instantiated default Action based on the specified actionType or return null if actionType not recognized.

Specified by:

newActionInstance in class BaseActionProviderSupport

Parameters:

actionType - the key associated with a defined action type.

actionArea - the key associated with a defined area type.

Returns:

a new action of the specified type or null if the type is not recognized.

getAreaScopeAttributeMap

protected java.util.Map getAreaScopeAttributeMap(ActionSupportFilter filter)

Description copied from class: BaseActionProviderSupport

Returns mappings for a pre-defined set of Action attribute keys to their corresponding dynamic values for a specific area.

Specified by:

getAreaScopeAttributeMap in class BaseActionProviderSupport

Parameters:

filter - Defines the specific area.

Returns:

mappings for a pre-defined set of Action Attribues keys

validArea

protected boolean validArea(Area area,
                            ActionSupportFilter filter)

Validates that the given Area's 'type' and, if specified, its 'value' constraints are met by the information provided on the action filter. If the Area is null or its 'type' is null then boolean true is returned because then there are no constraints specified and, therefore, any specification of the current area on the actionFilter must be valid. Otherwise, the method validates that the area 'type' and, if specified, area 'value' match the current area state represented by information on the actionFilter. In the COLUMN_HEADER_AREA and the ROW_HEADER_AREA, the Area 'values' should be the name of a row or column header that matches the header of the tupleElement on the action filter.

Specified by:

validArea in class BaseActionProviderSupport

Parameters:

area - The Area object that may or may not specify certain area 'values'.

actionFilter - the ActionSupportFilter that the component passed as an argument on the getActions() method.

Returns:

a boolean indicating whether the current area represented on the actionFilter matches any of the specified values on the Area object.

See Also:

BaseActionProviderSupport.setAction(com.sas.actionprovider.BaseAction, java.util.Collection, com.sas.actionprovider.Area), BaseActionProviderSupport.getActions(com.sas.actionprovider.ActionSupportFilter)

initializeShortActionTypeMap

protected java.util.Map initializeShortActionTypeMap()

This method is called by the constructor and used to initiallize the actionTypeToShortActionTypeMap map. This map should contain the ActionType as the key and the new short name as the value. The short names are used to generate ids for HttpActions.

Overrides:

initializeShortActionTypeMap in class BaseActionProviderSupport

initialize

public void initialize()

Description copied from class: BaseActionProviderSupport

Initializes the support class.

Called by the ActionProvider after it sets the locale on this support class.

Specified by:

initialize in class BaseActionProviderSupport

See Also:

BaseActionProviderSupport.setLocale(java.util.Locale)