Package de.xima.fc.color

Class CssColor

java.lang.Object

de.xima.fc.color.CssColor

All Implemented Interfaces:

Serializable

@Immutable
public final class CssColor
extends Object
implements Serializable

A CSS color value, with optional transparency. Has got some utility methods to create a color from a CSS color string, and to convert the color to different CSS representation. An instance of this class is immutable.

 CssColor.valueOf("#ff0000");
 CssColor.valueOf("orange");
 

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CssColor(double red, double green, double blue, double alpha)	A new CSS color with the given red, green, blue, and alpha channel.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
double	getAlpha()
double	getBlue()
double	getGreen()
double	getRed()
boolean	hasAlpha()
int	hashCode()
boolean	isTransparent()
double	norm1(CssColor other)
static CssColor	ofHex(long hexCode)
static CssColor	ofHex(String hexCode, CssColor defaultColor)
static CssColor	ofRgb(double red, double green, double blue)
static CssColor	ofRgb(int red, int green, int blue)
static CssColor	ofRgb(long red, long green, long blue)
static CssColor	ofRgb(String rgba, CssColor defaultColor)
static CssColor	ofRgba(double red, double green, double blue, double alpha)
static CssColor	ofRgba(int red, int green, int blue, double alpha)
static CssColor	ofRgba(int red, int green, int blue, int alpha)
static CssColor	ofRgba(long red, long green, long blue, double alpha)
static CssColor	ofRgba(long red, long green, long blue, long alpha)
static CssColor	ofRgba(String rgba, CssColor defaultColor)
static CssColor	ofRgbOrRgba(String hexCode, CssColor defaultColor)
String	toClosestColorName()
String	toCssString()	Converts this color to a valid CSS color string.
String	toHexString()
String	toHexString(boolean withHashTag)
String	toNameOrHexOrRgba(double precision)
String	toRgbaOrHexString()
RgbaQuadruplet	toRgbaQuadruplet()
String	toRgbaString()
RgbTriplet	toRgbTripel()
String	toString()
static CssColor	valueOf(String color)
static CssColor	valueOf(String color, CssColor defaultColor)
static CssColor	valueOf(String color, ENamedCssColor defaultColor)
CssColor	withAlpha(double alpha)

Methods inherited from class java.lang.Object

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

Constructor Detail

CssColor

public CssColor(double red,
                double green,
                double blue,
                double alpha)

A new CSS color with the given red, green, blue, and alpha channel.

Parameters:

red - Red channel, 0 to 1.

green - Green channel, 0 to 1.

blue - Blue channel, 0 to 1.

alpha - Alpha channel, 0 to 1.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAlpha

public double getAlpha()

Returns:

The alpha component of the color.

getBlue

public double getBlue()

Returns:

The blue component of the color.

getGreen

public double getGreen()

Returns:

The green component of the color.

getRed

public double getRed()

Returns:

The red component of the color.

hasAlpha

public boolean hasAlpha()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isTransparent

public boolean isTransparent()

Returns:

Whether this color has any transparency.

norm1

public double norm1(CssColor other)

Parameters:

other - Another color.

Returns:

1-norm between this and the other color.

toClosestColorName

public String toClosestColorName()

Returns:

The CSS color name that is closest to this color.

toCssString

public String toCssString()

Converts this color to a valid CSS color string. If this color is close to a named color, that color is returned. The returned string can be used in CSS color properties.

Returns:

This color as a CSS color string.

toHexString

public String toHexString()

Returns:

A hex string of this color, such as #ff00ff.

toHexString

public String toHexString(boolean withHashTag)

Parameters:

withHashTag - If true, prepends the # hash tag.

Returns:

A hex string of this color, such as #ff00ff.

toNameOrHexOrRgba

public String toNameOrHexOrRgba(double precision)

Parameters:

precision - How close a named or hex color must lie to be considered valid.

Returns:

Converts this color to a CSS color name, if one is close to this color. Otherwise, converts to a #ff00ff hex string if one is close to this color. Otherwise, returns a rgba(0,2.5,4} RGB(A) CSS color.

toRgbaOrHexString

public String toRgbaOrHexString()

Returns:

