Package de.xima.fc.color

Class ColorField<T extends Serializable>

java.lang.Object

de.xima.fc.color.ColorField<T>

Type Parameters:

T - Type of the property value.

All Implemented Interfaces:

IColorField<T>, Serializable, Comparable<IColorField<?>>

@Immutable
public class ColorField<T extends Serializable>
extends Object
implements IColorField<T>

List of common IColorFields.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ColorField.Identifier	Constants with the IColorField.getIdentifier() values for the ColorFields.

Field Summary

Fields

Modifier and Type	Field	Description
static final IColorField<CssColor>	CSS_COLOR	CSS property for the color, such as red or #ac3300.
static final IColorField<CssColor>	CSS_COLOR_MATCHING_TEXT	CSS property for the color matching the the background, such as red or #ac3300.
static final IColorField<Integer>	HSLUV_COMPONENT_HUE	The hue component of a HSLuv color (0 to 360).
static final IColorField<Integer>	HSLUV_COMPONENT_LIGHTNESS	The lightness component of a HSLuv color (0 to 100).
static final IColorField<Integer>	HSLUV_COMPONENT_SATURATION	The saturation component of a HSLuv color (0 to 100).
static final IColorField<HslUvTriplet>	HSLUV_TRIPLET	The HSLuv compoments of the color.
static final IColorField<Integer>	HSV_COMPONENT_HUE	The hue component of the HSV value of the color (0 to 360).
static final IColorField<Integer>	HSV_COMPONENT_SATURATION	The saturation component of the HSV value of the color (0 to 00).
static final IColorField<Integer>	HSV_COMPONENT_VALUE	The value component of the HSV value of the color (0 to 100).
static final IColorField<HsvTriplet>	HSV_TRIPLET	The RGB compoments of the color.
static final IColorField<Double>	LUMA_ITU_BT_601	The luminance according to Photometric/digital ITU BT.601 standard, from 0 to 1.
static final IColorField<Double>	LUMA_ITU_BT_709	The luminance according to Photometric/digital ITU BT.709 standard, from 0 to 1.
static final IColorField<Double>	OPACITY	The opacity component of the color, from 0 (transparent) to 1 (opaque).
static final IColorField<Integer>	RGB_COMPONENT_BLUE	The blue component of the RGB value of the color (0 to 255).
static final IColorField<Integer>	RGB_COMPONENT_GREEN	The green component of the RGB value of the color (0 to 255).
static final IColorField<Integer>	RGB_COMPONENT_RED	The red component of the RGB value of the color (0 to 255).
static final IColorField<RgbTriplet>	RGB_TRIPLET	The RGB compoments of the color.
static final IColorField<String>	STYLE_CLASS_BACKGROUND	CSS style class for setting the background color.
static final IColorField<String>	STYLE_CLASS_BORDER	CSS style class for setting the background color.
static final IColorField<String>	STYLE_CLASS_FILL	CSS style class for setting the fill color (SVG).
static final IColorField<String>	STYLE_CLASS_MATCHING_BORDER	CSS style class for setting the text color to a color matching the STYLE_CLASS_BACKGROUND.
static final IColorField<String>	STYLE_CLASS_MATCHING_TEXT	CSS style class for setting the text color to a color matching the STYLE_CLASS_BACKGROUND.
static final IColorField<String>	STYLE_CLASS_STROKE	CSS style class for setting the stroke color (SVG).
static final IColorField<String>	STYLE_CLASS_TEXT	CSS style class for setting the text color.
static final IColorField<Double>	TRANSPARENCY	The alpha or transparency component of the color, from 0 (opaque) to 1 (transparent).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Implementations MUST make the comparison only with respect to IColorField.getIdentifier().
String	getIdentifier()
int	hashCode()	Implementations MUST calculate the hash code only from the IColorField.getIdentifier().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.color.IColorField

compareTo, get, get, supportedBy

Field Details

CSS_COLOR

public static final IColorField<CssColor> CSS_COLOR

CSS property for the color, such as red or #ac3300.

CSS_COLOR_MATCHING_TEXT

public static final IColorField<CssColor> CSS_COLOR_MATCHING_TEXT

CSS property for the color matching the the background, such as red or #ac3300.

HSLUV_COMPONENT_HUE

public static final IColorField<Integer> HSLUV_COMPONENT_HUE

