org.pepstock.charba.client.colors

Class Gradient

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.colors.CanvasObject

org.pepstock.charba.client.colors.Gradient

public final class Gradient
extends CanvasObject

A gradient is an image consisting of a progressive transition between two or more colors.
Could be Linear or Radial.
Can be created using the size of CANVAS or CHART area.
The orientation to have a progressive transition, is defined by an enumeration in order to creates the gradient using the right coordinates and dimension, based on existing items (canvas and chart).

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gradient.GradientFactory Inner class to create gradient by a native object.

Constructor Summary

Constructors

Constructor and Description
Gradient() Creates a LINEAR gradient, with topDown orientation and chart scope.
Gradient(GradientType type) Creates a gradient by a type, with chart scope.
Gradient(GradientType type, GradientOrientation orientation) Creates a gradient by a type and an orientation, with chart scope.
Gradient(GradientType type, GradientOrientation orientation, GradientScope scope) Creates a gradient by a type, an orientation and a scope.
Gradient(GradientType type, GradientScope scope) Creates a gradient by a type and a scope.

Method Summary

Modifier and Type	Method and Description
void	addColorsStartStop(IsColor start, IsColor stop) Sets the start and stop color of gradient, when the gradient will have only 2 colors.
void	addColorsStartStop(String start, String stop) Sets the start and stop color of gradient, when the gradient will have only 2 colors.
void	addColorStop(double offset, IsColor color) Adds a stopping color with its offset
void	addColorStop(double offset, String color) Adds a stopping color with its offset
void	addColorStop(GradientColor color) Adds a stopping color with its offset
List<GradientColor>	getColors() Returns the unmodifiable list of stopping colors.
IsColor	getInterpolatedColorByOffset(double offset) Returns a color using the gradient as source of colors.
GradientOrientation	getOrientation() Returns the gradient orientation.
GradientScope	getScope() Returns the gradient scope.
GradientType	getType() Returns the gradient type.

Methods inherited from class org.pepstock.charba.client.colors.CanvasObject

getId

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Constructor Detail

Gradient

public Gradient()

Creates a LINEAR gradient, with topDown orientation and chart scope.

Gradient

public Gradient(GradientType type)

Creates a gradient by a type, with chart scope.

Parameters:

type - gradient type

Gradient

public Gradient(GradientType type,
                GradientOrientation orientation)

Creates a gradient by a type and an orientation, with chart scope.

Parameters:

type - gradient type

orientation - orientation of gradient

Gradient

public Gradient(GradientType type,
                GradientScope scope)

Creates a gradient by a type and a scope.

Parameters:

type - gradient type

scope - scope of gradient

Gradient

public Gradient(GradientType type,
                GradientOrientation orientation,
                GradientScope scope)

Creates a gradient by a type, an orientation and a scope.

Parameters:

type - gradient type

orientation - orientation of gradient

scope - scope of gradient

Method Detail

getType

public final GradientType getType()

Returns the gradient type.

Returns:

the gradient type

getOrientation

public final GradientOrientation getOrientation()

Returns the gradient orientation.

Returns:

the gradient orientation

getScope

public final GradientScope getScope()

Returns the gradient scope.

Returns:

the gradient scope

addColorsStartStop

public void addColorsStartStop(IsColor start,
                               IsColor stop)

Sets the start and stop color of gradient, when the gradient will have only 2 colors.

Parameters:

start - starting color, with offset 0

stop - stopping color, with offset 1

addColorsStartStop

public void addColorsStartStop(String start,
                               String stop)

Sets the start and stop color of gradient, when the gradient will have only 2 colors.

Parameters:

start - starting color, with offset 0

stop - stopping color, with offset 1

addColorStop

public void addColorStop(double offset,
                         IsColor color)

Adds a stopping color with its offset

Parameters:

offset - offset of color

color - color instance

addColorStop

public void addColorStop(double offset,
                         String color)

Adds a stopping color with its offset

Parameters:

offset - offset of color

color - color instance

addColorStop

public void addColorStop(GradientColor color)

Adds a stopping color with its offset

Parameters:

color - color instance

getColors

public List<GradientColor> getColors()

Returns the unmodifiable list of stopping colors.

Returns:

the unmodifiable list of stopping colors.

getInterpolatedColorByOffset

public IsColor getInterpolatedColorByOffset(double offset)

Returns a color using the gradient as source of colors.

Parameters:

offset - offset to search into the gradient colors

Returns:

a color based on offset.