Package docking
Class ShowAllComponentsAction
- java.lang.Object
-
- docking.action.DockingAction
-
- docking.ShowAllComponentsAction
-
- All Implemented Interfaces:
DockingActionIf,AutoGeneratedDockingAction,HelpDescriptor,java.lang.Comparable<docking.ShowComponentAction>
public class ShowAllComponentsAction extends DockingAction
-
-
Field Summary
Fields Modifier and Type Field Description protected static javax.swing.ImageIconEMPTY_ICONprotected static java.lang.StringMENU_WINDOWprotected DockingWindowManagerwinMgr-
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
-
-
Constructor Summary
Constructors Constructor Description ShowAllComponentsAction(DockingWindowManager winMgr, java.util.List<ComponentPlaceholder> infoList, java.lang.String subMenuName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactionPerformed(ActionContext context)method to actually perform the action logic for this action.intcompareTo(docking.ShowComponentAction other)java.lang.StringgetHelpInfo()Returns a descriptive String about the help object that this descriptor represents.booleanisEnabledForContext(ActionContext context)Method used to determine if this action should be enabled for the given context.-
Methods inherited from class docking.action.DockingAction
addPropertyChangeListener, createButton, createMenuItem, dispose, doCreateButton, doCreateMenuItem, firePropertyChanged, getDefaultKeyBindingData, getDescription, getFullName, getHelpObject, getInceptionFromTheFirstClassThatIsNotUs, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getPopupMenuData, getPreferredKeyBindingType, getToolBarData, isAddToPopup, isEnabled, isValidContext, isValidGlobalContext, markHelpUnnecessary, removePropertyChangeListener, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setToolBarData, setUnvalidatedKeyBindingData, shouldAddToWindow, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface docking.action.DockingActionIf
getOwnerDescription
-
-
-
-
Field Detail
-
EMPTY_ICON
protected static final javax.swing.ImageIcon EMPTY_ICON
-
MENU_WINDOW
protected static final java.lang.String MENU_WINDOW
- See Also:
- Constant Field Values
-
winMgr
protected DockingWindowManager winMgr
-
-
Constructor Detail
-
ShowAllComponentsAction
public ShowAllComponentsAction(DockingWindowManager winMgr, java.util.List<ComponentPlaceholder> infoList, java.lang.String subMenuName)
-
-
Method Detail
-
actionPerformed
public void actionPerformed(ActionContext context)
Description copied from interface:DockingActionIfmethod to actually perform the action logic for this action.- Specified by:
actionPerformedin interfaceDockingActionIf- Parameters:
context- theActionContextobject that provides information about where and how this action was invoked.
-
isEnabledForContext
public boolean isEnabledForContext(ActionContext context)
Description copied from interface:DockingActionIfMethod 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:
- when the user invokes the action via its keyBinding,
- the user changes focus from one component provider to another,
- the user moves a component to another position in the window or into another window,
- a component provider reports a change in it's context,
- any plugin or software component reports a general change in context (calls the tool.contextChanged(ComponentProvider) with a null parameter).
- Specified by:
isEnabledForContextin interfaceDockingActionIf- Overrides:
isEnabledForContextin classDockingAction- Parameters:
context- the currentActionContextfor the window.- Returns:
- true if the action should be enabled for the context or false otherwise.
-
compareTo
public int compareTo(docking.ShowComponentAction other)
- Specified by:
compareToin interfacejava.lang.Comparable<docking.ShowComponentAction>
-
getHelpInfo
public java.lang.String getHelpInfo()
Description copied from interface:HelpDescriptorReturns a descriptive String about the help object that this descriptor represents.- Specified by:
getHelpInfoin interfaceHelpDescriptor- Overrides:
getHelpInfoin classDockingAction
-
-