Package com.intellij.openapi.editor.impl

Class ColorProvider

java.lang.Object

com.intellij.openapi.editor.impl.ColorProvider

public abstract class ColorProvider
extends java.lang.Object

Defines common contract for target Color retrieving.

Constructor Summary

Constructors

Constructor and Description
ColorProvider()

Method Summary

Modifier and Type	Method and Description
static ColorProvider	byColor(java.awt.Color color) Factory method for creating color holder that always returns given Color object.
static ColorProvider	byColorScheme(Editor editor, ColorKey... keys) Shortcut for calling byColorsScheme(EditorColorsScheme, ColorKey...) with colors scheme retrieved from the given editor.
static ColorProvider	byColorsScheme(EditorColorsScheme scheme, ColorKey... keys) Factory method for creating color holder that delegates target color retrieval to the given colors scheme.
abstract java.awt.Color	getColor()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorProvider

public ColorProvider()

Method Detail

getColor

public abstract java.awt.Color getColor()

Returns:

target Color object managed by the current holder

byColor

public static ColorProvider byColor(java.awt.Color color)

Factory method for creating color holder that always returns given Color object.

Parameters:

color - target color to use

Returns:

color holder that uses given color all the time

byColorScheme

public static ColorProvider byColorScheme(Editor editor,
                                          ColorKey... keys)

Shortcut for calling byColorsScheme(EditorColorsScheme, ColorKey...) with colors scheme retrieved from the given editor.

Parameters:

editor - target colors scheme holder

keys - target color identifiers

Returns:

color holder that delegates target color retrieval to the colors scheme associated with the given editor using given color keys

byColorsScheme

public static ColorProvider byColorsScheme(EditorColorsScheme scheme,
                                           ColorKey... keys)

Factory method for creating color holder that delegates target color retrieval to the given colors scheme. It checks if particular color key has a value at the given scheme and falls back to the next key if any (i.e. the order of given arguments is significant).

There is a possible case that there are no colors for all of the given color keys - default color is used then.

Parameters:

scheme - target colors scheme to use

keys - target color identifiers

Returns:

color holder that delegates target color retrieval to the given colors scheme using given color keys