|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.action.actions.AbstractStandardDockAction bibliothek.gui.dock.action.actions.SimpleDockAction bibliothek.gui.dock.action.actions.SimpleDropDownItemAction bibliothek.gui.dock.action.actions.SimpleSelectableAction
public abstract class SimpleSelectableAction
A DockAction
that has a state selected
. That state
has always the same value for every Dockable
using this action.
Nested Class Summary | |
---|---|
static class |
SimpleSelectableAction.Check
A SimpleSelectableAction that is visualized as
a ActionType.CHECK . |
static class |
SimpleSelectableAction.Radio
A SimpleSelectableAction that is visualized as
a ActionType.RADIO . |
Constructor Summary | |
---|---|
SimpleSelectableAction(ActionType<SelectableDockAction> type,
boolean monitorDisabling)
Creates a new action. |
Method Summary | ||
---|---|---|
void |
addSelectableListener(SelectableDockActionListener listener)
Adds a listener to this action. |
|
|
createView(ViewTarget<V> target,
ActionViewConverter converter,
Dockable dockable)
Creates a view for this action, for the platform target and
with help of converter . |
|
protected void |
fireSelectedChanged()
Fires an event to all observers of type SelectableDockActionListener . |
|
protected Icon |
firstNonNull(Icon... icons)
Gets the first element of icons that is not null . |
|
Icon |
getDisabledSelectedIcon()
Gets the icon which is shown if this action is selected but disabled |
|
Icon |
getIcon(Dockable dockable,
ActionContentModifier modifier)
Gets the Icon of this DockAction, when this DockAction is shown together with dockable . |
|
ActionContentModifier[] |
getIconContexts(Dockable dockable)
Gets all the ActionContentModifier s for which StandardDockAction.getIcon(Dockable, ActionContentModifier) would
return a value other than null . |
|
Icon |
getSelectedIcon()
Gets the icon which is shown if this action is selected |
|
Icon |
getSelectedIcon(ActionContentModifier modifier)
Gets the icon that is shown when this action is selected. |
|
boolean |
isSelected()
Gets the selected-state of this action. |
|
boolean |
isSelected(Dockable dockable)
Tells whether this DockAction is selected or not (in respect to the given dockable ). |
|
void |
removeSelectableListener(SelectableDockActionListener listener)
Removes a listener from this action. |
|
void |
setDisabledSelectedIcon(Icon icon)
Sets the icon which is shown if this action is selected but disabled |
|
void |
setSelected(boolean selected)
Sets the state of this action. |
|
void |
setSelected(Dockable dockable,
boolean selected)
Sets the selected state for dockable . |
|
void |
setSelectedIcon(ActionContentModifier modifier,
Icon selectedIcon)
Sets the icon that will be shown, when this action is selected. |
|
void |
setSelectedIcon(Icon icon)
Sets the icon which is shown if this action is selected |
Methods inherited from class bibliothek.gui.dock.action.actions.SimpleDropDownItemAction |
---|
isDropDownSelectable, isDropDownSelectable, isDropDownTriggerable, isDropDownTriggerableNotSelected, isDropDownTriggerableSelected, setDropDownSelectable, setDropDownTriggerableNotSelected, setDropDownTriggerableSelected |
Methods inherited from class bibliothek.gui.dock.action.actions.SimpleDockAction |
---|
bound, getAccelerator, getDisabledIcon, getDockableRepresentation, getDockableRepresentation, getIcon, getIcon, getText, getText, getTooltip, getTooltipText, getTooltipText, isEnabled, isEnabled, setAccelerator, setDisabledIcon, setDockableRepresentation, setEnabled, setIcon, setIcon, setText, setTooltip, trigger, unbound |
Methods inherited from class bibliothek.gui.dock.action.actions.AbstractStandardDockAction |
---|
addDockActionListener, bind, fireActionEnabledChanged, fireActionIconChanged, fireActionRepresentativeChanged, fireActionTextChanged, fireActionTooltipTextChanged, getBoundDockables, isBound, removeDockActionListener, unbind |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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.dropdown.DropDownItemAction |
---|
isDropDownSelectable, isDropDownTriggerable |
Constructor Detail |
---|
public SimpleSelectableAction(ActionType<SelectableDockAction> type, boolean monitorDisabling)
type
- how this action is to be visualizedmonitorDisabling
- whether the current DisablingStrategy
should be monitoredMethod Detail |
---|
public <V> V createView(ViewTarget<V> target, ActionViewConverter converter, Dockable dockable)
DockAction
target
and
with help of converter
. Clients might use their own
code to create a new view, but the preferred way is to call
ActionViewConverter.createView(ActionType, DockAction, ViewTarget, Dockable)
with an ActionType
that fits to this DockAction.
createView
in interface DockAction
V
- the type of view requestedtarget
- The platform on which the view will be usedconverter
- A set of methods that can be used to create a viewdockable
- The Dockable for which the view will be shown. Note that
this action may not yet be bound
to this action.
public void addSelectableListener(SelectableDockActionListener listener)
SelectableDockAction
Dockable
changes.
addSelectableListener
in interface SelectableDockAction
listener
- the new listenerpublic void removeSelectableListener(SelectableDockActionListener listener)
SelectableDockAction
removeSelectableListener
in interface SelectableDockAction
listener
- the listener to removeprotected void fireSelectedChanged()
SelectableDockActionListener
.
public boolean isSelected(Dockable dockable)
SelectableDockAction
dockable
).
isSelected
in interface SelectableDockAction
dockable
- The Dockable
for which this action may be selected
or not selected
true
if this DockAction is selcted, false
otherwisepublic void setSelected(Dockable dockable, boolean selected)
SelectableDockAction
dockable
.
setSelected
in interface SelectableDockAction
dockable
- the affected dockableselected
- the new statepublic boolean isSelected()
SharingSelectableDockAction
isSelected
in interface SharingSelectableDockAction
SharingSelectableDockAction.setSelected(boolean)
public void setSelected(boolean selected)
SharingSelectableDockAction
setSelected
in interface SharingSelectableDockAction
selected
- the new statepublic Icon getIcon(Dockable dockable, ActionContentModifier modifier)
StandardDockAction
dockable
. This method must ignore the
backup property
of modifier
.
getIcon
in interface StandardDockAction
getIcon
in class SimpleDockAction
dockable
- The Dockable
for which the action-icon
should be chosen.modifier
- how the icon will be used
dockable
, or null
.protected Icon firstNonNull(Icon... icons)
icons
that is not null
.
icons
- a list of icons
public ActionContentModifier[] getIconContexts(Dockable dockable)
StandardDockAction
ActionContentModifier
s for which StandardDockAction.getIcon(Dockable, ActionContentModifier)
would
return a value other than null
.
getIconContexts
in interface StandardDockAction
getIconContexts
in class SimpleDockAction
dockable
- the Dockable
for which the action-icons may be chosen.
public void setSelectedIcon(Icon icon)
icon
- the icon to show, or null
public Icon getSelectedIcon()
null
public void setDisabledSelectedIcon(Icon icon)
icon
- the icon to show, or null
public Icon getDisabledSelectedIcon()
null
public Icon getSelectedIcon(ActionContentModifier modifier)
SharingSelectableDockAction
getSelectedIcon
in interface SharingSelectableDockAction
modifier
- tells in which context the icon is used
null
SharingSelectableDockAction.setSelectedIcon(ActionContentModifier, Icon)
,
SharingSelectableDockAction.isSelected()
public void setSelectedIcon(ActionContentModifier modifier, Icon selectedIcon)
SharingSelectableDockAction
setSelectedIcon
in interface SharingSelectableDockAction
modifier
- tells in which context icon
will be usedselectedIcon
- The icon, can be null
SharingSelectableDockAction.setSelected(boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |