Package com.marcosavard.commons.types

Class Color

java.lang.Object

com.marcosavard.commons.types.Color

All Implemented Interfaces:

java.io.Serializable

public class Color
extends java.lang.Object
implements java.io.Serializable

Define a color in term of RGB (Red, Green and Blue) components. Provide method to blend colors, to calculate contrast of colors, to compute hue of a color, saturation and luminence of colors. This class is purely mathematical, thus it can be used in an environment like GWT (Google Widget Toolkit), where imports of AWT or Swing library is prohibited.

Author:

Marco

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Color.Hue

Field Summary

Fields

Modifier and Type	Field	Description
static Color	BLACK
static Color	WHITE

Constructor Summary

Constructors

Constructor	Description
Color(int colorCode)
Color(int r, int g, int b)
Color(int red, int green, int blue, double alpha)	Create a color based on Red, Green, Blue and Alpha channel.
Color(java.lang.String rgb)

Method Summary

Modifier and Type	Method	Description
Color	blendWith(Color otherColor)
Color	blendWith(Color thatColor, int thatPercent)	Blend this color with that color
Color	brighter()
Color	brighter(double factor)	Build a color brighter from a given color
double	constrastWith(Color thatColor)	Return the contrast (from 0.0 to 1.0) with that color
static Color	createFromHsl(int hue, int saturation, int lightness)	Create a color, from HSB instead of RGB values
Color	darker()
Color	darker(double factor)	Build a color darker from a given color
boolean	equals(java.lang.Object o)
static Color	fromString(java.lang.String value)	Converts a string formatted as #ff00ff to a Color instance.
int	getBlue()
int	getBrightness()	Get brightness
float[]	getCMYK()	Convert RGB to CMYK values.
Color	getComplimentaryColor()	Return the complimentary color.
Color	getContrastColor()	Return black or white, depending which color gives the highest contrast.
Color	getGrayscale()	Return the grayscale of a color.
int	getGreen()
java.lang.String	getHexCode()
int	getHue()	Get the hue of a color.
Color.Hue	getHueCode()
int	getRed()
int	getSaturation()	Get saturation
int	getValue()
int	hashCode()
float[]	toHSB()	Convert RGB components to HSB (hue, saturation, brightness)
java.lang.String	toRGBAString()	Represents a color as a RGBA string, that can be used in HTML.
java.lang.String	toRGBString()	Represents a color as a RGB string, that can be used in HTML.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

WHITE

public static final Color WHITE

BLACK

public static final Color BLACK

Constructor Detail

Color

public Color(int red,
             int green,
             int blue,
             double alpha)

Create a color based on Red, Green, Blue and Alpha channel.

Parameters:

red - in the range 0..255

green - in the range 0..255

blue - in the range 0..255

alpha - in the range 0.0 1.0 (default value 1.0)

Color

public Color(int r,
             int g,
             int b)

Color

public Color(int colorCode)

Color

public Color(java.lang.String rgb)

Method Detail

getRed

public int getRed()

getGreen

public int getGreen()

getBlue

public int getBlue()

getValue

public int getValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHexCode

public java.lang.String getHexCode()

toRGBString

public java.lang.String toRGBString()

Represents a color as a RGB string, that can be used in HTML.

Returns:

textual representation of a color

toRGBAString

public java.lang.String toRGBAString()

Represents a color as a RGBA string, that can be used in HTML.

Returns:

textual representation of a color

fromString

public static Color fromString(java.lang.String value)

Converts a string formatted as #ff00ff to a Color instance.

Parameters:

value -

Returns:

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getGrayscale

public Color getGrayscale()

Return the grayscale of a color.

Returns:

brighter

public Color brighter(double factor)

Build a color brighter from a given color

Parameters:

factor - from 1.0 to 100.0 (1.2 default)

Returns:

brighter

public Color brighter()

darker

public Color darker(double factor)

Build a color darker from a given color

Parameters:

factor - from 1.0 to 100.0 (1.2 default)

Returns:

darker

public Color darker()

constrastWith

public double constrastWith(Color thatColor)

Return the contrast (from 0.0 to 1.0) with that color

Parameters:

thatColor -

Returns:

contrast from 0.0 (no contrast) and 1.0 (full contrast)

getContrastColor

public Color getContrastColor()

Return black or white, depending which color gives the highest contrast. For instance, yellow.getContrastColor() gives black, while darkBlue.getContrastColor() gives white.

Returns:

Black or white

getComplimentaryColor

public Color getComplimentaryColor()

Return the complimentary color. For instance getComplimentaryColor(black) returns white.

Returns:

complimentary color.

blendWith

public Color blendWith(Color thatColor,
                       int thatPercent)

Blend this color with that color

Parameters:

thatColor - the color to blend with

thatPercent - the percentage of the color to blend (default value : 50)

Returns:

blended color

blendWith

public Color blendWith(Color otherColor)

toHSB

public float[] toHSB()

Convert RGB components to HSB (hue, saturation, brightness)

Returns:

array of 3 numbers, representing the hue, saturation and brightness

getHue

public int getHue()

Get the hue of a color. Hue varies from red (0.0), green (120.0), ble (240.0) and red again (360.0).

Returns:

a number from 0.0 (red) to 360.0 (red)

getSaturation

public int getSaturation()

Get saturation

Returns:

saturation

getBrightness

public int getBrightness()

Get brightness

Returns:

brightness

getCMYK

public float[] getCMYK()

Convert RGB to CMYK values. C is for cyan, M for magenta, Y for yellow.

Returns:

array of four numbers representing CMYK values

createFromHsl

public static Color createFromHsl(int hue,
                                  int saturation,
                                  int lightness)

Create a color, from HSB instead of RGB values

Parameters:

hue -

saturation -

lightness -

Returns:

getHueCode

public Color.Hue getHueCode()