|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
S
- what kind of internal implementation this station usespublic interface CStation<S extends CommonDockStation<?,?>>
A CStation
is an element onto which CDockable
s can be dropped.
Each station can, but does not have to be, a CDockable
itself. Stations
are added to the CControl
through CControl.addStation(CStation, boolean)
.
A station is either a root-station (meaning that it has no parent) or
CDockable
. It is possible to use a CDockable
as root-station.
Method Summary | |
---|---|
CDockable |
asDockable()
If this station is a CDockable as well, then this method returns
the representation of this station as CDockable . |
CStationPerspective |
createPerspective()
Returns a new CStationPerspective that represents this station. |
CLocation |
getDropLocation()
Creates a CLocation that can be used to drop a new CDockable on this station
or one of its children stations. |
S |
getStation()
Gets the internal representation of this CStation . |
CLocation |
getStationLocation()
Gets a location which represents directly getStation() . |
Path |
getTypeId()
Gets a unique path denoting the type of this station. |
String |
getUniqueId()
Gets a unique and constant identifier for this station |
boolean |
isWorkingArea()
Tells whether this station is a special working area or not. |
void |
setControlAccess(CControlAccess access)
Called by CControl when this CStation is added or removed. |
Method Detail |
---|
S getStation()
CStation
.
CDockable asDockable()
CDockable
as well, then this method returns
the representation of this station as CDockable
.
null
CStationPerspective createPerspective()
CStationPerspective
that represents this
station. This method
does not need to set any content of the new perspective. Basically this method just needs to tell
the framework what type of CStationPerspective
is needed, not what its content is.
getTypeId()
boolean isWorkingArea()
CControl.addStation(CStation, boolean)
)
or must be a SingleCDockable
.
true
if this is a working area, false
otherwiseString getUniqueId()
Path getTypeId()
MissingPerspectiveStrategy.createStation(String, Path)
when loading a layout
as a CPerspective
.
null
will just be ignored.CLocation getStationLocation()
getStation()
.
station
CLocation getDropLocation()
CLocation
that can be used to drop a new CDockable
on this station
or one of its children stations. This method returns the "optimal spot", where the definition
of "optimal spot" is up to the station itself. The default implementations however call
CLocationModeManager.getDropLocation(CStation)
.
CDockable
or null
if this
station is not able to calculate the optimal spot (e.g. because the station is not visible)void setControlAccess(CControlAccess access)
CControl
when this CStation
is added or removed.
There are two actions which most stations might want to do:add
methods for ModeArea
s accessible through the CLocationModeManager
.
That will ensure that the station can be used as minimize/normalize/... area.ResizeRequestListener
to CControl
in order to be
informed when resize requests are to be handled.
access
- access to the internals of the CControl
that uses
this station or null
to remove all ties from a control
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |