com.sas.actionprovider.support
Class BaseNavigationBarSupport

com.sas.actionprovider.support.BaseNavigationBarSupport

All Implemented Interfaces:

NavigationBarAreaInterface

Direct Known Subclasses:

HttpNavigationBarSupport, SwingNavigationBarSupport

public abstract class BaseNavigationBarSupport
implements NavigationBarAreaInterface

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

Field Summary

static java.lang.String	CANCEL_ACTION The actionType key used to define the cancel action.
protected BaseAction	cancelAction The cancel action.
static java.lang.String	COMMIT_ACTION The actionType key used to define the commit action.
protected BaseAction	commitAction The commit action.
static java.lang.String	DELETE_ACTION The actionType key used to define the delete action.
protected BaseAction	deleteAction The delete action.
static java.lang.String	FIRST_COLUMN_ACTION The actionType key used to define the action to scroll to the first column.
static java.lang.String	FIRST_ROW_ACTION The actionType key used to define the action to scroll to the first row.
protected BaseAction	firstColumnAction The firstColumn action.
protected BaseAction	firstRowAction The firstRow action.
static java.lang.String	GOTO_COLUMN_ACTION The actionType key used to define the goto column action.
static java.lang.String	GOTO_ROW_ACTION The actionType key used to define the goto row action.
protected BaseAction	gotoColumnAction The gotoColumn action.
protected BaseAction	gotoRowAction The gotoRow action.
static java.lang.String	INSERT_ACTION The actionType key used to define the insert action.
protected BaseAction	insertAction The insert action.
static java.lang.String	LAST_COLUMN_ACTION The actionType key used to define the action to scroll to the last column.
static java.lang.String	LAST_ROW_ACTION The actionType key used to define the action to scroll to the last row.
protected BaseAction	lastColumnAction The lastColumn action.
protected BaseAction	lastRowAction The lastRow action.
static java.lang.String	NEXT_COLUMN_ACTION The actionType key used to define the action to scroll to the next column.
static java.lang.String	NEXT_ROW_ACTION The actionType key used to define the action to scroll to the next row.
protected BaseAction	nextColumnAction The nextColumn action.
protected BaseAction	nextRowAction The nextRow action.
static java.lang.String	PAGE_BACKWARD_COLUMNS_ACTION The actionType key used to define the action to scroll to the previous column page.
static java.lang.String	PAGE_BACKWARD_ROWS_ACTION The actionType key used to define the action to scroll to the previous row page.
static java.lang.String	PAGE_FORWARD_COLUMNS_ACTION The actionType key used to define the action to scroll to the next column page.
static java.lang.String	PAGE_FORWARD_ROWS_ACTION The actionType key used to define the action to scroll to the next row page.
protected BaseAction	pageBackwardColumnsAction The pageBackwardColumns action.
protected BaseAction	pageBackwardRowsAction The pageBackwardRows action.
protected BaseAction	pageForwardColumnsAction The pageForwardColumns action.
protected BaseAction	pageForwardRowsAction The pageForwardRows action.
static java.lang.String	PREVIOUS_COLUMN_ACTION The actionType key used to define the action to scroll to the previous column.
static java.lang.String	PREVIOUS_ROW_ACTION The actionType key used to define the action to scroll to the previous row.
protected BaseAction	previousColumnAction The previousColumn action.
protected BaseAction	previousRowAction The previousRow action.
static java.lang.String	UPDATE_ACTION The actionType key used to define the update action.
protected BaseAction	updateAction The update action.

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.NavigationBarAreaInterface

COLUMN_GOTO_AREA, COLUMN_SCROLL_BACKWARD_AREA, COLUMN_SCROLL_FORWARD_AREA, EDIT_AREA, ROW_GOTO_AREA, ROW_SCROLL_BACKWARD_AREA, ROW_SCROLL_FORWARD_AREA

Constructor Summary

BaseNavigationBarSupport(java.lang.Class actionClass)
Constructor

Method Summary

protected void	createDefaultActions() Initializes the actionClass property and creates the default actions that this class supports.
protected BaseAction	defineActionProperties(BaseAction action, java.lang.String actionType) Returns an action whose default dynamic attributes have been defined according to their 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 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

FIRST_ROW_ACTION

public static final java.lang.String FIRST_ROW_ACTION

The actionType key used to define the action to scroll to the first row.

See Also:

Constant Field Values

PAGE_BACKWARD_ROWS_ACTION

public static final java.lang.String PAGE_BACKWARD_ROWS_ACTION

The actionType key used to define the action to scroll to the previous row page.

See Also:

Constant Field Values

PREVIOUS_ROW_ACTION

public static final java.lang.String PREVIOUS_ROW_ACTION

The actionType key used to define the action to scroll to the previous row.

See Also:

Constant Field Values

NEXT_ROW_ACTION

public static final java.lang.String NEXT_ROW_ACTION

The actionType key used to define the action to scroll to the next row.

See Also:

Constant Field Values

PAGE_FORWARD_ROWS_ACTION

public static final java.lang.String PAGE_FORWARD_ROWS_ACTION

