bibliothek.gui.dock.common.intern

Interface CommonDockable

All Superinterfaces:

CommonElement, Dockable, DockComponentRoot, DockElement, DockElementRepresentative, PlaceholderListItem<Dockable>

All Known Implementing Classes:

CSplitDockStation, DefaultCommonDockable

public interface CommonDockable
extends Dockable, CommonElement

A Dockable which is a wrapper for a CDockable.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
CDockable	getDockable() Gets the model of this dockable.
String	getFactoryID() Gets the identifier of the DockFactory which can store and load this dockable.
DockActionSource[]	getSources() Gets a set of DockActionSources which are to be displayed on this CommonDockable.
CStation<?>	getStation() Gets the model of this dockable as station.

Methods inherited from interface bibliothek.gui.Dockable

accept, accept, addDockableListener, addDockableStateListener, addDockHierarchyListener, addMouseInputListener, bind, configureDisplayerHints, getComponent, getController, getDockParent, getGlobalActionOffers, getLocalActionOffers, getTitleIcon, getTitleText, getTitleToolTip, isDockableShowing, isDockableVisible, listBoundTitles, removeDockableListener, removeDockableStateListener, removeDockHierarchyListener, removeMouseInputListener, requestDisplayer, requestDockTitle, setController, setDockParent, unbind

Methods inherited from interface bibliothek.gui.dock.DockElementRepresentative

getElement, getPopupLocation, isUsedAsTitle, shouldFocus, shouldTransfersFocus

Methods inherited from interface bibliothek.gui.dock.station.support.PlaceholderListItem

asDockable

Methods inherited from interface bibliothek.gui.dock.common.intern.CommonElement

asDockable, asDockStation

Methods inherited from interface bibliothek.gui.dock.component.DockComponentRoot

getComponentConfiguration, setComponentConfiguration

Method Detail

getDockable

CDockable getDockable()

Gets the model of this dockable.

Returns:

the model

getStation

CStation<?> getStation()

Gets the model of this dockable as station.

Returns:

the model, may be null

getSources

DockActionSource[] getSources()

Gets a set of DockActionSources which are to be displayed on this CommonDockable. Note that every call to this method should return the same array of sources. Callers should not modify the result.

Returns:

the action sources, can be an empty array

getFactoryID

String getFactoryID()

Gets the identifier of the DockFactory which can store and load this dockable. CommonDockables which show a SingleCDockable should return CommonSingleDockableFactory.BACKUP_FACTORY_ID and the others should return the id of MultipleCDockable.getFactory().
If the subclass implements CommonDockStation, then CommonDockStationFactory.FACTORY_ID should be returned.

Specified by:

getFactoryID in interface DockElement

Returns:

the name of the factory