Converts this color to a #ff00ff hex string if one is close to this color. Otherwise, returns a rgba(0,2.5,4) RGB(A) CSS color.

toRgbaString

public String toRgbaString()

Returns:

Converts this color to a rgba(0,2.5,4) RGB(A) CSS color.

toRgbTripel

public RgbTriplet toRgbTripel()

toRgbaQuadruplet

public RgbaQuadruplet toRgbaQuadruplet()

toString

public String toString()

Overrides:

toString in class Object

withAlpha

public CssColor withAlpha(double alpha)

Parameters:

alpha - New alpha value.

Returns:

This color, with the new alpha value.

ofHex

public static CssColor ofHex(long hexCode)

Parameters:

hexCode - Hex code to parse.

Returns:

The parsed CSS color.

ofHex

public static CssColor ofHex(String hexCode,
                             CssColor defaultColor)

Parameters:

hexCode - Hex code to parse.

defaultColor - Default color if hex code is invalid.

Returns:

The parsed CSS color.

ofRgb

public static CssColor ofRgb(double red,
                             double green,
                             double blue)

Parameters:

red - Red component, in the range [0,1].

green - Green component, in the range [0,1].

blue - Blue component, in the range [0,1].

Returns:

An immutable CSS color for the given values.

ofRgb

public static CssColor ofRgb(int red,
                             int green,
                             int blue)

Parameters:

red - Red component, in the range [0,255].

green - Green component, in the range [0,255].

blue - Blue component, in the range [0,255].

Returns:

An immutable CSS color for the given values.

ofRgb

public static CssColor ofRgb(long red,
                             long green,
                             long blue)

Parameters:

red - Red component, in the range [0,255].

green - Green component, in the range [0,255].

blue - Blue component, in the range [0,255].

Returns:

An immutable CSS color for the given values.

ofRgb

public static CssColor ofRgb(String rgba,
                             CssColor defaultColor)

ofRgba

public static CssColor ofRgba(int red,
                              int green,
                              int blue,
                              double alpha)

Parameters:

red - Red component, in the range [0,255].

green - Green component, in the range [0,255].

blue - Blue component, in the range [0,255].

alpha - Alpha component, in the range [0,1]. 0 is fully transparent.

Returns:

An immutable CSS color for the given values.

ofRgba

public static CssColor ofRgba(double red,
                              double green,
                              double blue,
                              double alpha)

Parameters:

red - Red component, in the range [0,1].

green - Green component, in the range [0,1].

blue - Blue component, in the range [0,1].

alpha - Alpha component, in the range [0,1]. 0 is fully transparent.

Returns:

An immutable CSS color for the given values.

ofRgba

public static CssColor ofRgba(long red,
                              long green,
                              long blue,
                              double alpha)

Parameters:

red - Red component, in the range [0,255].

green - Green component, in the range [0,255].

blue - Blue component, in the range [0,255].

alpha - Alpha component, in the range [0,1]. 0 is fully transparent.

Returns:

An immutable CSS color for the given values.

ofRgba

public static CssColor ofRgba(int red,
                              int green,
                              int blue,
                              int alpha)

Parameters:

red - Red component, in the range [0,255].

green - Green component, in the range [0,255].

blue - Blue component, in the range [0,255].

alpha - Alpha component, in the range [0,255]. 0 is fully transparent.

Returns:

An immutable CSS color for the given values.

ofRgba

public static CssColor ofRgba(long red,
                              long green,
                              long blue,
                              long alpha)

Parameters:

red - Red component, in the range [0,255].

green - Green component, in the range [0,255].

blue - Blue component, in the range [0,255].

alpha - Alpha component, in the range [0,255]. 0 is fully transparent.

Returns:

An immutable CSS color for the given values.

ofRgba

public static CssColor ofRgba(String rgba,
                              CssColor defaultColor)

ofRgbOrRgba

public static CssColor ofRgbOrRgba(String hexCode,
                                   CssColor defaultColor)

valueOf

public static CssColor valueOf(String color)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

valueOf

public static CssColor valueOf(String color,
                               CssColor defaultColor)

valueOf

public static CssColor valueOf(String color,
                               ENamedCssColor defaultColor)