com.communote.common.util

Class ColorUtils

java.lang.Object

com.communote.common.util.ColorUtils

public class ColorUtils
extends Object

Utility for converting color strings to Color objects.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static Color	decodeRGB(String colorString) Decode a string with an RGB color into a Color object.
static Color	decodeRGBSilently(String colorString) Like decodeRGB(String) but does not throw an exception if the color cannot be parsed.
static String	encodeRGBHexString(Color color, boolean withAlpha) Create a string representation of the color in the format #RRGGBB or #RRGGBBAA if withAlpha is true.
static String	encodeRGBIntString(Color color, boolean withAlpha) Create a string of the integer values of the RGB components of the color.

Methods inherited from class java.lang.Object

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

Method Detail

decodeRGB

public static Color decodeRGB(String colorString)

Decode a string with an RGB color into a Color object. If the color cannot be decoded an IllegalArgumentException will be thrown.

Parameters:

colorString - the string to decode. Supported formats are hex and integer notations. The hex notation has to have the format #RRGGBB or #RRGGBBAA with an alpha channel. The integer notation has to have the format R,G,B or R,G,B,A with an alpha channel and values of the components have to be in the range 0-255.

Returns:

the color

decodeRGBSilently

public static Color decodeRGBSilently(String colorString)

Like decodeRGB(String) but does not throw an exception if the color cannot be parsed.

Parameters:

colorString - the string to decode

Returns:

the color or null if the color cannot be parsed

encodeRGBHexString

public static String encodeRGBHexString(Color color,
                                        boolean withAlpha)

Create a string representation of the color in the format #RRGGBB or #RRGGBBAA if withAlpha is true. The RR is the 2 byte hex value of the red component of the color.

Parameters:

color - the color to encode

withAlpha - whether to include the alpha value in the result

Returns:

the string or null if color was null

encodeRGBIntString

public static String encodeRGBIntString(Color color,
                                        boolean withAlpha)

Create a string of the integer values of the RGB components of the color. The components are separated by comma.

Parameters:

color - the color to encode

withAlpha - whether the alpha value should be appended

Returns:

the string or null if color was null