bibliothek.gui.dock.facile.mode

Interface ModeArea

All Known Subinterfaces:

CExternalizedModeArea, CMaximizedModeArea, CMinimizedModeArea, CModeArea, CNormalModeArea, ExternalizedModeArea, MaximizedModeArea, MinimizedModeArea, NormalModeArea, StationModeArea

All Known Implementing Classes:

CFlapDockStationHandle, CScreenDockStationHandle.External, CScreenDockStationHandle.Maximal, CSplitDockStationHandle.Maximal, CSplitDockStationHandle.Normal, ExternalizedCSplitDockStationHandler.Externalized, FlapDockStationHandle

public interface ModeArea

A representation of some area that can show Dockables, it is a wrapper for a DockStation.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	addModeAreaListener(ModeAreaListener listener) Adds a listener to this area.
boolean	autoDefaultArea() Tells whether this ModeArea can automatically become the default area of some mode.
DockStation	getStation() Gets the station which is represented by this area.
String	getUniqueId() Gets a unique identifier for this area.
boolean	isChild(Dockable dockable) Tells whether dockable is a direct child of this station.
boolean	isLocationRoot() Tells whether this area can be used as root in a Location.
void	removeModeAreaListener(ModeAreaListener listener) Removes a listener from this area.
void	setController(DockController controller) Connects this area with a controller.
void	setMode(LocationMode mode) Informs this area about the mode that uses it.

Method Detail

getUniqueId

String getUniqueId()

Gets a unique identifier for this area.

Returns:

the unique identifier

See Also:

CStation.getUniqueId()

autoDefaultArea

boolean autoDefaultArea()

Tells whether this ModeArea can automatically become the default area of some mode.

Returns:

true if this can be a default area, false if not

isLocationRoot

boolean isLocationRoot()

Tells whether this area can be used as root in a Location. An area that is not a location root will (usually) not be used to set the location of a child.
Most implementations of ModeArea should return true.

Returns:

whether this ModeArea agrees on seeing its getUniqueId() in a Location

isChild

boolean isChild(Dockable dockable)

Tells whether dockable is a direct child of this station.

Parameters:

dockable - some element

Returns:

true if and only if the parent of dockable is identical to this station

getStation

DockStation getStation()

Gets the station which is represented by this area.

Returns:

the station, not null

setController

void setController(DockController controller)

Connects this area with a controller. It's up to the area to add or remove listeners if necessary.

Parameters:

controller - the controller or null

setMode

void setMode(LocationMode mode)

Informs this area about the mode that uses it.

Parameters:

mode - the owner of this area, can be null

addModeAreaListener

void addModeAreaListener(ModeAreaListener listener)

Adds a listener to this area.

Parameters:

listener - the new listener

removeModeAreaListener

void removeModeAreaListener(ModeAreaListener listener)

Removes a listener from this area.

Parameters:

listener - the listener to remove