Package docking.actions

Class SharedStubKeyBindingAction

java.lang.Object

docking.action.DockingAction

docking.actions.SharedStubKeyBindingAction

All Implemented Interfaces:

DockingActionIf, OptionsChangeListener, HelpDescriptor

public class SharedStubKeyBindingAction
extends DockingAction
implements OptionsChangeListener

A stub action that allows key bindings to be edited through the key bindings options. This allows plugins to create actions that share keybindings without having to manage those keybindings themselves.

Some ways this class is used:

1. As a central action to manage key bindings for multiple actions from different clients (plugins) that are conceptually the same. When the plugins are loaded these actions get registered and are wired to listen to key binding changes to this stub.
2. As a placeholder action to manage key bindings for actions that have not yet been registered and may not get registered during the lifetime of a single tool session. This can happen when a plugin has transient component providers that only get shown upon a user request. This stub allows the key binding for those actions to be managed, even if they do not get registered when the tool is shown.

Clients should not be using this class directly.

Field Summary

Fields inherited from interface docking.action.DockingActionIf

DESCRIPTION_PROPERTY, ENABLEMENT_PROPERTY, GLOBALCONTEXT_PROPERTY, KEYBINDING_DATA_PROPERTY, MENUBAR_DATA_PROPERTY, POPUP_MENU_DATA_PROPERTY, TOOLBAR_DATA_PROPERTY

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionContext context)	method to actually perform the action logic for this action.
void	dispose()	Cleans up any resources used by the action.
String	getDescription()	Returns a short description of this action.
String	getOwnerDescription()	Returns a description of this actions owner.
boolean	isAddToPopup(ActionContext context)	method is used to determine if this action should be displayed on the current popup.
boolean	isEnabledForContext(ActionContext context)	Method used to determine if this action should be enabled for the given context.
boolean	isValidContext(ActionContext context)	Method that actions implement to indicate if this action is valid (knows how to work with, is appropriate for) for the given context.
void	optionsChanged(ToolOptions options, String optionName, Object oldValue, Object newValue)	Notification that an option changed.
void	setUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData)	Users creating actions should not call this method, but should instead call DockingActionIf.setKeyBindingData(KeyBindingData).
String	toString()

Methods inherited from class docking.action.DockingAction

addPropertyChangeListener, addToWindowWhen, createButton, createMenuItem, doCreateButton, doCreateMenuItem, enabledWhen, firePropertyChanged, getContextClass, getDefaultKeyBindingData, getFullName, getHelpInfo, getHelpLocation, getHelpObject, getInceptionFromTheFirstClassThatIsNotUsOrABuilder, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getPopupMenuData, getPreferredKeyBindingType, getToolBarData, isEnabled, markHelpUnnecessary, popupWhen, removePropertyChangeListener, setAddToAllWindows, setContextClass, setDefaultKeyBindingData, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setToolBarData, shouldAddToWindow, supportsDefaultContext, validContextWhen

Methods inherited from class java.lang.Object

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

Methods inherited from interface docking.action.DockingActionIf

createMenuComponent

Method Details

getOwnerDescription

public String getOwnerDescription()

Description copied from interface: DockingActionIf

Returns a description of this actions owner. For most actions this will return the same value as DockingActionIf.getOwner().

Specified by:

getOwnerDescription in interface DockingActionIf

Returns:

the description

getDescription

public String getDescription()

Description copied from interface: DockingActionIf

Returns a short description of this action. Generally used for a tooltip

Specified by:

getDescription in interface DockingActionIf

Overrides:

getDescription in class DockingAction

Returns:

the description

setUnvalidatedKeyBindingData

public void setUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData)

Description copied from interface: DockingActionIf

Users creating actions should not call this method, but should instead call DockingActionIf.setKeyBindingData(KeyBindingData).

Call this method when you wish to bypass the validation of DockingActionIf.setKeyBindingData(KeyBindingData) so that keybindings are set exactly as they are given (such as when set by the user and not by the programmer).

Specified by:

setUnvalidatedKeyBindingData in interface DockingActionIf

Overrides:

setUnvalidatedKeyBindingData in class DockingAction

Parameters:

newKeyBindingData - the KeyBindingData to be used to assign this action to a keybinding

optionsChanged

public void optionsChanged(ToolOptions options,
 String optionName,
 Object oldValue,
 Object newValue)

Description copied from interface: OptionsChangeListener

Notification that an option changed.

Note: to reject an options change, you can throw a OptionsVetoException.

Specified by:

optionsChanged in interface OptionsChangeListener

Parameters:

options - options object containing the property that changed

optionName - name of option that changed

oldValue - old value of the option

newValue - new value of the option

actionPerformed

public void actionPerformed(ActionContext context)

Description copied from interface: DockingActionIf

method to actually perform the action logic for this action.

Specified by:

actionPerformed in interface DockingActionIf

Specified by:

actionPerformed in class DockingAction

Parameters:

context - the ActionContext object that provides information about where and how this action was invoked.

isAddToPopup

public boolean isAddToPopup(ActionContext context)

Description copied from interface: DockingActionIf

method is used to determine if this action should be displayed on the current popup. This method will only be called if the action has popup PopupMenuData set.

Generally, actions don't need to override this method as the default implementation will defer to the DockingActionIf.isEnabledForContext(ActionContext), which will have the effect of adding the action to the popup only if it is enabled for a given context. By overriding this method, you can change this behavior so that the action will be added to the popup, even if it is disabled for the context, by having this method return true even if the DockingActionIf.isEnabledForContext(ActionContext) method will return false, resulting in the action appearing in the popup menu, but begin disabled.

Specified by:

isAddToPopup in interface DockingActionIf

Overrides:

isAddToPopup in class DockingAction

Parameters:

context - the ActionContext from the active provider.

Returns:

true if this action is appropriate for the given context.

isValidContext

public boolean isValidContext(ActionContext context)

Description copied from interface: DockingActionIf

Method that actions implement to indicate if this action is valid (knows how to work with, is appropriate for) for the given context. This method is used to determine if the action should be enabled based on the either the local context or the global context. The action is first asked if it is valid for the local context and if not, then it is asked if it is valid for the global context. If a context is valid, then it will then be asked if it is enabled for that context.

Specified by:

isValidContext in interface DockingActionIf

Overrides:

isValidContext in class DockingAction

Parameters:

context - the ActionContext from the active provider.

Returns:

true if this action is appropriate for the given context.

isEnabledForContext

public boolean isEnabledForContext(ActionContext context)

Description copied from interface: DockingActionIf

Method used to determine if this action should be enabled for the given context.

This is the method implementors override to control when the action may be used.

This method will be called by the DockingWindowManager for actions on the global menuBar and toolBar and for actions that have a keyBinding.

This method will be called whenever one of the following events occur:

1. when the user invokes the action via its keyBinding,
2. the user changes focus from one component provider to another,
3. the user moves a component to another position in the window or into another window,
4. a component provider reports a change in it's context,
5. any plugin or software component reports a general change in context (calls the tool.contextChanged(ComponentProvider) with a null parameter).

The default implementation will simply return this action's enablement state.

Specified by:

isEnabledForContext in interface DockingActionIf

Overrides:

isEnabledForContext in class DockingAction

Parameters:

context - the current ActionContext for the window.

Returns:

true if the action should be enabled for the context or false otherwise.

dispose

public void dispose()

Description copied from class: DockingAction

Cleans up any resources used by the action.

Specified by:

dispose in interface DockingActionIf

Overrides:

dispose in class DockingAction

toString

public String toString()

Overrides:

toString in class DockingAction