|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CControlRegister
Grants access to the CDockable
s and other information that is
associated with a CControl
.
Method Summary | |
---|---|
CStationContainer |
getContainer(CStation<?> child)
Searches the CStationContainer which contains child . |
CControl |
getControl()
Gets the control for which this register is used. |
CDockable |
getDockable(int index)
Gets the index'th dockable that is registered |
int |
getDockableCount()
Gets the number of CDockable s that are registered. |
List<CDockable> |
getDockables()
Gets an unmodifiable list of all CDockable s which are known to
this register. |
Map<String,MultipleCDockableFactory<?,?>> |
getFactories()
Gets an unmodifiable map of all MultipleCDockableFactory s that
are known to this register. |
MultipleCDockableFactory<?,?> |
getFactory(String id)
Searches the factory with identifier id . |
List<MultipleCDockable> |
getMultipleDockables()
Gets an unmodifiable list of all MultipleCDockable s which are known to
this register. |
List<SingleCDockable> |
getSingleDockables()
Gets an unmodifiable list of all SingleCDockable s which are known to
this register. |
List<CStationContainer> |
getStationContainers()
Gets an unmodifiable list of all CStationContainer s known
to this register. |
List<CStation<?>> |
getStations()
Gets an unmodifiable list of all CStation s which are known to
this register. |
boolean |
isMultiId(String id)
Checks whether id could be created by toMultiId(String) . |
boolean |
isSingleId(String id)
Checks whether id could be created by toSingleId(String) . |
List<CDockable> |
listDockablesInMode(ExtendedMode mode)
Gets a list of all visible CDockable s in the given mode. |
Set<String> |
listMultipleDockableFactories()
Gets a list of identifiers of all MultipleCDockableFactory s
which are currently registered. |
List<MultipleCDockable> |
listMultipleDockables(MultipleCDockableFactory<?,?> factory)
Gets a list of all MultipleCDockable s that are registered at this
control and whose MultipleCDockable.getFactory() method returns
factory . |
Set<String> |
listSingleBackupFactories()
Gets a list of keys for all SingleCDockableFactory s which
are currently registered. |
Set<String> |
listSingleDockables()
Gets a list of all identifiers of SingleCDockable for which
the control has location information within the current setting . |
String |
multiToNormalId(String id)
Undoes the changes of toMultiId(String) . |
String |
singleToNormalId(String id)
Undoes the changes of toSingleId(String) . |
String |
toMultiId(String id)
Transforms an identifier to an identifier for a MultipleCDockable .Note that this method must never create an identifier that passes isSingleId(String) . |
String |
toSingleId(String id)
Transforms an identifier to an identifier for a SingleCDockable .Note that this method must never create an identifier that passes isMultiId(String) . |
Method Detail |
---|
CControl getControl()
int getDockableCount()
CDockable
s that are registered.
CDockable getDockable(int index)
index
- the index of the element
List<CDockable> getDockables()
CDockable
s which are known to
this register. The list might or might not be updated when the contents
of this register changes.
List<SingleCDockable> getSingleDockables()
SingleCDockable
s which are known to
this register. The list might or might not be updated when the contents
of this register changes.
List<MultipleCDockable> getMultipleDockables()
MultipleCDockable
s which are known to
this register. The list might or might not be updated when the contents
of this register change.
List<CStation<?>> getStations()
CStation
s which are known to
this register. The list might or might not be updated when the content
of this register changes.
Map<String,MultipleCDockableFactory<?,?>> getFactories()
MultipleCDockableFactory
s that
are known to this register. The map may or may not be updated when the
content of this register changes.
MultipleCDockableFactory<?,?> getFactory(String id)
id
.
id
- the id of the factory
null
Set<String> listSingleBackupFactories()
SingleCDockableFactory
s which
are currently registered.
Set<String> listMultipleDockableFactories()
MultipleCDockableFactory
s
which are currently registered.
List<MultipleCDockable> listMultipleDockables(MultipleCDockableFactory<?,?> factory)
MultipleCDockable
s that are registered at this
control and whose MultipleCDockable.getFactory()
method returns
factory
.
factory
- the factory to look out for
null
but might be emptyList<CDockable> listDockablesInMode(ExtendedMode mode)
CDockable
s in the given mode.
mode
- the mode which each CDockable
must have
CDockable
sSet<String> listSingleDockables()
SingleCDockable
for which
the control has location information within the current setting
.
null
List<CStationContainer> getStationContainers()
CStationContainer
s known
to this register. The list might or might not be updated when the contents
of this register change.
CStationContainer getContainer(CStation<?> child)
CStationContainer
which contains child
.
child
- the child whose parent is searched
child
or null
String toSingleId(String id)
SingleCDockable
.isMultiId(String)
.
id
- some identifier
SingleCDockable
boolean isSingleId(String id)
id
could be created by toSingleId(String)
.
id
- the id to check
true
if there is an input for toSingleId(String)
that would result in id
String singleToNormalId(String id)
toSingleId(String)
. It must be true
that singleToNormalId( toSingleId( id )) = id
. The behavior
of this method is unspecified if isSingleId(String)
returns
false
for id
.
id
- some id create by toSingleId(String)
.
String toMultiId(String id)
MultipleCDockable
.isSingleId(String)
.
id
- some identifier
MultipleCDockable
boolean isMultiId(String id)
id
could be created by toMultiId(String)
.
id
- the id to check
true
if there is an input for toMultiId(String)
that would result in id
String multiToNormalId(String id)
toMultiId(String)
. It must be true
that multiToNormalId( toMultiId( id )) = id
. The behavior
of this method is unspecified if isMultiId(String)
returns
false
for id
.
id
- some id create by toMultiId(String)
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |