Package org.pepstock.charba.client.impl.plugins

Class ChartBackgroundColorOptionsBuilder

java.lang.Object

org.pepstock.charba.client.commons.AbstractBaseBuilder

org.pepstock.charba.client.impl.plugins.ChartBackgroundColorOptionsBuilder

All Implemented Interfaces:

IsBuilder

public final class ChartBackgroundColorOptionsBuilder
extends AbstractBaseBuilder

Comfortable object to create ChartBackgroundColor.ID plugin options by a builder.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
ChartBackgroundColorOptions	build()	Returns a configured plugin options.
static ChartBackgroundColorOptionsBuilder	create()	Returns new builder instance.
static ChartBackgroundColorOptionsBuilder	create(IsChart chart)	Returns new builder instance using the chart global options.
ChartBackgroundColorOptionsBuilder	setAreaBackgroundColor(String color)	Sets the area background color.
ChartBackgroundColorOptionsBuilder	setAreaBackgroundColor(Gradient gradient)	Sets the area background gradient.
ChartBackgroundColorOptionsBuilder	setAreaBackgroundColor(IsColor color)	Sets the area background color.
ChartBackgroundColorOptionsBuilder	setAreaBackgroundColor(Pattern pattern)	Sets the area background pattern.
ChartBackgroundColorOptionsBuilder	setBackgroundColor(String color)	Sets the background color.
ChartBackgroundColorOptionsBuilder	setBackgroundColor(Gradient gradient)	Sets the background gradient.
ChartBackgroundColorOptionsBuilder	setBackgroundColor(IsColor color)	Sets the background color.
ChartBackgroundColorOptionsBuilder	setBackgroundColor(Pattern pattern)	Sets the background pattern.
ChartBackgroundColorOptionsBuilder	setFillArea(boolean fillArea)	Sets true if the want to fill the chart area with also the canvas background color.
ChartBackgroundColorOptionsBuilder	setGlobalCompositeOperation(GlobalCompositeOperation globalCompositeOperation)	Sets the type of compositing operation to apply when drawing new shapes.

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

isBuilt, setBuilt

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ChartBackgroundColorOptionsBuilder create()

Returns new builder instance.

Returns:

new builder instance

create

public static ChartBackgroundColorOptionsBuilder create(IsChart chart)

Returns new builder instance using the chart global options.

Parameters:

chart - chart instance related to the plugin options

Returns:

new builder instance

build

public ChartBackgroundColorOptions build()

Returns a configured plugin options.

Returns:

a configured plugin options.

setBackgroundColor

public ChartBackgroundColorOptionsBuilder setBackgroundColor(String color)

Sets the background color.

Parameters:

color - the background color.

Returns:

new builder instance

setBackgroundColor

public ChartBackgroundColorOptionsBuilder setBackgroundColor(IsColor color)

Sets the background color.

Parameters:

color - the background color.

Returns:

new builder instance

setBackgroundColor

public ChartBackgroundColorOptionsBuilder setBackgroundColor(Gradient gradient)

Sets the background gradient.

Parameters:

gradient - the background gradient.

Returns:

new builder instance

setBackgroundColor

public ChartBackgroundColorOptionsBuilder setBackgroundColor(Pattern pattern)

Sets the background pattern.

Parameters:

pattern - the background pattern.

Returns:

new builder instance

setAreaBackgroundColor

public ChartBackgroundColorOptionsBuilder setAreaBackgroundColor(String color)

Sets the area background color.

Parameters:

color - the area background color.

Returns:

new builder instance

setAreaBackgroundColor

public ChartBackgroundColorOptionsBuilder setAreaBackgroundColor(IsColor color)

Sets the area background color.

Parameters:

color - the area background color.

Returns:

new builder instance

setAreaBackgroundColor

public ChartBackgroundColorOptionsBuilder setAreaBackgroundColor(Gradient gradient)

Sets the area background gradient.

Parameters:

gradient - the area background gradient.

Returns:

new builder instance

setAreaBackgroundColor

public ChartBackgroundColorOptionsBuilder setAreaBackgroundColor(Pattern pattern)

Sets the area background pattern.

Parameters:

pattern - the area background pattern.

Returns:

new builder instance

setGlobalCompositeOperation

public ChartBackgroundColorOptionsBuilder setGlobalCompositeOperation(GlobalCompositeOperation globalCompositeOperation)

Sets the type of compositing operation to apply when drawing new shapes.

Parameters:

globalCompositeOperation - which of the compositing or blending mode operations to use

Returns:

new builder instance

setFillArea

public ChartBackgroundColorOptionsBuilder setFillArea(boolean fillArea)

Sets true if the want to fill the chart area with also the canvas background color.

Parameters:

fillArea - true if the want to fill the chart area with also the canvas background color.

Returns:

new builder instance