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:

SharingDropDownItemAction, SharingStandardDockAction, 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 popup menu will appear, where the user can enter the new title of the Dockable.
RenameActions can be easily created by a RenameActionFactory

Author:

Benjamin Sigg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Fields

Modifier and Type	Field and Description
static String	KEY_ICON the key uses for the IconManager to get the Icon of this action

Fields inherited from interface bibliothek.gui.dock.action.DockAction

BUTTON_CONTENT_FILTER

Constructor Summary

Constructors

Constructor and Description
RenameAction(DockController controller) Constructs a new action

Method Summary

Modifier and Type	Method and Description
void	action(Dockable dockable)
protected void	bound(Dockable dockable)
protected abstract void	rename(Dockable dockable, String text) Invoked when the action was triggered, and the user tipped in the new title for dockable.
protected void	unbound(Dockable dockable)

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, getDockableRepresentation, getDockableRepresentation, getIcon, getIcon, getIcon, getIconContexts, 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, 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.dropdown.DropDownItemAction

isDropDownSelectable, isDropDownTriggerable

Methods inherited from interface bibliothek.gui.dock.action.StandardDockAction

addDockActionListener, getDockableRepresentation, getIcon, getIconContexts, getText, getTooltipText, isEnabled, removeDockActionListener

Methods inherited from interface bibliothek.gui.dock.action.DockAction

bind, unbind

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

Field Detail

KEY_ICON

public static final 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)

Specified by:

action in interface ButtonDockAction

Overrides:

action in class SimpleButtonAction

bound

protected void bound(Dockable dockable)

Overrides:

bound in class SimpleDockAction

unbound

protected void unbound(Dockable dockable)

Overrides:

unbound in class SimpleDockAction

rename

protected abstract void rename(Dockable dockable,
                               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