protected class CScreenDockStationHandle.External extends Object implements CExternalizedModeArea
CScreenDockStationHandle
as CExternalizedModeArea
.Modifier | Constructor and Description |
---|---|
protected |
CScreenDockStationHandle.External() |
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. |
CLocation |
getCLocation(Dockable dockable)
Assuming
dockable is a child of this area, returns
the location of dockable . |
CLocation |
getCLocation(Dockable dockable,
Location location)
Assuming
dockable would be at location location
if it would be a child of this station, returns the CLocation that
matches location . |
DockableProperty |
getLocation(Dockable child)
Gets the location of
dockable which is a child
of this station. |
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 . |
ModeAreaListener[] |
listeners()
Gets all the listeners that are registered at this area.
|
void |
removeModeAreaListener(ModeAreaListener listener)
Removes a listener from this area.
|
boolean |
respectWorkingAreas()
Tells whether children of this area have to respect the settings for
CWorkingArea s. |
void |
setController(DockController controller)
Connects this area with a controller.
|
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. |
void |
setMode(LocationMode mode)
Informs this area about the mode that uses it.
|
public DockableProperty getLocation(Dockable child)
StationModeArea
dockable
which is a child
of this station.getLocation
in interface StationModeArea
child
- the childnull
public boolean autoDefaultArea()
ModeArea
ModeArea
can automatically become
the default area of some mode.autoDefaultArea
in interface ModeArea
true
if this can be a default area, false
if notpublic boolean isLocationRoot()
ModeArea
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
.isLocationRoot
in interface ModeArea
ModeArea
agrees on seeing its ModeArea.getUniqueId()
in a Location
public boolean setLocation(Dockable dockable, DockableProperty location, AffectedSet set)
StationModeArea
dockable
to location
and tries to ensure that dockable
is a child of this station.dockable
, for example because
a DockAcceptance
does not allow the dockable to be moved. In such cases false
is
returned.setLocation
in interface StationModeArea
dockable
- the new or old childlocation
- the new location, may be null
set
- this method has to store all Dockable
s which might have changed their
mode in the set.true
if dockable
is now a child of this StationModeArea
, false
if notpublic void addModeAreaListener(ModeAreaListener listener)
ModeArea
addModeAreaListener
in interface ModeArea
listener
- the new listenerpublic void removeModeAreaListener(ModeAreaListener listener)
ModeArea
removeModeAreaListener
in interface ModeArea
listener
- the listener to removepublic ModeAreaListener[] listeners()
public DockStation getStation()
ModeArea
getStation
in interface ModeArea
null
public String getUniqueId()
ModeArea
getUniqueId
in interface ModeArea
CStation.getUniqueId()
public boolean isChild(Dockable dockable)
ModeArea
dockable
is a direct child of this station.public boolean respectWorkingAreas()
CModeArea
CWorkingArea
s.respectWorkingAreas
in interface CModeArea
public void setController(DockController controller)
ModeArea
setController
in interface ModeArea
controller
- the controller or null
public void setMode(LocationMode mode)
ModeArea
public CLocation getCLocation(Dockable dockable)
CModeArea
dockable
is a child of this area, returns
the location of dockable
.getCLocation
in interface CModeArea
dockable
- some childnull
if not foundpublic CLocation getCLocation(Dockable dockable, Location location)
CModeArea
dockable
would be at location location
if it would be a child of this station, returns the CLocation
that
matches location
.getCLocation
in interface CModeArea
dockable
- some element which may or may not be a child of this stationlocation
- the location dockable
would have if it would
be a child of this stationnull
if not found