public interface ModeArea
Dockable
s,
it is a wrapper for a DockStation
.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.
|
java.lang.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.
|
java.lang.String getUniqueId()
CStation.getUniqueId()
boolean autoDefaultArea()
ModeArea
can automatically become
the default area of some mode.true
if this can be a default area, false
if notboolean isLocationRoot()
Location
. An area that is not
a location root will (usually) not be used to set the location of a child.ModeArea
should return true
.ModeArea
agrees on seeing its getUniqueId()
in a Location
boolean isChild(Dockable dockable)
dockable
is a direct child of this station.dockable
- some elementtrue
if and only if the parent of dockable
is identical to this stationDockStation getStation()
null
void setController(DockController controller)
controller
- the controller or null
void setMode(LocationMode mode)
mode
- the owner of this area, can be null
void addModeAreaListener(ModeAreaListener listener)
listener
- the new listenervoid removeModeAreaListener(ModeAreaListener listener)
listener
- the listener to remove