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, CSplitDockStationHandle.Maximal, CSplitDockStationHandle.Normal, FlapDockStationHandle, ScreenDockStationHandle

public interface ModeArea

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

Author:
Benjamin Sigg

Method Summary
 void addModeAreaListener(ModeAreaListener listener)
          Adds a listener to this area.
 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.
 void removeModeAreaListener(ModeAreaListener listener)
          Removes a listener from this area.
 boolean respectWorkingAreas()
          Tells whether children of this area have to respect the settings for CWorkingAreas.
 void setController(DockController controller)
          Connects this area with a controller.
 

Method Detail

getUniqueId

String getUniqueId()
Gets a unique identifier for this area.

Returns:
the unique identifier
See Also:
CStation.getUniqueId()

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

respectWorkingAreas

boolean respectWorkingAreas()
Tells whether children of this area have to respect the settings for CWorkingAreas.

Returns:
whether the settings are to be respected

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

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