Package docking.actions

Class ToolActions

java.lang.Object

docking.actions.ToolActions

All Implemented Interfaces:

DockingToolActions, PropertyChangeListener, EventListener

public class ToolActions
extends Object
implements DockingToolActions, PropertyChangeListener

An class to manage actions registered with the tool

Constructor Summary

Constructors

Constructor	Description
ToolActions(Tool tool, ActionToGuiHelper actionToGuiHelper)	Construct an ActionManager

Method Summary

Modifier and Type	Method	Description
void	addGlobalAction(DockingActionIf action)	Adds the given action that is enabled, regardless of the active provider
void	addLocalAction(ComponentProvider provider, DockingActionIf action)	Add an action that works specifically with a component provider.
void	dispose()
Action	getAction(MouseBinding mb)
Action	getAction(KeyStroke ks)
Set<DockingActionIf>	getActions(String owner)	Returns all actions with the given owner
Set<DockingActionIf>	getAllActions()	Returns all actions known to the tool.
Set<DockingActionIf>	getGlobalActions()	Returns all global actions known to the tool
DockingActionIf	getLocalAction(ComponentProvider provider, String actionName)	Gets the provider action by the given name
Set<DockingActionIf>	getLocalActions(ComponentProvider provider)	Gets all the local actions registered for the given ComponentProvider.
void	optionsRebuilt()
void	propertyChange(PropertyChangeEvent evt)
void	registerSharedActionPlaceholder(SharedDockingActionPlaceholder placeholder)	Allows clients to register an action by using a placeholder.
void	removeActions(ComponentProvider provider)	Removes all local actions for the given provider
void	removeActions(String owner)	Removes all global actions for the given owner
void	removeGlobalAction(DockingActionIf action)	Removes the given global action
void	removeLocalAction(ComponentProvider provider, DockingActionIf action)	Remove an action that works specifically with a component provider.
String	validateActionKeyBinding(DockingActionIf action, KeyStroke ks)	Checks whether the given key stroke can be used for the given action for restrictions such as those for System level actions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToolActions

public ToolActions(Tool tool,
 ActionToGuiHelper actionToGuiHelper)

Construct an ActionManager

Parameters:

tool - tool using this ActionManager

actionToGuiHelper - the class that takes actions and maps them to GUI widgets

Method Details

dispose

public void dispose()

addLocalAction

public void addLocalAction(ComponentProvider provider,
 DockingActionIf action)

Add an action that works specifically with a component provider.

Specified by:

addLocalAction in interface DockingToolActions

Parameters:

provider - provider associated with the action

action - local action to the provider

addGlobalAction

public void addGlobalAction(DockingActionIf action)

Description copied from interface: DockingToolActions

Adds the given action that is enabled, regardless of the active provider

Specified by:

addGlobalAction in interface DockingToolActions

Parameters:

action - the action

removeGlobalAction

public void removeGlobalAction(DockingActionIf action)

Description copied from interface: DockingToolActions

Removes the given global action

Specified by:

removeGlobalAction in interface DockingToolActions

Parameters:

action - the action

removeActions

public void removeActions(String owner)

Description copied from interface: DockingToolActions

Removes all global actions for the given owner

Specified by:

removeActions in interface DockingToolActions

Parameters:

owner - the owner

getLocalActions

public Set<DockingActionIf> getLocalActions(ComponentProvider provider)

Description copied from interface: DockingToolActions

Gets all the local actions registered for the given ComponentProvider.

Specified by:

getLocalActions in interface DockingToolActions

Parameters:

provider - the ComponentProvider for which to get its local actions

Returns:

all the local actions registered for the given ComponentProvider

getActions

public Set<DockingActionIf> getActions(String owner)

Description copied from interface: DockingToolActions

Returns all actions with the given owner

Specified by:

getActions in interface DockingToolActions

Parameters:

owner - the owner

Returns:

the actions

getGlobalActions

public Set<DockingActionIf> getGlobalActions()

Description copied from interface: DockingToolActions

Returns all global actions known to the tool

Specified by:

getGlobalActions in interface DockingToolActions

Returns:

the global actions known to the tool

getAllActions

public Set<DockingActionIf> getAllActions()

Description copied from interface: DockingToolActions

Returns all actions known to the tool.

Specified by:

getAllActions in interface DockingToolActions

Returns:

the actions

optionsRebuilt

public void optionsRebuilt()

removeLocalAction

public void removeLocalAction(ComponentProvider provider,
 DockingActionIf action)

Remove an action that works specifically with a component provider.

Specified by:

removeLocalAction in interface DockingToolActions

Parameters:

provider - provider associated with the action

action - local action to the provider

removeActions

public void removeActions(ComponentProvider provider)

Description copied from interface: DockingToolActions

Removes all local actions for the given provider

Specified by:

removeActions in interface DockingToolActions

Parameters:

provider - the provider

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

getLocalAction

public DockingActionIf getLocalAction(ComponentProvider provider,
 String actionName)

Description copied from interface: DockingToolActions

Gets the provider action by the given name

Specified by:

getLocalAction in interface DockingToolActions

Parameters:

provider - the provider

actionName - the action name

Returns:

the action

validateActionKeyBinding

public String validateActionKeyBinding(DockingActionIf action,
 KeyStroke ks)

Checks whether the given key stroke can be used for the given action for restrictions such as those for System level actions.

Parameters:

action - the action; may be null

ks - the key stroke

Returns:

A null value if valid; a non-null error message if invalid

getAction

public Action getAction(KeyStroke ks)

getAction

public Action getAction(MouseBinding mb)

registerSharedActionPlaceholder

public void registerSharedActionPlaceholder(SharedDockingActionPlaceholder placeholder)

Allows clients to register an action by using a placeholder. This is useful when an API wishes to have a central object (like a plugin) register actions for transient providers, that may not be loaded until needed.

This method may be called multiple times with the same conceptual placeholder--the placeholder will only be added once.

Specified by:

registerSharedActionPlaceholder in interface DockingToolActions

Parameters:

placeholder - the placeholder containing information related to the action it represents