bibliothek.gui.dock.action
Interface DockActionSource

All Superinterfaces:

Iterable<DockAction>

All Known Implementing Classes:

AbstractDockActionSource, CActionSource, CloseActionSource, DefaultDockActionSource, EclipseDockActionSource, FilteredDockActionSource, HierarchyDockActionSource, KeyedActionSource, MultiDockActionSource

public interface DockActionSource
extends Iterable<DockAction>

A list of DockActions which may change its size at any time.

Author:

Benjamin Sigg

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.
void	removeDockActionSourceListener(DockActionSourceListener listener) Removes an earlier added listener.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getLocationHint

LocationHint getLocationHint()

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

getDockActionCount

int getDockActionCount()

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

Returns:

The number of DockActions

getDockAction

DockAction getDockAction(int index)

Gets the index'th DockAction of this source.

Parameters:

index - The index of the action

Returns:

The DockAction

addDockActionSourceListener

void addDockActionSourceListener(DockActionSourceListener listener)

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

Parameters:

listener - The listener

removeDockActionSourceListener

void removeDockActionSourceListener(DockActionSourceListener listener)

Removes an earlier added listener.

Parameters:

listener - The listener to remove

See Also:

addDockActionSourceListener(DockActionSourceListener)