Package docking.action

Interface ComponentBasedDockingAction

All Superinterfaces:

DockingActionIf, HelpDescriptor

public interface ComponentBasedDockingAction
extends DockingActionIf

An interface to signal that the implementing action works with an individual Java Component. Standard Docking Actions are either global tool-based actions or local ComponentProvider actions. This interface allows us to have the concept of an action that is effectively local to a specific Java component.

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
boolean	isValidComponentContext(ActionContext context)	Returns true if the given context contains this action's component

Methods inherited from interface docking.action.DockingActionIf

actionPerformed, addPropertyChangeListener, createButton, createMenuItem, dispose, getDefaultKeyBindingData, getDescription, getFullName, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getOwnerDescription, getPopupMenuData, getToolBarData, isAddToPopup, isEnabled, isEnabledForContext, isValidContext, isValidGlobalContext, removePropertyChangeListener, setEnabled, setKeyBindingData, setUnvalidatedKeyBindingData, shouldAddToWindow

Methods inherited from interface docking.help.HelpDescriptor

getHelpInfo, getHelpObject

Method Detail

isValidComponentContext

boolean isValidComponentContext(ActionContext context)

Returns true if the given context contains this action's component

Parameters:

context - the context

Returns:

true if the given context contains this action's component