bibliothek.gui.dock.facile.action

Class KeyedActionSource

java.lang.Object

bibliothek.gui.dock.action.AbstractDockActionSource

bibliothek.gui.dock.facile.action.KeyedActionSource

All Implemented Interfaces:

DockActionSource, Iterable<DockAction>

@FrameworkOnly
public class KeyedActionSource
extends AbstractDockActionSource

An action source using CDockable.getAction(String) to determine which action to use. If getAction returns null, then a default action can be used. This action source also allows to disable any action.

Author:

Benjamin Sigg

Field Summary

Fields inherited from class bibliothek.gui.dock.action.AbstractDockActionSource

listeners

Constructor Summary

Constructors

Constructor and Description
KeyedActionSource(CDockable dockable, String key) Creates a new action source

Method Summary

Modifier and Type	Method and Description
void	addDockActionSourceListener(DockActionSourceListener listener)
void	destroy() Detaches the listeners this DockActionSource added to other objects.
DockAction	getDefaultAction() Gets the default action of this source.
DockAction	getDockAction(int index)
int	getDockActionCount()
String	getKey() Gets the key which is used for calling CDockable.getAction(String)
LocationHint	getLocationHint()
Iterator<DockAction>	iterator()
void	removeDockActionSourceListener(DockActionSourceListener listener)
void	setDefaultAction(DockAction defaultAction) Sets the default action of this source.
void	setVisible(boolean visible) Changes whether any actions are shown or not.

Methods inherited from class bibliothek.gui.dock.action.AbstractDockActionSource

fireAdded, fireRemoved, hasListeners, indexOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyedActionSource

public KeyedActionSource(CDockable dockable,
                         String key)

Creates a new action source

Parameters:

dockable - the element for which this source is used

key - the key for calling CDockable.getAction(String)

Method Detail

getKey

public String getKey()

Gets the key which is used for calling CDockable.getAction(String)

Returns:

the key, not null

addDockActionSourceListener

public void addDockActionSourceListener(DockActionSourceListener listener)

Specified by:

addDockActionSourceListener in interface DockActionSource

Overrides:

addDockActionSourceListener in class AbstractDockActionSource

removeDockActionSourceListener

public void removeDockActionSourceListener(DockActionSourceListener listener)

Specified by:

removeDockActionSourceListener in interface DockActionSource

Overrides:

removeDockActionSourceListener in class AbstractDockActionSource

destroy

public void destroy()

Detaches the listeners this DockActionSource added to other objects.

setVisible

public void setVisible(boolean visible)

Changes whether any actions are shown or not.

Parameters:

visible - the new state

setDefaultAction

public void setDefaultAction(DockAction defaultAction)

Sets the default action of this source. The default action is used if CDockable.getAction(String) returns null.

Parameters:

defaultAction - the default action, may be null

getDefaultAction

public DockAction getDefaultAction()

Gets the default action of this source.

Returns:

the default action, can be null

getDockAction

public DockAction getDockAction(int index)

getDockActionCount

public int getDockActionCount()

getLocationHint

public LocationHint getLocationHint()

iterator

public Iterator<DockAction> iterator()