com.sas.actionprovider.support.remotefileselector
Class BaseRemoteFileSelectorSupport

com.sas.actionprovider.support.remotefileselector.BaseRemoteFileSelectorSupport

All Implemented Interfaces:

RemoteFileSelectorAreaInterface

Direct Known Subclasses:

SwingRemoteFileSelectorSupport

public abstract class BaseRemoteFileSelectorSupport
implements RemoteFileSelectorAreaInterface

In the context of the ActionProvider framework, this Support class assists in the registering and retrieval of actions for RemoteFileSelector components.

Since:

3.1

Field Summary

static java.lang.String	ADD_FOLDER_ACTION The actionType key used to allow adding of new folders.
static java.lang.String	DISPLAY_SEARCH_RESULTS_ACTION The actionType key used to change to search mode
static java.lang.String	OPEN_FOLDER_ACTION The actionType key used to define the default drill down action or open folder action for the RemoteFileSelector.
static java.lang.String	START_SEARCH_ACTION The actionType key used to allow searching.
static java.lang.String	UP_ONE_LEVEL_ACTION The actionType key used to define the default drill up action or open of parent folder action for the RemoteFileSelector.

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.support.remotefileselector.RemoteFileSelectorAreaInterface

COMBO_AREA, DRILL_DOWN_AREA, FILTER_TYPE_AREA, SEARCH_BUTTON_AREA, TOOLBAR_AREA, TREE_AREA

Constructor Summary

BaseRemoteFileSelectorSupport(java.lang.Class actionClass)
Constructor that allows specification of an action class.

Method Summary

protected void	createDefaultActions() Initializes the actionClass property and creates the default actions that this class supports.
protected int	getActionStatus(BaseAction action, ActionSupportFilter actionFilter) Determines the action's enabled status.
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() Performs the object initialization functions.
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, newActionInstance, reset, setAction, setActionOrderList, setActionProvider, setLocale

Field Detail

OPEN_FOLDER_ACTION

public static final java.lang.String OPEN_FOLDER_ACTION

The actionType key used to define the default drill down action or open folder action for the RemoteFileSelector. By default, this action is associated with the TOOLBAR_AREA and the first column in the "Detail" view of the "DATA_CELL_AREA" for folders.

See Also:

Constant Field Values

UP_ONE_LEVEL_ACTION

public static final java.lang.String UP_ONE_LEVEL_ACTION

The actionType key used to define the default drill up action or open of parent folder action for the RemoteFileSelector. By default, this action is associated with the TOOLBAR_AREA and the first column in the "Detail" view of the "DATA_CELL_AREA" for folders.

See Also:

Constant Field Values

START_SEARCH_ACTION

public static final java.lang.String START_SEARCH_ACTION

The actionType key used to allow searching.

See Also:

Constant Field Values

ADD_FOLDER_ACTION

public static final java.lang.String ADD_FOLDER_ACTION

The actionType key used to allow adding of new folders.

See Also:

Constant Field Values

DISPLAY_SEARCH_RESULTS_ACTION

public static final java.lang.String DISPLAY_SEARCH_RESULTS_ACTION

The actionType key used to change to search mode

See Also:

Constant Field Values

Constructor Detail

BaseRemoteFileSelectorSupport

public BaseRemoteFileSelectorSupport(java.lang.Class actionClass)

Constructor that allows specification of an action class.

Parameters:

actionClass - The class used to instantiate new actions.

Method Detail

initialize

public void initialize()

Performs the object initialization functions.

Specified by:

initialize in class BaseActionProviderSupport

See Also:

BaseActionProviderSupport.setLocale(java.util.Locale)

createDefaultActions

protected void createDefaultActions()

Initializes the actionClass property and creates the default actions that this class supports. This method is called by the action provider that instantiates this support class.

getAreaScopeAttributeMap

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.

This method will become abstract once everyone makes the conversion from setActionAttributes()

Specified by:

getAreaScopeAttributeMap in class BaseActionProviderSupport

Parameters:

filter - Defines the specific area.

Returns:

mappings for a pre-defined set of Action Attribues keys

getActionStatus

protected int getActionStatus(BaseAction action,
                              ActionSupportFilter actionFilter)

Determines the action's enabled status.

Overrides:

getActionStatus in class BaseActionProviderSupport

Parameters:

action - the action to verify status

actionFilter - the support filter where the action is being run

Returns:

the status of the action

See Also:

BaseActionProviderSupport

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.

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)