RgbaColor (gwt-traction 1.6.0 API)

java.lang.Object
- com.tractionsoftware.gwt.user.server.util.RgbaColor

```
public final class RgbaColor
extends Object
```
Represents an rgba color with HSL access. Immutable with factory methods for adjustments.

Constructor Summary

Constructors
Constructor and Description
`RgbaColor()` Creates an RgbaColor as rgba(0,0,0,1)
`RgbaColor(int r, int g, int b)` Creates an RgbaColor with alpha=1
`RgbaColor(int r, int g, int b, float a)` Creates an RgbaColor

Method Summary

Methods
Modifier and Type	Method and Description
`float`	`a()` Returns the value of the alpha component [0-1]
`RgbaColor`	`adjustHue(float degrees)` Returns a new color that has the hue adjusted by the specified amount.
`float`	`alpha()` Returns the value of the alpha component [0-1]
`protected static float`	`alphaCheck(float alpha)`
`int`	`b()` Returns the value of the blue component (0-255)
`int`	`blue()` Returns the value of the blue component [0-255]
`RgbaColor`	`complement()` Returns a new color that is the complement of this color.
`float[]`	`convertToHsl()` Returns a triple of hue [0-360), saturation [0-100], and lightness [0-100].
`RgbaColor`	`darken(float amount)` Returns a new color that has the lightness adjusted by the negative of the specified amount.
`RgbaColor`	`darkenOrLighten(float darken, float lighten)` First attempt to darken the color and if that overflows the lightness component, lighten the color.
`RgbaColor`	`desaturate(float amount)` Returns a new color that has the saturation adjusted by the negative of the specified amount.
`RgbaColor`	`desaturateOrSaturate(float desaturate, float saturate)` First attempt to desaturate the color and if that overflows the saturation component, saturate the color.
`boolean`	`equals(Object other)`
`static RgbaColor`	`from(String color)` Parses an RgbaColor from a hexadecimal, rgb, rgba, hsl, or hsla value.
`static RgbaColor`	`fromHex(String hex)` Parses an RgbaColor from a hexadecimal value.
`static RgbaColor`	`fromHsl(float[] hsl)` Convenience to get back to RGB from HSL array returned by toHSL.
`static RgbaColor`	`fromHsl(float H, float S, float L)` Creates a new RgbaColor from the specified HSL components.
`static RgbaColor`	`fromHsl(String hsl)` Parses an RgbaColor from a CSS3 HSL value, e.g.
`static RgbaColor`	`fromHsla(String hsl)` Parses an RgbaColor from a CSS3 HSLA value, e.g.
`static RgbaColor`	`fromRgb(String rgb)` Parses an RgbaColor from an rgb value.
`static RgbaColor`	`fromRgba(String rgba)` Parses an RgbaColor from an rgba value.
`int`	`g()` Returns the value of the green component (0-255)
`RgbaColor[]`	`getPaletteVaryLightness(int count)`
`protected static float[]`	`getSpreadInRange(float member, int count, int max, int offset)` Returns a spread of integers in a range [0,max) that includes count.
`RgbaColor`	`grayscale()` Returns a new color that is the grayscale equivalent of this color (with saturation = 0).
`int`	`green()` Returns the value of the green component [0-255]
`float`	`h()` Returns the value of the hue component of this color as HSL [0-360)
`int`	`hashCode()`
`float`	`hue()` Returns the value of the hue component of this color as HSL [0-360)
`protected static float`	`hueCheck(float hue)`
`RgbaColor`	`inverse()` Returns a new color that is the inverse of this color where each rgb component is subtracted from 255.
`float`	`l()` Returns the value of the lightness component of this color as HSL [0-100]
`RgbaColor`	`lighten(float amount)` Returns a new color that has the lightness adjusted by the specified amount.
`RgbaColor`	`lightenOrDarken(float lighten, float darken)` First attempt to lighten the color and if that overflows the lightness component, darken the color.
`float`	`lightness()` Returns the value of the lightness component of this color as HSL [0-100]
`RgbaColor`	`opacify(float amount)` Returns a new color that has the alpha adjusted by the specified amount.
`int`	`r()` Returns the value of the red component (0-255)
`int`	`red()` Returns the value of the red component [0-255]
`protected static int`	`rgbCheck(int rgb)`
`float`	`s()` Returns the value of the saturation component of this color as HSL [0-100]
`RgbaColor`	`saturate(float amount)` Returns a new color that has the saturation adjusted by the specified amount.
`RgbaColor`	`saturateOrDesaturate(float saturate, float desaturate)` First attempt to saturate the color and if that overflows the saturation component, desaturate the color.
`float`	`saturation()` Returns the value of the saturation component of this color as HSL [0-100]
`protected static float`	`slCheck(float sl)`
`String`	`toHex()` Returns the color in hexadecimal format (#rrggbb)
`String`	`toHsl()` Returns the CSS3 HSL representation, e.g.
`String`	`toHsla()` Returns the CSS3 HSLA representation, e.g.
`String`	`toRgb()` Returns the color in rgb format, e.g.
`String`	`toRgba()` Returns the color in rgba format, e.g.
`String`	`toString()`
`RgbaColor`	`transparentize(float amount)` Returns a new color that has the alpha adjusted by the specified amount.
`RgbaColor`	`withAlpha(float alpha)` Returns a new RgbaColor with the alpha component set to the specified value.
`RgbaColor`	`withBlue(int blue)` Returns a new RgbaColor with the blue component set to the specified value.
`RgbaColor`	`withGreen(int green)` Returns a new RgbaColor with the green component set to the specified value.
`RgbaColor`	`withHue(float hue)` Returns a new RgbaColor with the hue component set to the specified value.
`RgbaColor`	`withLightness(float lightness)` Returns a new RgbaColor with the lightness component set to the specified value.
`RgbaColor`	`withRed(int red)` Returns a new RgbaColor with the red component set to the specified value.
`RgbaColor`	`withSaturation(float saturation)` Returns a new RgbaColor with the saturation component set to the specified value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RgbaColor
```
public RgbaColor()
```
    Creates an RgbaColor as rgba(0,0,0,1)
  - RgbaColor
```
public RgbaColor(int r,
         int g,
         int b)
```
    Creates an RgbaColor with alpha=1
    
    Parameters:
    r - the red component [0-255]
    g - the green component [0-255]
    b - the blue component [0-255]
  - RgbaColor
```
public RgbaColor(int r,
         int g,
         int b,
         float a)
```
    Creates an RgbaColor
    
    Parameters:
    r - the red component [0-255]
    g - the green component [0-255]
    b - the blue component [0-255]
    a - the alpha component [0-1]
- Method Detail
  - from
```
public static RgbaColor from(String color)
```
    Parses an RgbaColor from a hexadecimal, rgb, rgba, hsl, or hsla value.
    
    Returns:
    returns the parsed color
  - fromHex
```
public static RgbaColor fromHex(String hex)
```
    Parses an RgbaColor from a hexadecimal value.
    
    Returns:
    returns the parsed color
  - fromRgb
```
public static RgbaColor fromRgb(String rgb)
```
    Parses an RgbaColor from an rgb value.
    
    Returns:
    the parsed color
  - fromRgba
```
public static RgbaColor fromRgba(String rgba)
```
    Parses an RgbaColor from an rgba value.
    
    Returns:
    the parsed color
  - fromHsl
```
public static RgbaColor fromHsl(String hsl)
```
    Parses an RgbaColor from a CSS3 HSL value, e.g. hsl(25, 100%, 80%)
    
    Returns:
    the parsed color
  - fromHsla
```
public static RgbaColor fromHsla(String hsl)
```
    Parses an RgbaColor from a CSS3 HSLA value, e.g. hsla(25, 100%, 80%, 0.5)
    
    Returns:
    returns the parsed color
  - fromHsl
```
public static RgbaColor fromHsl(float[] hsl)
```
    Convenience to get back to RGB from HSL array returned by toHSL.
  - red
```
public int red()
```
    Returns the value of the red component [0-255]
  - green
```
public int green()
```
    Returns the value of the green component [0-255]
  - blue
```
public int blue()
```
    Returns the value of the blue component [0-255]
  - hue
```
public float hue()
```
    Returns the value of the hue component of this color as HSL [0-360)
  - saturation
```
public float saturation()
```
    Returns the value of the saturation component of this color as HSL [0-100]
  - lightness
```
public float lightness()
```
    Returns the value of the lightness component of this color as HSL [0-100]
  - alpha
```
public float alpha()
```
    Returns the value of the alpha component [0-1]
  - r
```
public int r()
```
    Returns the value of the red component (0-255)
  - g
```
public int g()
```
    Returns the value of the green component (0-255)
  - b
```
public int b()
```
    Returns the value of the blue component (0-255)
  - h
```
public float h()
```
    Returns the value of the hue component of this color as HSL [0-360)
  - s
```
public float s()
```
    Returns the value of the saturation component of this color as HSL [0-100]
  - l
```
public float l()
```
    Returns the value of the lightness component of this color as HSL [0-100]
  - a
```
public float a()
```
    Returns the value of the alpha component [0-1]
  - withRed
```
public RgbaColor withRed(int red)
```
    Returns a new RgbaColor with the red component set to the specified value.
  - withBlue
```
public RgbaColor withBlue(int blue)
```
    Returns a new RgbaColor with the blue component set to the specified value.
  - withGreen
```
public RgbaColor withGreen(int green)
```
    Returns a new RgbaColor with the green component set to the specified value.
  - withAlpha
```
public RgbaColor withAlpha(float alpha)
```
    Returns a new RgbaColor with the alpha component set to the specified value.
  - withHue
```
public RgbaColor withHue(float hue)
```
    Returns a new RgbaColor with the hue component set to the specified value.
  - withSaturation
```
public RgbaColor withSaturation(float saturation)
```
    Returns a new RgbaColor with the saturation component set to the specified value.
  - withLightness
```
public RgbaColor withLightness(float lightness)
```
    Returns a new RgbaColor with the lightness component set to the specified value.
  - complement
```
public RgbaColor complement()
```
    Returns a new color that is the complement of this color. Equivalent to adjustHue(180).
  - grayscale
```
public RgbaColor grayscale()
```
    Returns a new color that is the grayscale equivalent of this color (with saturation = 0).
  - inverse
```
public RgbaColor inverse()
```
    Returns a new color that is the inverse of this color where each rgb component is subtracted from 255.
  - adjustHue
```
public RgbaColor adjustHue(float degrees)
```
    Returns a new color that has the hue adjusted by the specified amount.
  - opacify
```
public RgbaColor opacify(float amount)
```
    Returns a new color that has the alpha adjusted by the specified amount.
  - transparentize
```
public RgbaColor transparentize(float amount)
```
    Returns a new color that has the alpha adjusted by the specified amount. Equivalent to opacity(-amount).
  - lighten
```
public RgbaColor lighten(float amount)
```
    Returns a new color that has the lightness adjusted by the specified amount.
  - darken
```
public RgbaColor darken(float amount)
```
    Returns a new color that has the lightness adjusted by the negative of the specified amount. Equivalent to lighten(-amount).
  - saturate
```
public RgbaColor saturate(float amount)
```
    Returns a new color that has the saturation adjusted by the specified amount.
  - desaturate
```
public RgbaColor desaturate(float amount)
```
    Returns a new color that has the saturation adjusted by the negative of the specified amount. Equivalent to saturate(-amount).
  - getPaletteVaryLightness
```
public RgbaColor[] getPaletteVaryLightness(int count)
```
  - getSpreadInRange
```
protected static final float[] getSpreadInRange(float member,
                       int count,
                       int max,
                       int offset)
```
    Returns a spread of integers in a range [0,max) that includes count. The spread is sorted from largest to smallest.
  - lightenOrDarken
```
public RgbaColor lightenOrDarken(float lighten,
                        float darken)
```
    First attempt to lighten the color and if that overflows the lightness component, darken the color.
  - darkenOrLighten
```
public RgbaColor darkenOrLighten(float darken,
                        float lighten)
```
    First attempt to darken the color and if that overflows the lightness component, lighten the color.
  - saturateOrDesaturate
```
public RgbaColor saturateOrDesaturate(float saturate,
                             float desaturate)
```
    First attempt to saturate the color and if that overflows the saturation component, desaturate the color.
  - desaturateOrSaturate
```
public RgbaColor desaturateOrSaturate(float desaturate,
                             float saturate)
```
    First attempt to desaturate the color and if that overflows the saturation component, saturate the color.
  - convertToHsl
```
public float[] convertToHsl()
```
    Returns a triple of hue [0-360), saturation [0-100], and lightness [0-100]. These are kept as float[] so that for any RgbaColor color, color.equals(RgbaColor.fromHsl(color.convertToHsl())) is true.
    Implementation based on wikipedia
  - fromHsl
```
public static RgbaColor fromHsl(float H,
                float S,
                float L)
```
    Creates a new RgbaColor from the specified HSL components.
    Implementation based on wikipedia and w3c
    
    Parameters:
    H - Hue [0,360)
    S - Saturation [0,100]
    L - Lightness [0,100]
  - toHex
```
public String toHex()
```
    Returns the color in hexadecimal format (#rrggbb)
  - toRgb
```
public String toRgb()
```
    Returns the color in rgb format, e.g. rgb(r,g,b)
  - toRgba
```
public String toRgba()
```
    Returns the color in rgba format, e.g. rgba(r,g,b,a)
  - toHsl
```
public String toHsl()
```
    Returns the CSS3 HSL representation, e.g. hsl(120, 100%, 50%)
  - toHsla
```
public String toHsla()
```
    Returns the CSS3 HSLA representation, e.g. hsl(120, 100%, 50%, 0.5)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - rgbCheck
```
protected static int rgbCheck(int rgb)
```
  - hueCheck
```
protected static float hueCheck(float hue)
```
  - slCheck
```
protected static float slCheck(float sl)
```
  - alphaCheck
```
protected static float alphaCheck(float alpha)
```

Class RgbaColor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RgbaColor

RgbaColor

RgbaColor

Method Detail

from

fromHex

fromRgb

fromRgba

fromHsl

fromHsla

fromHsl

red

green

blue

hue

saturation

lightness

alpha

r

g

b

h

s

l

a

withRed

withBlue

withGreen

withAlpha

withHue

withSaturation

withLightness

complement

grayscale

inverse

adjustHue

opacify

transparentize

lighten

darken

saturate

desaturate

getPaletteVaryLightness

getSpreadInRange

lightenOrDarken

darkenOrLighten

saturateOrDesaturate

desaturateOrSaturate

convertToHsl

fromHsl

toHex

toRgb

toRgba

toHsl

toHsla

hashCode

equals

toString

rgbCheck

hueCheck

slCheck

alphaCheck