ToggleDockingActionIf

All Superinterfaces:: DockingActionIf, HelpDescriptor

All Known Implementing Classes:: AbstractSelectionNavigationAction, DockingActionProxy, ProjectDataContextToggleAction, ProjectDataReadOnlyAction, SelectionNavigationAction, ToggleDockingAction

public interface ToggleDockingActionIf extends DockingActionIf

Interface for actions that have a toggle state

Field Summary

Fields

Modifier and Type

Field

Description

static final String

SELECTED_STATE_PROPERTY

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

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 interface docking.action.DockingActionIf
actionPerformed, addPropertyChangeListener, createButton, createMenuComponent, createMenuItem, dispose, getContextClass, getDefaultKeyBindingData, getDescription, getFullName, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getOwnerDescription, getPopupMenuData, getToolBarData, isAddToPopup, isEnabled, isEnabledForContext, isValidContext, removePropertyChangeListener, setContextClass, setEnabled, setKeyBindingData, setUnvalidatedKeyBindingData, shouldAddToWindow, supportsDefaultContext

Methods inherited from interface help.HelpDescriptor
getHelpInfo, getHelpObject

Field Details
- SELECTED_STATE_PROPERTY
  
  static final String SELECTED_STATE_PROPERTY
  See Also:
  
  Constant Field Values
Method Details
- isSelected
  
  boolean isSelected()
  
  Returns true if the toggle state for this action is current selected.
  
  Returns:
  
  true if the toggle state for this action is current selected.
- setSelected
  
  void setSelected(boolean newValue)
  
  Sets the toggle state for this action.
  
  Parameters:
  
  newValue - the new toggle state.