|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CStationContainer
A CStationContainer
is a set of root CStation
s that are somehow
combined and ordered on some kind of Component
. A container may or may not be mutable.
Method Summary | |
---|---|
void |
addStationContainerListener(CStationContainerListener listener)
Adds the observer listener to this container. |
Component |
getComponent()
Gets a Component whose children are all the CStation s of this
CStationContainer . |
CStation<?> |
getDefaultStation()
Gets the preferred default CStation of this container. |
CStation<?> |
getDefaultStation(ExtendedMode mode)
Gets the preferred default CStation of this container for children in mode mode . |
CStation<?> |
getMatchingStation(CStationContainer container,
CStation<?> station)
Assuming container is a type of CStationContainer that is known to
this , and assuming station is a child of container : this
method returns one of this children that has the same relative location in respect to this
as station has to container . |
CStation<?> |
getStation(int index)
Gets the index'th child of this container. |
int |
getStationCount()
Gets the number of CStation s that are currently in this container. |
String |
getUniqueId()
Gets a unique identifier that is used by only this CStationContainer . |
void |
removeStationContainerListener(CStationContainerListener listener)
Removes the observer listener from this container. |
Method Detail |
---|
void addStationContainerListener(CStationContainerListener listener)
listener
to this container. The listener is to be informed
whenever a CStation
is added or removed from this container.
listener
- the new listener, not null
void removeStationContainerListener(CStationContainerListener listener)
listener
from this container.
listener
- the listener to removeString getUniqueId()
CStationContainer
.
null
Component getComponent()
Component
whose children are all the CStation
s of this
CStationContainer
.
CStation
s, not null
int getStationCount()
CStation
s that are currently in this container.
CStation<?> getStation(int index)
index
- the index of the child, between 0 and getStationCount()
null
CStation<?> getDefaultStation()
CStation
of this container. Children with no location
are usually made visible on such a default station.
null
CStation<?> getDefaultStation(ExtendedMode mode)
CStation
of this container for children in mode mode
.
mode
- the mode for which a station is searched
CStationContainer
that can show Dockable
s in mode mode
,
can be null
CStation<?> getMatchingStation(CStationContainer container, CStation<?> station)
container
is a type of CStationContainer
that is known to
this
, and assuming station
is a child of container
: this
method returns one of this
children that has the same relative location in respect to this
as station
has to container
. For example if station
is the
center area of a CGridArea
, and this
is a CGridArea
as well, then
this method would return the center area of this
.
container
- some kind of CStationContainer
, may be a type that is known to this
or not.station
- some child of container
this
, such that the location of the child in relation to this
is
equivalent to the location of station
in relation to container
. A value of
null
indicates that this method did not find a suitable child. If possible the result of this method
and station
should be of the same type.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |