bibliothek.gui.dock.action.actions
Interface SharingSelectableDockAction

All Superinterfaces:

DockAction, DropDownItemAction, SelectableDockAction, SharingDropDownItemAction, SharingStandardDockAction, StandardDockAction, StandardDropDownItemAction

All Known Subinterfaces:

CommonSelectableAction

All Known Implementing Classes:

CommonSimpleCheckAction, CommonSimpleRadioAction, 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

Icon	getSelectedIcon(ActionContentModifier modifier) Gets the icon that is shown when this action is selected.
boolean	isSelected() Gets the selected-state of this action.
void	setSelected(boolean selected) Sets the state of this action.
void	setSelectedIcon(ActionContentModifier modifier, 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, getIcon, getText, getTooltip, getTooltipText, isEnabled, setAccelerator, setDisabledIcon, setDockableRepresentation, setEnabled, setIcon, 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

Icon getSelectedIcon(ActionContentModifier modifier)

Gets the icon that is shown when this action is selected.

Parameters:

modifier - tells in which context the icon is used

Returns:

The selected-icon, may be null

See Also:

setSelectedIcon(ActionContentModifier, Icon), isSelected()

setSelectedIcon

void setSelectedIcon(ActionContentModifier modifier,
                     Icon selectedIcon)

Sets the icon that will be shown, when this action is selected.

Parameters:

modifier - tells in which context icon will be used

selectedIcon - The icon, can be null

See Also:

setSelected(boolean)