org.jrebirth.af.core.resource.color

Class HSBColor

java.lang.Object

org.jrebirth.af.core.resource.AbstractBaseParams

org.jrebirth.af.core.resource.color.AbstractBaseColor

org.jrebirth.af.core.resource.color.HSBColor

All Implemented Interfaces:

ColorParams, ResourceParams

public class HSBColor
extends AbstractBaseColor

The class HSBColor used to create an HSB color.

Author:

Sébastien Bordes

Property Summary

Type	Property and Description
DoubleProperty	brightness Return the brightness property.
DoubleProperty	hue Return the hue property.
DoubleProperty	saturation Return the saturation property.

Properties inherited from class org.jrebirth.af.core.resource.color.AbstractBaseColor

opacityProperty

Field Summary

Fields inherited from interface org.jrebirth.af.api.resource.ResourceParams

PARAMETER_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
HSBColor(double hue, double saturation, double brightness) Default Constructor.
HSBColor(double hue, double saturation, double brightness, double opacity) Default Constructor.

Method Summary

Modifier and Type	Method and Description
double	brightness() Return the brightness value 0.0-1.0.
DoubleProperty	brightnessProperty() Return the brightness property.
protected List<? extends Object>	getFieldValues() Return all values of ParameterEntry object.
double	hue() Return the hue value [0.0-360.0] in degrees.
DoubleProperty	hueProperty() Return the hue property.
void	parse(String... parameters) Parse a string to initialize fields.
double	saturation() Return the saturation value 0.0-1.0.
DoubleProperty	saturationProperty() Return the saturation property.

Methods inherited from class org.jrebirth.af.core.resource.color.AbstractBaseColor

opacity, opacityProperty

Methods inherited from class org.jrebirth.af.core.resource.AbstractBaseParams

activateAutoRefresh, equals, getKey, hasChanged, hasChanged, hashCode, readBoolean, readDouble, readInteger, setKey, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.api.resource.ResourceParams

activateAutoRefresh, getKey, hasChanged, hasChanged, setKey

Property Detail

hue

public DoubleProperty hueProperty

Return the hue property.

Returns:

Returns the hue property.

saturation

public DoubleProperty saturationProperty

Return the saturation property.

Returns:

Returns the saturation property.

brightness

public DoubleProperty brightnessProperty

Return the brightness property.

Returns:

Returns the brightness property.

Constructor Detail

HSBColor

public HSBColor(double hue,
                double saturation,
                double brightness)

Default Constructor.

Parameters:

hue - the color hue [0.0-360.0] in degrees

saturation - the color saturation [0.0-1.0]

brightness - the color brightness [0.0-1.0]

HSBColor

public HSBColor(double hue,
                double saturation,
                double brightness,
                double opacity)

Default Constructor.

Parameters:

hue - the color hue [0.0-360.0] in degrees

saturation - the color saturation [0.0-1.0]

brightness - the color brightness [0.0-1.0]

opacity - the color opacity [0.0-1.0]

Method Detail

hue

public double hue()

Return the hue value [0.0-360.0] in degrees.

Returns:

Returns the hue.

hueProperty

public DoubleProperty hueProperty()

Return the hue property.

Returns:

Returns the hue property.

saturation

public double saturation()

Return the saturation value 0.0-1.0.

Returns:

Returns the saturation.

saturationProperty

public DoubleProperty saturationProperty()

Return the saturation property.

Returns:

Returns the saturation property.

brightness

public double brightness()

Return the brightness value 0.0-1.0.

Returns:

Returns the brightness.

brightnessProperty

public DoubleProperty brightnessProperty()

Return the brightness property.

Returns:

Returns the brightness property.

parse

public void parse(String... parameters)

Parse a string to initialize fields.

Parameters:

parameters - split from resource properties file

getFieldValues

protected List<? extends Object> getFieldValues()

Return all values of ParameterEntry object.

Specified by:

getFieldValues in class AbstractBaseParams

Returns:

the list of parameters describing the resource to build