bibliothek.gui.dock.station.screen.window

Class DefaultScreenDockWindowConfiguration

java.lang.Object

bibliothek.gui.dock.station.screen.window.DefaultScreenDockWindowConfiguration

All Implemented Interfaces:

ScreenDockWindowConfiguration

public class DefaultScreenDockWindowConfiguration
extends Object
implements ScreenDockWindowConfiguration

The default implementation of ScreenDockWindowConfiguration always returns null from its getConfiguration(ScreenDockStation, Dockable) method, thus telling the ScreenDockStation to use a default configuration.
This configuration offers an extension point, any configuration added through that point will be asked first for a configuration before returning the default value.

Author:

Benjamin Sigg

Field Summary

Fields

Modifier and Type	Field and Description
static Path	CONFIGURATION_EXTENSION name of an ExtensionName for adding additional ScreenDockWindowConfigurations
static String	CONFIGURATION_EXTENSION_PARAM a parameter pointing to this.

Constructor Summary

Constructors

Constructor and Description
DefaultScreenDockWindowConfiguration(DockController controller) Creates a new configuration.

Method Summary

Modifier and Type	Method and Description
WindowConfiguration	getConfiguration(ScreenDockStation station, Dockable dockable) Creates a new configuration for a ScreenDockWindow that is going to show dockable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIGURATION_EXTENSION

public static final Path CONFIGURATION_EXTENSION

name of an ExtensionName for adding additional ScreenDockWindowConfigurations

CONFIGURATION_EXTENSION_PARAM

public static final String CONFIGURATION_EXTENSION_PARAM

a parameter pointing to this.

See Also:

Constant Field Values

Constructor Detail

DefaultScreenDockWindowConfiguration

public DefaultScreenDockWindowConfiguration(DockController controller)

Creates a new configuration.

Parameters:

controller - used to load extension, can be null

Method Detail

getConfiguration

public WindowConfiguration getConfiguration(ScreenDockStation station,
                                            Dockable dockable)

Description copied from interface: ScreenDockWindowConfiguration

Creates a new configuration for a ScreenDockWindow that is going to show dockable. This configuration is only used to set up the new ScreenDockWindow, any further modifications will not affect the window. A ScreenDockWindowFactory or a ScreenDockWindow might ignore some parts or the entire configuration, although the default implementations all try to follow the configuration.

Specified by:

getConfiguration in interface ScreenDockWindowConfiguration

Parameters:

station - the future or current parent of dockable

dockable - the element which is going to be shown

Returns:

the new configuration, or null if a default configuration should be used