eu.webtoolkit.jwt
Class WColor

java.lang.Object
  eu.webtoolkit.jwt.WColor

public class WColor
extends java.lang.Object

A class that specifies a color. A color corresponds to a CSS color. You can specify a color either using its red/green/blue components, or from a valid CSS name. The color supports an alpha channel, which determines the degree of transparency. An alpha value of 0 is completely transparent (and thus invisible), while a value of 255 is completely opaque.

Field Summary

static WColor	black Black WColor object.
static WColor	blue Blue WColor object.
static WColor	cyan Cyan WColor object.
static WColor	darkBlue Dark blue WColor object.
static WColor	darkCyan Dark cyan WColor object.
static WColor	darkGray Dark gray WColor object.
static WColor	darkGreen Dark green WColor object.
static WColor	darkMagenta Dark magenta WColor object.
static WColor	darkRed Dark red WColor object.
static WColor	darkYellow Dark yellow WColor object.
static WColor	gray Gray WColor object.
static WColor	green Green WColor object.
static WColor	lightGray Light gray WColor object.
static WColor	magenta White Magenta object.
static WColor	red Red WColor object.
static WColor	transparent Transparant WColor object.
static WColor	white White WColor object.
static WColor	yellow Yellow WColor object.

Constructor Summary

WColor()
Construct a default color.

WColor(java.lang.CharSequence name)
Construct a color from a CSS name.

WColor(int r, int g, int b)
Construct a color with given red/green/blue components.

WColor(int r, int g, int b, int a)
Construct a color with given red/green/blue/alpha components.

Method Summary

boolean	equals(WColor other) Indicates whether some other object is "equal to" this one.
int	getAlpha() Returns the alpha component.
int	getBlue() Returns the blue component.
int	getGreen() Returns the green component.
WString	getName() Get CSS name.
int	getRed() Returns the red component.
boolean	isDefault() Returns if the color is the default color.
void	setName(java.lang.CharSequence name) Set the CSS name.
void	setRgb(int red, int green, int blue) Set the red/green/blue components and a 255 for the alpha component.
void	setRgb(int red, int green, int blue, int alpha) Set the red/green/blue/alpha components.

Methods inherited from class java.lang.Object

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

Field Detail

white

public static WColor white

White WColor object.

black

public static WColor black

Black WColor object.

red

public static WColor red

Red WColor object.

darkRed

public static WColor darkRed

Dark red WColor object.

green

public static WColor green

Green WColor object.

darkGreen

public static WColor darkGreen

Dark green WColor object.

blue

public static WColor blue

Blue WColor object.

darkBlue

public static WColor darkBlue

Dark blue WColor object.

cyan

public static WColor cyan

Cyan WColor object.

darkCyan

public static WColor darkCyan

Dark cyan WColor object.

magenta

public static WColor magenta

White Magenta object.

darkMagenta

public static WColor darkMagenta

Dark magenta WColor object.

yellow

public static WColor yellow

Yellow WColor object.

darkYellow

public static WColor darkYellow

Dark yellow WColor object.

gray

public static WColor gray

Gray WColor object.

darkGray

public static WColor darkGray

Dark gray WColor object.

lightGray

public static WColor lightGray

Light gray WColor object.

transparent

public static WColor transparent

Transparant WColor object.

Constructor Detail

WColor

public WColor()

Construct a default color. The default color is depending on the context, another color (for example from a hierarchical parent in a widget tree), or a completely transparent color.

WColor

public WColor(int r,
              int g,
              int b,
              int a)

Construct a color with given red/green/blue/alpha components. All four components must be specified with a value in the range (0 - 255). The alpha channel determines the degree of transparency. An alpha value of 0 is completely transparent (and thus invisible), while a value of 255 is completely opaque.

See Also:

setRgb(int red, int green, int blue, int alpha)

WColor

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

Construct a color with given red/green/blue components. All three components must be specified with a value in the range (0 - 255). The alpha channel is defaulted to completely opaque (255).

See Also:

setRgb(int, int, int)

WColor

public WColor(java.lang.CharSequence name)

Construct a color from a CSS name. The name may be any valid CSS color name, including names colors such as "aqua", or colors defined as RGB components.

In either case, the result of the methods getRed(), getGreen() and getBlue() is undefined.

See also http://www.w3.org/TR/REC-CSS2/syndata.html#value-def-color

Method Detail

setRgb

public void setRgb(int red,
                   int green,
                   int blue,
                   int alpha)

Set the red/green/blue/alpha components. All four components must be specified with a value in the range (0 - 255). The alpha channel determines the degree of transparency. An alpha value of 0 is completely transparent (and thus invisible), while a value of 255 is completely opaque.

setRgb

public final void setRgb(int red,
                         int green,
                         int blue)

Set the red/green/blue components and a 255 for the alpha component.

See Also:

setRgb(int, int, int, int)

setName

public void setName(java.lang.CharSequence name)

Set the CSS name. The name may be any valid CSS color name, including names colors such as "aqua", or colors defined as RGB components.

In either case, the result of the methods getRed(), getGreen() and getBlue() is undefined.

See also http://www.w3.org/TR/REC-CSS2/syndata.html#value-def-color

isDefault

public boolean isDefault()

Returns if the color is the default color.

See Also:

WColor()

getRed

public int getRed()

Returns the red component. Only available when the color was specified in terms of the RGB components using setRgb(int, int, int, int) or WColor(int, int, int, int).

getGreen

public int getGreen()

Returns the green component. Only available when the color was specified in terms of the RGB components using setRgb(int, int, int, int) or WColor(int, int, int, int).

getBlue

public int getBlue()

Returns the blue component. Only available when the color was specified in terms of the RGB components using setRgb(int, int, int, int) or WColor(int, int, int, int).

getAlpha

public int getAlpha()

Returns the alpha component. Only available when the color was specified in terms of the RGB components using setRgb(int, int, int, int) or WColor(int, int, int, int).

getName

public WString getName()

Get CSS name. Only available when it was set with setName(CharSequence name) or WColor(CharSequence name).

equals

public boolean equals(WColor other)

Indicates whether some other object is "equal to" this one. Returns true if the two colors were defined in exactly the same way. It may return false although they actually represent the same color.