The hue component of a HSLuv color (0 to 360).

HSLUV_COMPONENT_LIGHTNESS

public static final IColorField<Integer> HSLUV_COMPONENT_LIGHTNESS

The lightness component of a HSLuv color (0 to 100).

HSLUV_COMPONENT_SATURATION

public static final IColorField<Integer> HSLUV_COMPONENT_SATURATION

The saturation component of a HSLuv color (0 to 100).

HSLUV_TRIPLET

public static final IColorField<HslUvTriplet> HSLUV_TRIPLET

The HSLuv compoments of the color.

HSV_COMPONENT_HUE

public static final IColorField<Integer> HSV_COMPONENT_HUE

The hue component of the HSV value of the color (0 to 360).

HSV_COMPONENT_SATURATION

public static final IColorField<Integer> HSV_COMPONENT_SATURATION

The saturation component of the HSV value of the color (0 to 00).

HSV_COMPONENT_VALUE

public static final IColorField<Integer> HSV_COMPONENT_VALUE

The value component of the HSV value of the color (0 to 100).

HSV_TRIPLET

public static final IColorField<HsvTriplet> HSV_TRIPLET

The RGB compoments of the color.

LUMA_ITU_BT_601

public static final IColorField<Double> LUMA_ITU_BT_601

The luminance according to Photometric/digital ITU BT.601 standard, from 0 to 1.

LUMA_ITU_BT_709

public static final IColorField<Double> LUMA_ITU_BT_709

The luminance according to Photometric/digital ITU BT.709 standard, from 0 to 1.

OPACITY

public static final IColorField<Double> OPACITY

The opacity component of the color, from 0 (transparent) to 1 (opaque).

RGB_COMPONENT_BLUE

public static final IColorField<Integer> RGB_COMPONENT_BLUE

The blue component of the RGB value of the color (0 to 255).

RGB_COMPONENT_GREEN

public static final IColorField<Integer> RGB_COMPONENT_GREEN

The green component of the RGB value of the color (0 to 255).

RGB_COMPONENT_RED

public static final IColorField<Integer> RGB_COMPONENT_RED

The red component of the RGB value of the color (0 to 255).

RGB_TRIPLET

public static final IColorField<RgbTriplet> RGB_TRIPLET

The RGB compoments of the color.

STYLE_CLASS_BACKGROUND

public static final IColorField<String> STYLE_CLASS_BACKGROUND

CSS style class for setting the background color.

STYLE_CLASS_BORDER

public static final IColorField<String> STYLE_CLASS_BORDER

CSS style class for setting the background color.

STYLE_CLASS_FILL

public static final IColorField<String> STYLE_CLASS_FILL

CSS style class for setting the fill color (SVG).

STYLE_CLASS_MATCHING_BORDER

public static final IColorField<String> STYLE_CLASS_MATCHING_BORDER

CSS style class for setting the text color to a color matching the STYLE_CLASS_BACKGROUND.

STYLE_CLASS_MATCHING_TEXT

public static final IColorField<String> STYLE_CLASS_MATCHING_TEXT

CSS style class for setting the text color to a color matching the STYLE_CLASS_BACKGROUND.

STYLE_CLASS_STROKE

public static final IColorField<String> STYLE_CLASS_STROKE

CSS style class for setting the stroke color (SVG).

STYLE_CLASS_TEXT

public static final IColorField<String> STYLE_CLASS_TEXT

CSS style class for setting the text color.

TRANSPARENCY

public static final IColorField<Double> TRANSPARENCY

The alpha or transparency component of the color, from 0 (opaque) to 1 (transparent).

Method Details

equals

public boolean equals(Object obj)

Description copied from interface: IColorField

Implementations MUST make the comparison only with respect to IColorField.getIdentifier().

Specified by:

equals in interface IColorField<T extends Serializable>

Overrides:

equals in class Object

Parameters:

obj - Other object to compare this object to.

Returns:

Whether this object equals the given object.

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IColorField<T extends Serializable>

Returns:

Unique identifier of this color field.

hashCode

public int hashCode()

Description copied from interface: IColorField

Implementations MUST calculate the hash code only from the IColorField.getIdentifier().

Specified by:

hashCode in interface IColorField<T extends Serializable>

Overrides:

hashCode in class Object

Returns:

The hash code of this object.

toString

public String toString()

Overrides:

toString in class Object