net.sf.doolin.gui.action
Interface GUIAction

All Known Implementing Classes:

AbstractDialogAction, AbstractGUIAction, AbstractSimpleGUIAction, AbstractTextAction, AbstractTypedGUIAction, AbstractWizardAction, ActionAbout, BusMonitoringTestAction, CloseWindowAction, DelegateDialogAction, DelegateGUIAction, DialogAction, DialogCancelAction, DialogOKAction, ExitAction, GUIEditAction, GUIRedoAction, GUITaskAction, GUIUndoAction, LFAction, MethodGUIAction, NewItemAction, NOPGUIAction, OpenItemAction, OpenViewAction, PromptGUIAction, ServiceGUIAction, TaskDialogAction, WizardCancelAction, WizardFinishAction, WizardNextAction, WizardPreviousAction

public interface GUIAction

Action definition.

Author:

Damien Coraboeuf

Method Summary

boolean	execute(ActionContext actionContext) Executes the action.
DisplayStateHandler	getDisplayStateHandler() Display state handler for this action
Icon	getIcon(String iconID, IconSize iconSize) Gets the icon according to its ID
GUIExpression	getIconIDExpression(ActionContext actionContext) Icon for the action
String	getId() ID for the action
GUIExpression	getShortcutExpression(ActionContext actionContext) Shortcut for the action
GUIExpression	getTextExpression(ActionContext actionContext) Text for the action
GUIExpression	getTipExpression(ActionContext actionContext) Tip for the action

Method Detail

execute

boolean execute(ActionContext actionContext)

Executes the action.

Parameters:

actionContext - Context for the action

Returns:

true if the action has been executed without error

getDisplayStateHandler

DisplayStateHandler getDisplayStateHandler()

Display state handler for this action

Returns:

Display state handler

getIcon

Icon getIcon(String iconID,
             IconSize iconSize)

Gets the icon according to its ID

Parameters:

iconID - Icon ID

iconSize - Icon size

Returns:

The icon for this action or null if none is available.

getIconIDExpression

GUIExpression getIconIDExpression(ActionContext actionContext)

Icon for the action

Parameters:

actionContext - Context for the action

Returns:

Icon model

getId

String getId()

ID for the action

Returns:

ID

getShortcutExpression

GUIExpression getShortcutExpression(ActionContext actionContext)

Shortcut for the action

Parameters:

actionContext - Context for the action

Returns:

Shortcut model

getTextExpression

GUIExpression getTextExpression(ActionContext actionContext)

Text for the action

Parameters:

actionContext - Context for the action

Returns:

Text model

getTipExpression

GUIExpression getTipExpression(ActionContext actionContext)

Tip for the action

Parameters:

actionContext - Context for the action

Returns:

Tip model