bibliothek.gui.dock.support.mode
Class ModeForwardingActionSource<H>

java.lang.Object
  bibliothek.gui.dock.action.AbstractDockActionSource
      bibliothek.gui.dock.support.mode.ModeForwardingActionSource<H>

All Implemented Interfaces:

DockActionSource, Iterable<DockAction>

public class ModeForwardingActionSource<H>
extends AbstractDockActionSource

A ModeForwardingActionSource is attached to a DockStation and shows actions belonging to the selected Dockable. Only actions that were approved by the ModeManager are actually shown.

Author:

Benjamin Sigg

Field Summary

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

listeners

Constructor Summary

ModeForwardingActionSource(DockStation station, ModeManager<H,? extends Mode<H>> manager)
Creates a new action source

Method Summary

void	addDockActionSourceListener(DockActionSourceListener listener) Adds a listener to this source.
DockAction	getDockAction(int index) Gets the index'th DockAction of this source.
int	getDockActionCount() Gets the number of DockActions which are provided by this source.
LocationHint	getLocationHint() Gets a hint where to put this source in relation to other sources.
Iterator<DockAction>	iterator()
void	removeDockActionSourceListener(DockActionSourceListener listener) Removes an earlier added listener.

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

Constructor Detail

ModeForwardingActionSource

public ModeForwardingActionSource(DockStation station,
                                  ModeManager<H,? extends Mode<H>> manager)

Creates a new action source

Parameters:

station - the station for which the actions are used

manager - the manager that has to be observed

Method Detail

addDockActionSourceListener

public void addDockActionSourceListener(DockActionSourceListener listener)

Description copied from interface: DockActionSource

Adds a listener to this source. The DockActionSourceListener should be informed whenever some DockActions are added or removed from this source.

Specified by:

addDockActionSourceListener in interface DockActionSource

Overrides:

addDockActionSourceListener in class AbstractDockActionSource

Parameters:

listener - The listener

removeDockActionSourceListener

public void removeDockActionSourceListener(DockActionSourceListener listener)

Description copied from interface: DockActionSource

Removes an earlier added listener.

Specified by:

removeDockActionSourceListener in interface DockActionSource

Overrides:

removeDockActionSourceListener in class AbstractDockActionSource

Parameters:

listener - The listener to remove

See Also:

DockActionSource.addDockActionSourceListener(DockActionSourceListener)

getDockAction

public DockAction getDockAction(int index)

Description copied from interface: DockActionSource

Gets the index'th DockAction of this source.

Parameters:

index - The index of the action

Returns:

The DockAction

getDockActionCount

public int getDockActionCount()

Description copied from interface: DockActionSource

Gets the number of DockActions which are provided by this source.

Returns:

The number of DockActions

getLocationHint

public LocationHint getLocationHint()

Description copied from interface: DockActionSource

Gets a hint where to put this source in relation to other sources. Note that an ActionOffer can choose to ignore these hints, or interpret them in an unexpected way.

Returns:

the preferred location of this source

iterator

public Iterator<DockAction> iterator()