Package docking.action
Class ToggleDockingAction
- java.lang.Object
-
- docking.action.DockingAction
-
- docking.action.ToggleDockingAction
-
- All Implemented Interfaces:
DockingActionIf
,ToggleDockingActionIf
,HelpDescriptor
- Direct Known Subclasses:
AbstractSelectionNavigationAction
,ProjectDataContextToggleAction
public abstract class ToggleDockingAction extends DockingAction implements ToggleDockingActionIf
-
-
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
-
Fields inherited from interface docking.action.ToggleDockingActionIf
SELECTED_STATE_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description ToggleDockingAction(java.lang.String name, java.lang.String owner)
ToggleDockingAction(java.lang.String name, java.lang.String owner, boolean supportsKeyBindings)
ToggleDockingAction(java.lang.String name, java.lang.String owner, KeyBindingType keyBindingType)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionPerformed(ActionContext context)
method to actually perform the action logic for this action.protected javax.swing.JButton
doCreateButton()
protected javax.swing.JMenuItem
doCreateMenuItem()
boolean
isSelected()
Returns true if the toggle state for this action is current selected.void
setSelected(boolean newValue)
Sets the toggle state for this action.-
Methods inherited from class docking.action.DockingAction
addPropertyChangeListener, addToWindowWhen, createButton, createMenuItem, dispose, enabledWhen, firePropertyChanged, getDefaultKeyBindingData, getDescription, getFullName, getHelpInfo, getHelpObject, getInceptionFromTheFirstClassThatIsNotUsOrABuilder, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getPopupMenuData, getPreferredKeyBindingType, getToolBarData, isAddToPopup, isEnabled, isEnabledForContext, isValidContext, markHelpUnnecessary, popupWhen, removePropertyChangeListener, setAddToAllWindows, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setSupportsDefaultToolContext, setToolBarData, setUnvalidatedKeyBindingData, shouldAddToWindow, supportsDefaultToolContext, 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
addPropertyChangeListener, createButton, createMenuItem, dispose, getDefaultKeyBindingData, getDescription, getFullName, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getOwnerDescription, getPopupMenuData, getToolBarData, isAddToPopup, isEnabled, isEnabledForContext, isValidContext, removePropertyChangeListener, setEnabled, setKeyBindingData, setSupportsDefaultToolContext, setUnvalidatedKeyBindingData, shouldAddToWindow, supportsDefaultToolContext
-
Methods inherited from interface docking.help.HelpDescriptor
getHelpInfo, getHelpObject
-
-
-
-
Constructor Detail
-
ToggleDockingAction
public ToggleDockingAction(java.lang.String name, java.lang.String owner)
-
ToggleDockingAction
public ToggleDockingAction(java.lang.String name, java.lang.String owner, KeyBindingType keyBindingType)
-
ToggleDockingAction
public ToggleDockingAction(java.lang.String name, java.lang.String owner, boolean supportsKeyBindings)
-
-
Method Detail
-
isSelected
public boolean isSelected()
Description copied from interface:ToggleDockingActionIf
Returns true if the toggle state for this action is current selected.- Specified by:
isSelected
in interfaceToggleDockingActionIf
- Returns:
- true if the toggle state for this action is current selected.
-
setSelected
public void setSelected(boolean newValue)
Description copied from interface:ToggleDockingActionIf
Sets the toggle state for this action.- Specified by:
setSelected
in interfaceToggleDockingActionIf
- Parameters:
newValue
- the new toggle state.
-
doCreateButton
protected javax.swing.JButton doCreateButton()
- Overrides:
doCreateButton
in classDockingAction
-
doCreateMenuItem
protected javax.swing.JMenuItem doCreateMenuItem()
- Overrides:
doCreateMenuItem
in classDockingAction
-
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 interfaceDockingActionIf
- Specified by:
actionPerformed
in classDockingAction
- Parameters:
context
- theActionContext
object that provides information about where and how this action was invoked.
-
-