|
||||||||||
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 | |
---|---|
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. |
java.util.List<CDockable> |
getDockables()
Gets an unmodifiable list of all CDockable s which are known to
this register. |
java.util.Map<java.lang.String,MultipleCDockableFactory<?,?>> |
getFactories()
Gets an unmodifiable map of all MultipleCDockableFactory s that
are known to this register. |
MultipleCDockableFactory<?,?> |
getFactory(java.lang.String id)
Searches the factory with identifier id . |
java.util.List<MultipleCDockable> |
getMultipleDockables()
Gets an unmodifiable list of all MultipleCDockable s which are known to
this register. |
java.util.List<SingleCDockable> |
getSingleDockables()
Gets an unmodifiable list of all SingleCDockable s which are known to
this register. |
java.util.List<CStation<?>> |
getStations()
Gets an unmodifiable list of all CStation s which are known to
this register. |
boolean |
isMultiId(java.lang.String id)
Checks whether id could be created by toMultiId(String) . |
boolean |
isSingleId(java.lang.String id)
Checks whether id could be created by toSingleId(String) . |
java.util.List<CDockable> |
listDockablesInMode(ExtendedMode mode)
Gets a list of all visible CDockable s in the given mode. |
java.util.Set<java.lang.String> |
listMultipleDockableFactories()
Gets a list of identifiers of all MultipleCDockableFactory s
which are currently registered. |
java.util.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 . |
java.util.Set<java.lang.String> |
listSingleBackupFactories()
Gets a list of keys for all SingleCDockableFactory s which
are currently registered. |
java.util.Set<java.lang.String> |
listSingleDockables()
Gets a list of all identifiers of SingleCDockable for which
the control has location information within the current setting . |
java.lang.String |
multiToNormalId(java.lang.String id)
Undoes the changes of toMultiId(String) . |
java.lang.String |
singleToNormalId(java.lang.String id)
Undoes the changes of toSingleId(String) . |
java.lang.String |
toMultiId(java.lang.String id)
Transforms an identifier to an identifier for a MultipleCDockable . |
java.lang.String |
toSingleId(java.lang.String id)
Transforms an identifier to an identifier for a SingleCDockable . |
Method Detail |
---|
CControl getControl()
int getDockableCount()
CDockable
s that are registered.
CDockable getDockable(int index)
index
- the index of the element
java.util.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.
java.util.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.
java.util.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.
java.util.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.
java.util.Map<java.lang.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(java.lang.String id)
id
.
id
- the id of the factory
null
java.util.Set<java.lang.String> listSingleBackupFactories()
SingleCDockableFactory
s which
are currently registered.
java.util.Set<java.lang.String> listMultipleDockableFactories()
MultipleCDockableFactory
s
which are currently registered.
java.util.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 emptyjava.util.List<CDockable> listDockablesInMode(ExtendedMode mode)
CDockable
s in the given mode.
mode
- the mode which each CDockable
must have
CDockable
sjava.util.Set<java.lang.String> listSingleDockables()
SingleCDockable
for which
the control has location information within the current setting
.
null
java.lang.String toSingleId(java.lang.String id)
SingleCDockable
.isMultiId(String)
.
id
- some identifier
SingleCDockable
boolean isSingleId(java.lang.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
java.lang.String singleToNormalId(java.lang.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)
.
java.lang.String toMultiId(java.lang.String id)
MultipleCDockable
.isSingleId(String)
.
id
- some identifier
MultipleCDockable
boolean isMultiId(java.lang.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
java.lang.String multiToNormalId(java.lang.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 |