org.gvsig.andami.actioninfo

Interface ActionInfoManager

All Known Implementing Classes:

DefaultActionInfoManager

public interface ActionInfoManager

Method Summary

Modifier and Type	Method and Description
ActionInfo	createAction(java.lang.Class<? extends IExtension> extension, java.lang.String name, java.lang.String text, java.lang.String command, java.lang.String icon, java.lang.String accelerator, long position, java.lang.String tip) Create a new action and return.
ActionInfo	createAction(IExtension extension, java.lang.String name, java.lang.String text, java.lang.String command, java.lang.String icon, java.lang.String accelerator, long position, java.lang.String tip)
ActionInfoStatusCache	createActionStatusCache()
void	execute(java.lang.String actionName, java.lang.Object[] parameters)
ActionInfo	getAction(java.lang.String name) Retrieve an action by name
java.util.Iterator<ActionInfo>	getActions() Return an iterator over all registered actions.
ActionInfo	getTranslated(ActionInfo actionInfo)
boolean	isAllDisabled()
void	redirect(java.lang.String sourceName, java.lang.String targetName) Redirect the action source to the target.
ActionInfo	registerAction(ActionInfo action) Utility method that call registerAction with override to false.
ActionInfo	registerAction(ActionInfo action, boolean override) Register the action in the actions of the system.
void	setAllDisabled(boolean enabled)

Method Detail

createAction

ActionInfo createAction(java.lang.Class<? extends IExtension> extension,
                        java.lang.String name,
                        java.lang.String text,
                        java.lang.String command,
                        java.lang.String icon,
                        java.lang.String accelerator,
                        long position,
                        java.lang.String tip)

Create a new action and return.

Parameters:

extension, - class that execute the action, extends IExtension

name, - name of the action

text, - text to use to represent the action.

command, - command used to execute the action

icon, - icon used to represent the action

accelerator, - the key which invokes the action

position, - position of the action when it is represented in the user interface

tip, - tooltip to associate to the action

Returns:

createAction

ActionInfo createAction(IExtension extension,
                        java.lang.String name,
                        java.lang.String text,
                        java.lang.String command,
                        java.lang.String icon,
                        java.lang.String accelerator,
                        long position,
                        java.lang.String tip)

registerAction

ActionInfo registerAction(ActionInfo action,
                          boolean override)

Register the action in the actions of the system. If an action with the same name is in the system and override is false then actions are merged and the merged action is returned and remain in the system. If override is true and the action is already registered the new action replace the previous action.

Parameters:

action -

override -

Returns:

registerAction

ActionInfo registerAction(ActionInfo action)

Utility method that call registerAction with override to false.

Parameters:

action -

Returns:

getAction

ActionInfo getAction(java.lang.String name)

Retrieve an action by name

Parameters:

name -

Returns:

the action associated to this name

getActions

java.util.Iterator<ActionInfo> getActions()

Return an iterator over all registered actions.

Returns:

iterator over al acctions

createActionStatusCache

ActionInfoStatusCache createActionStatusCache()

redirect

void redirect(java.lang.String sourceName,
              java.lang.String targetName)

Redirect the action source to the target.

Parameters:

sourceName - of action

targetName - of action

execute

void execute(java.lang.String actionName,
             java.lang.Object[] parameters)

getTranslated

ActionInfo getTranslated(ActionInfo actionInfo)

isAllDisabled

boolean isAllDisabled()

setAllDisabled

void setAllDisabled(boolean enabled)