com.googlecode.wickedcharts.highcharts.options.color

Class ColorReference

java.lang.Object

com.googlecode.wickedcharts.highcharts.options.color.ColorReference

All Implemented Interfaces:

Nullable, Serializable

Direct Known Subclasses:

Gradient, HexColor, HighchartsColor, NullColor, RgbaColor, SimpleColor

public abstract class ColorReference
extends Object
implements Serializable, Nullable

Reference to a color used in a chart.

Author:

Tom Hombergs (tom.hombergs@gmail.com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ColorReference()

Method Summary

Methods

Modifier and Type	Method and Description
ColorReference	brighten(Float brightness) Brightens this color by the amount given.
protected abstract ColorReference	copy()
Float	getBrightness()
boolean	isNull()
ColorReference	setBrightness(Float brightness)

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorReference

public ColorReference()

Method Detail

brighten

public ColorReference brighten(Float brightness)

Brightens this color by the amount given. Returns a copy of this color object not this object itself.

Parameters:

brightness - the amount to brighten (between 0 and 1).

Returns:

a copy of this color object, brightened by the given amount.

copy

protected abstract ColorReference copy()

getBrightness

public Float getBrightness()

isNull

public boolean isNull()

Specified by:

isNull in interface Nullable

setBrightness

public ColorReference setBrightness(Float brightness)