bibliothek.gui.dock
Interface DockElement

All Superinterfaces:
DockComponentRoot
All Known Subinterfaces:
CommonDockable, CommonDockStation<S,C>, CommonElement, Dockable, DockStation
All Known Implementing Classes:
AbstractDockable, AbstractDockableStation, AbstractDockStation, CFlapDockStation, CScreenDockStation, CSplitDockStation, DefaultCommonDockable, DefaultDockable, FlapDockStation, ScreenDockStation, SplitDockStation, StackDockStation

public interface DockElement
extends DockComponentRoot

An element in the hierarchy of dockables and stations. Classes implementing this interface must either be a Dockable, a DockStation or both of them.

Author:
Benjamin Sigg

Method Summary
 Dockable asDockable()
          Returns this if this is an instance of Dockable.
 DockStation asDockStation()
          Returns this if this is an instance of DockStation.
 DockController getController()
          Gets the controller that currently is associated with this DockElement.
 String getFactoryID()
          Gets the unique name of the DockFactory which can read and write elements of this type.
 
Methods inherited from interface bibliothek.gui.dock.component.DockComponentRoot
getComponentConfiguration, setComponentConfiguration
 

Method Detail

asDockable

Dockable asDockable()
Returns this if this is an instance of Dockable. Otherwise null is returned.

Returns:
this or null. Must not return null if asDockable() already returns null.

asDockStation

DockStation asDockStation()
Returns this if this is an instance of DockStation. Otherwise null is returned.

Returns:
this or null. Must not return null if asDockable() already returns null

getController

DockController getController()
Gets the controller that currently is associated with this DockElement.

Returns:
the controller or null

getFactoryID

String getFactoryID()
Gets the unique name of the DockFactory which can read and write elements of this type.

Returns:
the id of the factory