bibliothek.gui.dock.themes
Interface ColorScheme

All Known Implementing Classes:

BasicColorScheme, BubbleColorScheme, DefaultColorScheme, EclipseColorScheme, ExtendingColorScheme, FlatColorScheme, IdentifiedColorScheme, SimpleBubbleColorScheme

@Todo(priority=MAJOR,
      compatibility=BREAK_MINOR,
      target=VERSION_1_1_0,
      description="The ColorManager should know of ColorSchemes, the method \'transmitAll\' will be removed")
public interface ColorScheme

A ColorScheme is a collection of colors and bridges.
Warning: This interface will be replaced in version 1.1.0.

Author:

Benjamin Sigg

Field Summary

static String	COLOR_SCHEME_PARAMETER A parameter linking to the ColorScheme that requests this extension.
static Path	EXTENSION_NAME The name used in a ExtensionName to ask for an additional ColorScheme.

Method Summary

ColorBridgeFactory	getBridgeFactory(Path kind) Searches for a factory for a bridge that can be used for a specific kind of DockColor.
Color	getColor(String id) Searches for a color that can be used for the identifier id.
void	transmitAll(Priority priority, ColorManager manager) Transmits all values in this scheme to manager.
boolean	updateUI() Called when the LookAndFeel or a color of the LookAndFeelColors changed and this scheme perhaps needs to update its colors.

Field Detail

EXTENSION_NAME

static final Path EXTENSION_NAME

The name used in a ExtensionName to ask for an additional ColorScheme. The additional ColorSchemes will be applied after the standard scheme was applied. This means that any setting of the base ColorScheme is overridden, including those settings made by the user. Extensions should provide a mechanism such that the user can change the extension-colors.

COLOR_SCHEME_PARAMETER

static final String COLOR_SCHEME_PARAMETER

A parameter linking to the ColorScheme that requests this extension.

See Also:

Constant Field Values

Method Detail

getColor

Color getColor(String id)

Searches for a color that can be used for the identifier id.

Parameters:

id - an identifier of some color

Returns:

some color or null

getBridgeFactory

ColorBridgeFactory getBridgeFactory(Path kind)

Searches for a factory for a bridge that can be used for a specific kind of DockColor.

Parameters:

kind - the kind of color the provider should support

Returns:

some a factory for a bridge or null

transmitAll

void transmitAll(Priority priority,
                 ColorManager manager)

Transmits all values in this scheme to manager.

Parameters:

priority - the priority to use when registering colors and providers.

manager - the manager to fill

updateUI

boolean updateUI()

Called when the LookAndFeel or a color of the LookAndFeelColors changed and this scheme perhaps needs to update its colors.

Returns:

true if anything changed, false if this scheme was not changed.