bibliothek.gui.dock.facile.action
Class RenameAction

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.SimpleButtonAction
                  bibliothek.gui.dock.facile.action.RenameAction

All Implemented Interfaces:

ButtonDockAction, DockAction, DropDownItemAction, StandardDockAction, StandardDropDownItemAction

Direct Known Subclasses:

RenameAction.RenameDefaultDockable, RenameAction.RenameFlapDockStation, RenameAction.RenameSplitDockStation, RenameAction.RenameStackDockStation

@ClientOnly
public abstract class RenameAction
extends SimpleButtonAction

This DockAction can change the title-text of a Dockable. When this action is triggered, a popupmenu will appear, where the user can enter the new title of the Dockable.
RenameActions can be easely created by a RenameActionFactory

Author:

Benjamin Sigg

Nested Class Summary

static class	RenameAction.RenameDefaultDockable An implementation of RenameAction that can handle DefaultDockables.
static class	RenameAction.RenameFlapDockStation An implementation of RenameAction that can handle FlapDockStations.
static class	RenameAction.RenameSplitDockStation An implementation of RenameAction that can handle SplitDockStations.
static class	RenameAction.RenameStackDockStation An implementation of RenameAction that can handle StackDockStations.

Field Summary

static java.lang.String

KEY_ICON the key uses for the IconManager to get the Icon of this action

Constructor Summary

RenameAction(DockController controller)
Constructs a new action

Method Summary

void	action(Dockable dockable) Invoked when this action is triggered by the user.
protected void	bound(Dockable dockable) Invoked by this AbstractStandardDockAction when a Dockable was bound to this action the first time.
protected abstract void	rename(Dockable dockable, java.lang.String text) Invoked when the action was triggered, and the user tipped in the new title for dockable.
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.SimpleButtonAction

addActionListener, createView, getCommand, removeActionListener, setCommand, trigger

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, getDisabledIcon, getDockableRepresentation, getDockableRepresentation, getIcon, getIcon, getText, getText, getTooltip, getTooltipText, getTooltipText, isEnabled, isEnabled, setAccelerator, setDisabledIcon, setDockableRepresentation, setEnabled, setIcon, setText, setTooltip, trigger

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

addDockActionListener, bind, fireActionDisabledIconChanged, 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.dropdown.DropDownItemAction

isDropDownSelectable, isDropDownTriggerable

Field Detail

KEY_ICON

public static final java.lang.String KEY_ICON

the key uses for the IconManager to get the Icon of this action

See Also:

Constant Field Values

Constructor Detail

RenameAction

public RenameAction(DockController controller)

Constructs a new action

Parameters:

controller - The controller to which a listener will be added to get the Icon for this action

Method Detail

action

public void action(Dockable dockable)

Description copied from interface: ButtonDockAction

Invoked when this action is triggered by the user.

Specified by:

action in interface ButtonDockAction

Overrides:

action in class SimpleButtonAction

Parameters:

dockable - The Dockable which is associated with this DockAction, and which shall be used for the current action.

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.

rename

protected abstract void rename(Dockable dockable,
                               java.lang.String text)

Invoked when the action was triggered, and the user tipped in the new title for dockable.

Parameters:

dockable - The Dockable whose title should be changed

text - The new title