Package docking

Class ShowAllComponentsAction

java.lang.Object

docking.action.DockingAction

docking.ShowAllComponentsAction

All Implemented Interfaces:

DockingActionIf, AutoGeneratedDockingAction, HelpDescriptor, Comparable<docking.ShowComponentAction>

public class ShowAllComponentsAction
extends DockingAction

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Icon	EMPTY_ICON
protected static final String	MENU_WINDOW
protected DockingWindowManager	winMgr

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, List<ComponentPlaceholder> infoList, String subMenuName)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionContext context)	method to actually perform the action logic for this action.
int	compareTo(docking.ShowComponentAction other)
String	getHelpInfo()	Returns a descriptive String about the help object that this descriptor represents.
boolean	isEnabledForContext(ActionContext context)	Method used to determine if this action should be enabled for the given context.

Methods inherited from class docking.action.DockingAction

addPropertyChangeListener, addToWindowWhen, createButton, createMenuItem, dispose, doCreateButton, doCreateMenuItem, enabledWhen, firePropertyChanged, getContextClass, getDefaultKeyBindingData, getDescription, getFullName, getHelpLocation, getHelpObject, getInceptionFromTheFirstClassThatIsNotUsOrABuilder, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getPopupMenuData, getPreferredKeyBindingType, getToolBarData, isAddToPopup, isEnabled, isValidContext, markHelpUnnecessary, popupWhen, removePropertyChangeListener, setAddToAllWindows, setContextClass, setDefaultKeyBindingData, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setToolBarData, setUnvalidatedKeyBindingData, shouldAddToWindow, supportsDefaultContext, toString, 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, getOwnerDescription

Field Details

EMPTY_ICON

protected static final Icon EMPTY_ICON

MENU_WINDOW

protected static final String MENU_WINDOW

See Also:

• Constant Field Values

winMgr

protected DockingWindowManager winMgr

Constructor Details

ShowAllComponentsAction

public ShowAllComponentsAction(DockingWindowManager winMgr,
 List<ComponentPlaceholder> infoList,
 String subMenuName)

Method Details

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

Parameters:

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

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.

compareTo

public int compareTo(docking.ShowComponentAction other)

Specified by:

compareTo in interface Comparable<docking.ShowComponentAction>

getHelpInfo

public String getHelpInfo()

Description copied from interface: HelpDescriptor

Returns a descriptive String about the help object that this descriptor represents.

Specified by:

getHelpInfo in interface HelpDescriptor

Overrides:

getHelpInfo in class DockingAction

Returns:

the help info