bibliothek.gui.dock.action

Class StationChildrenActionSource.FocusAction

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

bibliothek.gui.dock.action.actions.SimpleSelectableAction.Check

bibliothek.gui.dock.action.StationChildrenActionSource.FocusAction

All Implemented Interfaces:

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

Enclosing class:

StationChildrenActionSource

protected class StationChildrenActionSource.FocusAction
extends SimpleSelectableAction.Check
implements DockableListener

An action that can transfer the focus

Author:

Benjamin Sigg

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.action.actions.SimpleSelectableAction

SimpleSelectableAction.Check, SimpleSelectableAction.Radio

Constructor Summary

Constructors

Constructor and Description
FocusAction(Dockable dockable) Creates a new action

Method Summary

Modifier and Type	Method and Description
void	bind(Dockable dockable) Informs this DockAction that icons, text, and other stuff like that, will be requested from this DockAction.
protected void	bound(Dockable dockable) Invoked by this AbstractStandardDockAction when a Dockable was bound to this action the first time.
void	titleBound(Dockable dockable, DockTitle title) Will be invoked when a DockTitle was bound to a Dockable.
void	titleExchanged(Dockable dockable, DockTitle title) Invoked when the properties of a Dockable have a so dramatically changed, that the DockTitle title is no longer considered a good title and should be replaced.
void	titleIconChanged(Dockable dockable, Icon oldIcon, Icon newIcon) Invoked when the title-icon of a Dockable has changed
void	titleTextChanged(Dockable dockable, String oldTitle, String newTitle) Invoked when the title of a Dockable has changed.
void	titleToolTipChanged(Dockable dockable, String oldToolTip, String newToolTip) Called when the tooltip of a Dockable changed.
void	titleUnbound(Dockable dockable, DockTitle title) Will be invoked when a DockTitle was unbound from a Dockable.
void	unbind(Dockable dockable) Invoked only if the dockable was bound to this DockAction, and if the dockable will no longer be used for any method calls (except bind) on this DockAction.
protected void	unbound(Dockable dockable) Called by this AbstractStandardDockAction when the Dockable dockable will not be used in any means by this action.

Methods inherited from class bibliothek.gui.dock.action.actions.SimpleSelectableAction.Check

trigger

Methods inherited from class bibliothek.gui.dock.action.actions.SimpleSelectableAction

addSelectableListener, createView, fireSelectedChanged, firstNonNull, getDisabledSelectedIcon, getIcon, getIconContexts, getSelectedIcon, getSelectedIcon, isSelected, isSelected, removeSelectableListener, setDisabledSelectedIcon, setSelected, setSelected, setSelectedIcon, setSelectedIcon

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

getAccelerator, getDisabledIcon, getDockableRepresentation, getDockableRepresentation, getIcon, getIcon, getText, getText, getTooltip, getTooltipText, getTooltipText, isAcceleratorGlobal, isEnabled, isEnabled, setAccelerator, setAcceleratorIsGlobal, setDisabledIcon, setDockableRepresentation, setEnabled, setIcon, setIcon, setText, setTooltip, trigger

Methods inherited from class bibliothek.gui.dock.action.actions.AbstractStandardDockAction

addDockActionListener, fireActionEnabledChanged, fireActionIconChanged, fireActionRepresentativeChanged, fireActionTextChanged, fireActionTooltipTextChanged, getBoundDockables, isBound, removeDockActionListener

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, isAcceleratorGlobal, isEnabled, setAccelerator, setAcceleratorIsGlobal, setDisabledIcon, setDockableRepresentation, setEnabled, setIcon, setIcon, setText, setTooltip

Methods inherited from interface bibliothek.gui.dock.action.dropdown.DropDownItemAction

isDropDownSelectable, isDropDownTriggerable

Constructor Detail

FocusAction

public FocusAction(Dockable dockable)

Creates a new action

Parameters:

dockable - the element to observe

Method Detail

bind

public void bind(Dockable dockable)

Description copied from interface: DockAction

Informs this DockAction that icons, text, and other stuff like that, will be requested from this DockAction. This method should be called from the object that will display the view of this action.

Specified by:

bind in interface DockAction

Overrides:

bind in class AbstractStandardDockAction

Parameters:

dockable - the Dockable that may be used in the future

See Also:

DockAction.unbind(Dockable)

unbind

public void unbind(Dockable dockable)

Description copied from interface: DockAction

Invoked only if the dockable was bound to this DockAction, and if the dockable will no longer be used for any method calls (except bind) on this DockAction.

Specified by:

unbind in interface DockAction

Overrides:

unbind in class AbstractStandardDockAction

Parameters:

dockable - The Dockable that will never be seen again, except it is maybe bind again.

bound

protected void bound(Dockable dockable)

Description copied from class: AbstractStandardDockAction

Invoked by this AbstractStandardDockAction when a Dockable was bound to this action the first time.

Overrides:

bound in class SimpleDockAction

Parameters:

dockable - The Dockable that was not known to this action before the method was invoked

unbound

protected void unbound(Dockable dockable)

Description copied from class: AbstractStandardDockAction

Called by this AbstractStandardDockAction when the Dockable dockable will not be used in any means by this action. Note that the AbstractStandardDockAction.bound(Dockable)-method can be invoked again with the dockable.

Overrides:

unbound in class SimpleDockAction

Parameters:

dockable - The Dockable which will not by used in any way.

titleIconChanged

public void titleIconChanged(Dockable dockable,
                             Icon oldIcon,
                             Icon newIcon)

Description copied from interface: DockableListener

Invoked when the title-icon of a Dockable has changed

Specified by:

titleIconChanged in interface DockableListener

Parameters:

dockable - the Dockable whose title is changed

oldIcon - the old icon, may be null

newIcon - the new icon, may be null

titleTextChanged

public void titleTextChanged(Dockable dockable,
                             String oldTitle,
                             String newTitle)

Description copied from interface: DockableListener

Invoked when the title of a Dockable has changed.

Specified by:

titleTextChanged in interface DockableListener

Parameters:

dockable - the Dockable whose title is changed

oldTitle - the title before the change

newTitle - the title after the change

titleToolTipChanged

public void titleToolTipChanged(Dockable dockable,
                                String oldToolTip,
                                String newToolTip)

Description copied from interface: DockableListener

Called when the tooltip of a Dockable changed.

Specified by:

titleToolTipChanged in interface DockableListener

Parameters:

dockable - the dockable whose tooltip changed

oldToolTip - the old value

newToolTip - the new value

titleBound

public void titleBound(Dockable dockable,
                       DockTitle title)

Description copied from interface: DockableListener

Will be invoked when a DockTitle was bound to a Dockable.

Specified by:

titleBound in interface DockableListener

Parameters:

dockable - the Dockable whose title is set

title - the new title

titleExchanged

public void titleExchanged(Dockable dockable,
                           DockTitle title)

Description copied from interface: DockableListener

Invoked when the properties of a Dockable have a so dramatically changed, that the DockTitle title is no longer considered a good title and should be replaced. The one element which shows title should unbind it, and request a new title.

Specified by:

titleExchanged in interface DockableListener

Parameters:

dockable - the source of the event

title - the title that should be discarded, can be null to alert elements which do show the null-title

titleUnbound

public void titleUnbound(Dockable dockable,
                         DockTitle title)

Description copied from interface: DockableListener

Will be invoked when a DockTitle was unbound from a Dockable.

Specified by:

titleUnbound in interface DockableListener

Parameters:

dockable - the Dockable whose title was removed

title - the remove title