net.sf.doolin.gui.action.path.item
Interface ActionPath

All Known Implementing Classes:

AbstractActionPath, BusMonitoringRefreshActionPath, GUIActionPath, GUIStatusBar, PlaceholderActionPath, ReplacementActionPath, SeparatorActionPath, SubActionPath

public interface ActionPath

Defines a way to install an action in a MenuBuilder for a given ActionContext.

Author:

Damien Coraboeuf

Method Summary

Stack<String>	getPathStack() Returns a stack of sub-paths where to install the action.
String	getSource() Defines an identifier for this action path when it is used as a replacement for another action path.
String	getTarget() Defines an identifier when this action path is defined as a placeholder for other action path(s).
void	install(MenuBuilder menuBuilder, ActionFactory actionFactory, ActionContext actionContext) Installs this action path in a menu builder for a given action context.

Method Detail

getPathStack

Stack<String> getPathStack()

Returns a stack of sub-paths where to install the action. This stack can be used directly by the called of its method. An empty stack means that the action is installed at the root of the menu builder. Any stack element forces the menu builder to create sub menu builders.

Returns:

A stack of path.

See Also:

MenuBuilder

getSource

String getSource()

Defines an identifier for this action path when it is used as a replacement for another action path.

Returns:

Identifier

getTarget

String getTarget()

Defines an identifier when this action path is defined as a placeholder for other action path(s).

Returns:

Identifier or null

install

void install(MenuBuilder menuBuilder,
             ActionFactory actionFactory,
             ActionContext actionContext)

Installs this action path in a menu builder for a given action context.

Parameters:

menuBuilder - Menu builder

actionFactory - Action factory to use

actionContext - Action context to use