The actionType key used to define the action to scroll to the next row page.

See Also:

Constant Field Values

LAST_ROW_ACTION

public static final java.lang.String LAST_ROW_ACTION

The actionType key used to define the action to scroll to the last row.

See Also:

Constant Field Values

GOTO_ROW_ACTION

public static final java.lang.String GOTO_ROW_ACTION

The actionType key used to define the goto row action.

See Also:

Constant Field Values

FIRST_COLUMN_ACTION

public static final java.lang.String FIRST_COLUMN_ACTION

The actionType key used to define the action to scroll to the first column.

See Also:

Constant Field Values

PAGE_BACKWARD_COLUMNS_ACTION

public static final java.lang.String PAGE_BACKWARD_COLUMNS_ACTION

The actionType key used to define the action to scroll to the previous column page.

See Also:

Constant Field Values

PREVIOUS_COLUMN_ACTION

public static final java.lang.String PREVIOUS_COLUMN_ACTION

The actionType key used to define the action to scroll to the previous column.

See Also:

Constant Field Values

NEXT_COLUMN_ACTION

public static final java.lang.String NEXT_COLUMN_ACTION

The actionType key used to define the action to scroll to the next column.

See Also:

Constant Field Values

PAGE_FORWARD_COLUMNS_ACTION

public static final java.lang.String PAGE_FORWARD_COLUMNS_ACTION

The actionType key used to define the action to scroll to the next column page.

See Also:

Constant Field Values

LAST_COLUMN_ACTION

public static final java.lang.String LAST_COLUMN_ACTION

The actionType key used to define the action to scroll to the last column.

See Also:

Constant Field Values

GOTO_COLUMN_ACTION

public static final java.lang.String GOTO_COLUMN_ACTION

The actionType key used to define the goto column action.

See Also:

Constant Field Values

INSERT_ACTION

public static final java.lang.String INSERT_ACTION

The actionType key used to define the insert action.

See Also:

Constant Field Values

DELETE_ACTION

public static final java.lang.String DELETE_ACTION

The actionType key used to define the delete action.

See Also:

Constant Field Values

COMMIT_ACTION

public static final java.lang.String COMMIT_ACTION

The actionType key used to define the commit action.

See Also:

Constant Field Values

CANCEL_ACTION

public static final java.lang.String CANCEL_ACTION

The actionType key used to define the cancel action.

See Also:

Constant Field Values

UPDATE_ACTION

public static final java.lang.String UPDATE_ACTION

The actionType key used to define the update action.

See Also:

Constant Field Values

firstRowAction

protected BaseAction firstRowAction

The firstRow action.

pageBackwardRowsAction

protected BaseAction pageBackwardRowsAction

The pageBackwardRows action.

previousRowAction

protected BaseAction previousRowAction

The previousRow action.

nextRowAction

protected BaseAction nextRowAction

The nextRow action.

pageForwardRowsAction

protected BaseAction pageForwardRowsAction

The pageForwardRows action.

lastRowAction

protected BaseAction lastRowAction

The lastRow action.

gotoRowAction

protected BaseAction gotoRowAction

The gotoRow action.

firstColumnAction

protected BaseAction firstColumnAction

The firstColumn action.

pageBackwardColumnsAction

protected BaseAction pageBackwardColumnsAction

The pageBackwardColumns action.

previousColumnAction

protected BaseAction previousColumnAction

The previousColumn action.

nextColumnAction

protected BaseAction nextColumnAction

The nextColumn action.

pageForwardColumnsAction

protected BaseAction pageForwardColumnsAction

The pageForwardColumns action.

lastColumnAction

protected BaseAction lastColumnAction

The lastColumn action.

gotoColumnAction

protected BaseAction gotoColumnAction

The gotoColumn action.

insertAction

protected BaseAction insertAction

The insert action.

deleteAction

protected BaseAction deleteAction

The delete action.

commitAction

protected BaseAction commitAction

The commit action.

cancelAction

protected BaseAction cancelAction

The cancel action.

updateAction

protected BaseAction updateAction

The update action.

Constructor Detail

BaseNavigationBarSupport

public BaseNavigationBarSupport(java.lang.Class actionClass)

Constructor

Parameters:

actionClass - The class used to instantiate new actions.

Method Detail

initialize

public void initialize()

Initializes the support class. The method calls the createDefaultActions method.

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.

Specified by:

getAreaScopeAttributeMap in class BaseActionProviderSupport

Parameters:

filter - Defines the specific area

Returns:

mappings for a pre-defined set of Action Attribues keys

defineActionProperties

protected BaseAction defineActionProperties(BaseAction action,
                                            java.lang.String actionType)

Returns an action whose default dynamic attributes have been defined according to their actionType. The method also sets each attributes meta attributes ( e.g. visible ) accordingly.

Parameters:

action - The action object whose properties are to be defined.

actionType - the key associated with a defined action type.

Returns:

an action with all of its default attributes defined.

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 DATA_CELL_AREA, the Area 'values' should be the name of a column header that matches the header of the column corresponding to the column index 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)