bibliothek.gui.dock.common
Interface CControlRegister

All Known Subinterfaces:

MutableCControlRegister

All Known Implementing Classes:

DefaultCControlRegister

public interface CControlRegister

Grants access to the CDockables and other information that is associated with a CControl.

Author:

Benjamin Sigg

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 CDockables that are registered.
java.util.List<CDockable>	getDockables() Gets an unmodifiable list of all CDockables which are known to this register.
java.util.Map<java.lang.String,MultipleCDockableFactory<?,?>>	getFactories() Gets an unmodifiable map of all MultipleCDockableFactorys 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 MultipleCDockables which are known to this register.
java.util.List<SingleCDockable>	getSingleDockables() Gets an unmodifiable list of all SingleCDockables which are known to this register.
java.util.List<CStation<?>>	getStations() Gets an unmodifiable list of all CStations 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 CDockables in the given mode.
java.util.Set<java.lang.String>	listMultipleDockableFactories() Gets a list of identifiers of all MultipleCDockableFactorys which are currently registered.
java.util.List<MultipleCDockable>	listMultipleDockables(MultipleCDockableFactory<?,?> factory) Gets a list of all MultipleCDockables 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 SingleCDockableFactorys 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

getControl

CControl getControl()

Gets the control for which this register is used.

Returns:

the control

getDockableCount

int getDockableCount()

Gets the number of CDockables that are registered.

Returns:

the number of dockables

getDockable

CDockable getDockable(int index)

Gets the index'th dockable that is registered

Parameters:

index - the index of the element

Returns:

the selected dockable

getDockables

java.util.List<CDockable> getDockables()

Gets an unmodifiable list of all CDockables which are known to this register. The list might or might not be updated when the contents of this register changes.

Returns:

an unmodifiable list of elements

getSingleDockables

java.util.List<SingleCDockable> getSingleDockables()

Gets an unmodifiable list of all SingleCDockables which are known to this register. The list might or might not be updated when the contents of this register changes.

Returns:

an unmodifiable list of elements

getMultipleDockables

java.util.List<MultipleCDockable> getMultipleDockables()

Gets an unmodifiable list of all MultipleCDockables which are known to this register. The list might or might not be updated when the contents of this register change.

Returns:

an unmodifiable list of elements

getStations

java.util.List<CStation<?>> getStations()

Gets an unmodifiable list of all CStations which are known to this register. The list might or might not be updated when the content of this register changes.

Returns:

an unmodifiable list of elements

getFactories

java.util.Map<java.lang.String,MultipleCDockableFactory<?,?>> getFactories()

Gets an unmodifiable map of all MultipleCDockableFactorys that are known to this register. The map may or may not be updated when the content of this register changes.

Returns:

the unmodifiable map of factories

getFactory

MultipleCDockableFactory<?,?> getFactory(java.lang.String id)

Searches the factory with identifier id.

Parameters:

id - the id of the factory

Returns:

the factory or null

listSingleBackupFactories

java.util.Set<java.lang.String> listSingleBackupFactories()

Gets a list of keys for all SingleCDockableFactorys which are currently registered.

Returns:

the list of keys

listMultipleDockableFactories

java.util.Set<java.lang.String> listMultipleDockableFactories()

Gets a list of identifiers of all MultipleCDockableFactorys which are currently registered.

Returns:

the list of factories

listMultipleDockables

java.util.List<MultipleCDockable> listMultipleDockables(MultipleCDockableFactory<?,?> factory)

Gets a list of all MultipleCDockables that are registered at this control and whose MultipleCDockable.getFactory() method returns factory.

Parameters:

factory - the factory to look out for

Returns:

the list of dockables, never null but might be empty

listDockablesInMode

java.util.List<CDockable> listDockablesInMode(ExtendedMode mode)

Gets a list of all visible CDockables in the given mode.

Parameters:

mode - the mode which each CDockable must have

Returns:

the list of CDockables

listSingleDockables

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.

Returns:

the list of ids, never null

toSingleId

java.lang.String toSingleId(java.lang.String id)

Transforms an identifier to an identifier for a SingleCDockable.
Note that this method must never create an identifier that passes isMultiId(String).

Parameters:

id - some identifier

Returns:

an identifier marked as being for a SingleCDockable

isSingleId

boolean isSingleId(java.lang.String id)

Checks whether id could be created by toSingleId(String).

Parameters:

id - the id to check

Returns:

true if there is an input for toSingleId(String) that would result in id

singleToNormalId

java.lang.String singleToNormalId(java.lang.String id)

Undoes the changes of 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.

Parameters:

id - some id create by toSingleId(String).

Returns:

the original id

toMultiId

java.lang.String toMultiId(java.lang.String id)

Transforms an identifier to an identifier for a MultipleCDockable.
Note that this method must never create an identifier that passes isSingleId(String).

Parameters:

id - some identifier

Returns:

an identifier marked as being for a MultipleCDockable

isMultiId

boolean isMultiId(java.lang.String id)

Checks whether id could be created by toMultiId(String).

Parameters:

id - the id to check

Returns:

true if there is an input for toMultiId(String) that would result in id

multiToNormalId

java.lang.String multiToNormalId(java.lang.String id)

Undoes the changes of 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.

Parameters:

id - some id create by toMultiId(String).

Returns:

the original id