com.sas.actionprovider.strategies
Class MapPropertyStrategy

com.sas.actionprovider.strategies.MapPropertyStrategy

All Implemented Interfaces:

ActionStatusKeysInterface, ActionStrategyInterface

public class MapPropertyStrategy

Field Summary

Fields inherited from class com.sas.actionprovider.strategies.BaseMapStrategy

activeImage, disabledImage, image, RB_KEY, rolloverImage, SELECTED_IMAGE, title

Fields inherited from class com.sas.actionprovider.strategies.BaseActionStrategy

TEMPLATE_DELIMITER

Fields inherited from interface com.sas.actionprovider.ActionStatusKeysInterface

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

Constructor Summary

MapPropertyStrategy()
Default constructor.

MapPropertyStrategy(boolean swing, SelectorActionUtil util)
Constructor for specifying type ( swing/http ) of strategy object.

Method Summary

int	getActionStatus(BaseAction action, ActionSupportFilter filter) Returns a status value indicating whether the Action is enabled for a specific area as described by various filter attributes.
java.lang.String	getDescription(java.util.Locale locale) Gets the description of this strategy.
java.lang.String	getDisabledImageName() Gets the name of the image displayed when this action is disabled.
java.lang.String	getImageName() Gets the name of the image associated with this strategy.
java.lang.String	getName(java.util.Locale locale) Gets the name of this strategy.
java.lang.String	getTitle(java.util.Locale locale)
protected void	initialize() Initialize this strategy object.
protected void	initializeActionAttributes(BaseAction action, java.lang.String areaType, java.util.Locale locale) Initializes an Action with all its default attributes, default AttributeDescriptor property settings and default values for non-locale-dependent attributes.

Methods inherited from class com.sas.actionprovider.strategies.BaseMapStrategy

addDynamicValueInfo, getActiveImage, getRolloverImage, setActiveImage, setRolloverImage, setTitle

Methods inherited from class com.sas.actionprovider.strategies.BaseActionStrategy

addDynamicValueInfo, addDynamicValueInfo, getCustomAttributeValue, getDynamicValue, getUtilObject, initializeAction, isSwing, setActionAttributes, setLocaleDependentDefaultAttributes, setSwing, setUtilObject

Constructor Detail

MapPropertyStrategy

public MapPropertyStrategy()

Default constructor. Calls the other constructor for specifying strategy type.

MapPropertyStrategy

public MapPropertyStrategy(boolean swing,
                           SelectorActionUtil util)

Constructor for specifying type ( swing/http ) of strategy object.

Parameters:

swing - boolean indicating whether the strategy will be used in a swing environment. If false, the strategy is http type.

Method Detail

initializeActionAttributes

protected void initializeActionAttributes(BaseAction action,
                                          java.lang.String areaType,
                                          java.util.Locale locale)

Description copied from class: BaseActionStrategy

Initializes an Action with all its default attributes, default AttributeDescriptor property settings and default values for non-locale-dependent attributes. values.

This base implementation does nothing to the Action.

Overrides:

initializeActionAttributes in class BaseMapStrategy

Parameters:

action - The instance of the Action to be initialized.

areaType - The areaType of the Viewer where the Action will be presented.

locale - The locale

initialize

protected void initialize()

Description copied from class: BaseActionStrategy

Initialize this strategy object.

This method should be overridden to register the dynamic value information for specific strategies. Registration is accomplished via the BaseActionStrategy.addDynamicValueInfo(java.lang.String, java.lang.String, java.lang.Object, java.lang.String) method. the

Overrides:

initialize in class BaseActionStrategy

See Also:

#setReturnStatus

getActionStatus

public int getActionStatus(BaseAction action,
                           ActionSupportFilter filter)

Description copied from class: BaseActionStrategy

Returns a status value indicating whether the Action is enabled for a specific area as described by various filter attributes.

If enabled, the value is: ActionStatusKeysInterface.ENABLED

If disabled, the value may be one of the following values which indicate why the Action is disabled.

• ActionStatusKeysInterface.VIEWER_DISABLED
• ActionStatusKeysInterface.AREA_DISABLED
• ActionStatusKeysInterface.MODEL_TYPE_DISABLED
• ActionStatusKeysInterface.MODEL_STATE_DISABLED
• ActionStatusKeysInterface.MODEL_MEMBER_DISABLED
• ActionStatusKeysInterface.IS_CURRENT_STATE_DISABLED
• ActionStatusKeysInterface.DISABLED
• ActionStatusKeysInterface.UNSUPPORTED

The status of an Action with a CommandSupportedInterface command whose isSupported() method returns false will have the ActionStatusKeysInterface.UNSUPPORTED status bit set.

The status of an Action with a CommandStatusInterface command will have the status bit value returned by the command's getCommandStatus() method.

The Action's status may also be set with bit values that are determined by the support class in addition to a command.

Specified by:

getActionStatus in interface ActionStrategyInterface

Overrides:

getActionStatus in class BaseActionStrategy

Parameters:

action - The action for which status is to be determined.

filter - The ActionSupportFilter that encapsulates all information describing the specific area.

Returns:

the boolean indicating whether the Action is enabled

See Also:

CommandSupportedInterface, CommandStatusInterface

getName

public java.lang.String getName(java.util.Locale locale)

Gets the name of this strategy.

Overrides:

getName in class BaseMapStrategy

Parameters:

locale - The locale

Returns:

the name of this strategy

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Gets the description of this strategy. The description is the text that is displayed on the dropdown menu for the VisualDataExplorer menu bar.

Overrides:

getDescription in class BaseMapStrategy

Parameters:

locale - The locale

Returns:

the description of this strategy

getImageName

public java.lang.String getImageName()

Gets the name of the image associated with this strategy. The image name is the name of the image that is displayed on the dropdown menu for the VisualDataExplorer menu bar.

Overrides:

getImageName in class BaseMapStrategy

Returns:

the name of the image associated with this strategy

getDisabledImageName

public java.lang.String getDisabledImageName()

Gets the name of the image displayed when this action is disabled. The disabled image name is the name of the image that is displayed on the dropdown menu for the VisualDataExplorer menu bar when this action is disabled.

Overrides:

getDisabledImageName in class BaseMapStrategy

Returns:

the name of the image displayed when this action is disabled

getTitle

public java.lang.String getTitle(java.util.Locale locale)

Overrides:

getTitle in class BaseMapStrategy

Returns:

Returns the title.