bibliothek.gui.dock.common.perspective
Interface CStationPerspective

All Superinterfaces:

CElementPerspective

All Known Implementing Classes:

CExternalizePerspective, CGridPerspective, CMinimizePerspective, CWorkingPerspective

public interface CStationPerspective
extends CElementPerspective

A representation of a CStation.

Author:

Benjamin Sigg

Method Summary

CPerspective	getPerspective() Gets the perspective which presents this station.
Path	getTypeId() Gets the unique id denoting the type of this CStation, this should be the exact same result as CStation.getTypeId() will return.
String	getUniqueId() Gets the unique identifier of this station.
boolean	isRoot() Tells whether this is a root station or not.
boolean	isWorkingArea() Tells whether this station will act as a working area.
void	setPerspective(CPerspective perspective) Informs this station by which perspective it is used.
void	setRoot(boolean root) Sets the root station flag.

Methods inherited from interface bibliothek.gui.dock.common.perspective.CElementPerspective

asDockable, asStation, intern

Method Detail

getUniqueId

String getUniqueId()

Gets the unique identifier of this station.

Returns:

the unique identifier

getTypeId

Path getTypeId()

Gets the unique id denoting the type of this CStation, this should be the exact same result as CStation.getTypeId() will return.

Returns:

the type id, can be null

setPerspective

@FrameworkOnly
void setPerspective(CPerspective perspective)

Informs this station by which perspective it is used.

Parameters:

perspective - the perspective that uses this station or null

getPerspective

CPerspective getPerspective()

Gets the perspective which presents this station.

Returns:

the owner of this station, can be null

isWorkingArea

boolean isWorkingArea()

Tells whether this station will act as a working area.

Returns:

whether this station acts as working area

isRoot

boolean isRoot()

Tells whether this is a root station or not.

Returns:

the root flag

See Also:

setRoot(boolean)

setRoot

void setRoot(boolean root)

Sets the root station flag. Setting flag is equivalent of setting the root parameter when calling CControl.addStation(bibliothek.gui.dock.common.CStation, boolean). The location of a Dockable is always relative to its nearest root-station parent.
Please note that the root-flag set by calling CControl.addStation(bibliothek.gui.dock.common.CStation, boolean) will never be overriden by the flag set in the perspective.

Parameters:

root -