Package bibliothek.gui.dock.facile.mode

Interface StationModeArea

All Superinterfaces:

ModeArea

All Known Subinterfaces:

CExternalizedModeArea, CMinimizedModeArea, CNormalModeArea, ExternalizedModeArea, MinimizedModeArea, NormalModeArea

All Known Implementing Classes:

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

public interface StationModeArea
extends ModeArea

A representation of a DockStation which can be accessed through Modes.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method	Description
DockableProperty	getLocation(Dockable child)	Gets the location of dockable which is a child of this station.
boolean	setLocation(Dockable dockable, DockableProperty location, AffectedSet set)	Sets the location of dockable to location and tries to ensure that dockable is a child of this station. This method may completely fail to change the location of dockable, for example because a DockAcceptance does not allow the dockable to be moved.

Methods inherited from interface bibliothek.gui.dock.facile.mode.ModeArea

addModeAreaListener, autoDefaultArea, getStation, getUniqueId, isChild, isLocationRoot, removeModeAreaListener, setController, setMode

Method Details

getLocation

DockableProperty getLocation(Dockable child)

Gets the location of dockable which is a child of this station.

Parameters:

child - the child

Returns:

the location, may be null

setLocation

boolean setLocation(Dockable dockable,
 DockableProperty location,
 AffectedSet set)

Sets the location of dockable to location and tries to ensure that dockable is a child of this station.
This method may completely fail to change the location of dockable, for example because a DockAcceptance does not allow the dockable to be moved. In such cases false is returned.

Parameters:

dockable - the new or old child

location - the new location, may be null

set - this method has to store all Dockables which might have changed their mode in the set.

Returns:

true if dockable is now a child of this StationModeArea, false if not