bibliothek.gui.dock.action.actions
Interface SharingSelectableDockAction

All Superinterfaces:
DockAction, DropDownItemAction, SelectableDockAction, SharingDropDownItemAction, SharingStandardDockAction, StandardDockAction, StandardDropDownItemAction
All Known Implementing Classes:
SimpleSelectableAction, SimpleSelectableAction.Check, SimpleSelectableAction.Radio, StationChildrenActionSource.FocusAction

@FrameworkOnly
public interface SharingSelectableDockAction
extends SharingDropDownItemAction, SelectableDockAction

A SelectableDockAction whose properties are shared among all Dockables, clients can modify the properties.

Author:
Benjamin Sigg

Method Summary
 javax.swing.Icon getDisabledSelectedIcon()
          Gets the icon that is shown, when this action is selected but not enabled.
 javax.swing.Icon getSelectedIcon()
          Gets the icon that is shown when this action is selected.
 boolean isSelected()
          Gets the selected-state of this action.
 void setDisabledSelectedIcon(javax.swing.Icon disabledSelectedIcon)
          Sets the icon that will be shown when this action is selected but not enabled.
 void setSelected(boolean selected)
          Sets the state of this action.
 void setSelectedIcon(javax.swing.Icon selectedIcon)
          Sets the icon that will be shown, when this action is selected.
 
Methods inherited from interface bibliothek.gui.dock.action.actions.SharingDropDownItemAction
isDropDownSelectable, isDropDownTriggerableNotSelected, isDropDownTriggerableSelected, setDropDownSelectable, setDropDownTriggerableNotSelected, setDropDownTriggerableSelected
 
Methods inherited from interface bibliothek.gui.dock.action.actions.SharingStandardDockAction
getAccelerator, getDisabledIcon, getDockableRepresentation, getIcon, getText, getTooltip, getTooltipText, isEnabled, setAccelerator, setDisabledIcon, setDockableRepresentation, setEnabled, setIcon, setText, setTooltip
 
Methods inherited from interface bibliothek.gui.dock.action.SelectableDockAction
addSelectableListener, isSelected, removeSelectableListener, setSelected
 

Method Detail

isSelected

boolean isSelected()
Gets the selected-state of this action.

Returns:
The current state
See Also:
setSelected(boolean)

setSelected

void setSelected(boolean selected)
Sets the state of this action. The action will notify all listeners about the new state.

Parameters:
selected - the new state

getSelectedIcon

javax.swing.Icon getSelectedIcon()
Gets the icon that is shown when this action is selected.

Returns:
The selected-icon, may be null
See Also:
setSelectedIcon(Icon), isSelected()

setSelectedIcon

void setSelectedIcon(javax.swing.Icon selectedIcon)
Sets the icon that will be shown, when this action is selected.

Parameters:
selectedIcon - The icon, can be null
See Also:
setSelected(boolean)

getDisabledSelectedIcon

javax.swing.Icon getDisabledSelectedIcon()
Gets the icon that is shown, when this action is selected but not enabled.

Returns:
The icon, may be null
See Also:
setDisabledSelectedIcon(Icon), SharingStandardDockAction.isEnabled(), isSelected()

setDisabledSelectedIcon

void setDisabledSelectedIcon(javax.swing.Icon disabledSelectedIcon)
Sets the icon that will be shown when this action is selected but not enabled.

Parameters:
disabledSelectedIcon - The icon, null is allowed
See Also:
setSelected(boolean), SharingStandardDockAction.setEnabled(boolean)