bibliothek.gui.dock.common.intern.station

Interface CommonDockStation<S extends DockStation,C extends CommonDockStation<S,C>>

Type Parameters:

S - the kind of station this wraps

C - the kind of CommonDockStation this is

All Superinterfaces:

CommonElement, DockComponentRoot, DockElement, DockStation

All Known Implementing Classes:

CFlapDockStation, CScreenDockStation, CSplitDockStation

public interface CommonDockStation<S extends DockStation,C extends CommonDockStation<S,C>>
extends CommonElement, DockStation

An interface that can be implemented by classes that extend a DockStation and that represent a CStation.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
C	asDockStation() Returns this as station of type C.
String	getConverterID() Gets the unique identifier of the DockFactory that should be used by the CommonDockStationFactory to actually write or read the layout.
S	getDockStation() Gets this as S.
String	getFactoryID() Gets the unique identifier of the DockFactory that stores and loads the layout of this station.
CStation<C>	getStation() Gets the model of this station.

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

asDockable

Methods inherited from interface bibliothek.gui.DockStation

accept, addDockStationListener, aside, canDrag, canReplace, changed, drag, drop, drop, getController, getDirectActionOffers, getDockable, getDockableCount, getDockableProperty, getFrontDockable, getIndirectActionOffers, getLayers, getPlaceholderMapping, getPlaceholders, getTheme, isChildShowing, isStationShowing, isStationVisible, isVisible, move, prepareDrag, prepareDrop, removeDockStationListener, replace, replace, requestChildDisplayer, requestChildDockTitle, setController, setFrontDockable, setPlaceholders, updateTheme

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

getComponentConfiguration, setComponentConfiguration

Method Detail

getDockStation

S getDockStation()

Gets this as S.

Returns:

this

asDockStation

C asDockStation()

Returns this as station of type C. This method is not allowed to return null.

Specified by:

asDockStation in interface CommonElement

Specified by:

asDockStation in interface DockElement

Returns:

this

getStation

CStation<C> getStation()

Gets the model of this station.

Returns:

the model, may not be null

getFactoryID

String getFactoryID()

Gets the unique identifier of the DockFactory that stores and loads the layout of this station. For CommonDockStations the result should always be CommonDockStationFactory.FACTORY_ID

Specified by:

getFactoryID in interface DockElement

See Also:

getConverterID()

getConverterID

String getConverterID()

Gets the unique identifier of the DockFactory that should be used by the CommonDockStationFactory to actually write or read the layout. Usually the result of this method is the same result as DockElement.getFactoryID() (note: the factory id from the super class).

Returns:

the unique identifier of a DockFactory. Can be null if getFactoryID() does not return CommonDockStationFactory.FACTORY_ID