bibliothek.gui.dock.component

Interface DockComponentManager

All Known Implementing Classes:

DefaultDockComponentManager

public interface DockComponentManager

Collects and manages the DockComponentRoots of one DockController.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(Filter<DockComponentRoot> filter, DockComponentConfiguration configuration) Adds a new configuration, the configuration is only applied if filter includes a DockComponentRoot, and if no other configuration was applied
void	register(DockComponentRoot root) Adds root to the list of known DockComponentRoots, informs all listeners and applies a configuration to root.
void	removeConfiguration(DockComponentConfiguration configuration) Removes configuration from the list of configurations.
void	setDefaultConfiguration(DockComponentConfiguration configuration) Sets the default configuration which is to be used if no other configuration is found.
void	unregister(DockComponentRoot root) Removes root from the list of known DockComponentRoots.

Method Detail

setDefaultConfiguration

void setDefaultConfiguration(DockComponentConfiguration configuration)

Sets the default configuration which is to be used if no other configuration is found.

Parameters:

configuration - the default configuration, may be null

addConfiguration

void addConfiguration(Filter<DockComponentRoot> filter,
                      DockComponentConfiguration configuration)

Adds a new configuration, the configuration is only applied if filter includes a DockComponentRoot, and if no other configuration was applied

Parameters:

filter - the condition telling where to apply the configuration, not null

configuration - the new configuration, not null

removeConfiguration

void removeConfiguration(DockComponentConfiguration configuration)

Removes configuration from the list of configurations. If configuration was added more than once, then only the first occurrence will be removed.

Parameters:

configuration - the configuration that should no longer be applied

register

void register(DockComponentRoot root)

Adds root to the list of known DockComponentRoots, informs all listeners and applies a configuration to root.

Parameters:

root - the new root, not null

unregister

void unregister(DockComponentRoot root)

Removes root from the list of known DockComponentRoots.

Parameters:

root - the root to remove