org.pepstock.charba.client.impl.plugins

Class ChartPointerOptionsBuilder

java.lang.Object

org.pepstock.charba.client.commons.AbstractBaseBuilder

org.pepstock.charba.client.impl.plugins.ChartPointerOptionsBuilder

All Implemented Interfaces:

IsBuilder

public final class ChartPointerOptionsBuilder
extends AbstractBaseBuilder

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

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
ChartPointerOptions	build() Returns a configured plugin options.
static ChartPointerOptionsBuilder	create() Returns new builder instance.
static ChartPointerOptionsBuilder	create(IsChart chart) Returns new builder instance using the chart global options.
ChartPointerOptionsBuilder	setCursorPointer(CursorType cursor) Sets the cursor type when the cursor is over the dataset item.
ChartPointerOptionsBuilder	setElements(PointerElement... elements) Sets the chart elements in scope to ChartPointer.ID plugin.

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

Methods inherited from interface org.pepstock.charba.client.commons.IsBuilder

checkAndGetIfValid, checkIfValid, isValid

Method Detail

create

public static ChartPointerOptionsBuilder create()

Returns new builder instance.

Returns:

new builder instance

create

public static ChartPointerOptionsBuilder 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 ChartPointerOptions build()

Returns a configured plugin options.

Returns:

a configured plugin options.

setElements

public ChartPointerOptionsBuilder setElements(PointerElement... elements)

Sets the chart elements in scope to ChartPointer.ID plugin.

Parameters:

elements - the chart elements in scope to ChartPointer.ID plugin

Returns:

new builder instance

setCursorPointer

public ChartPointerOptionsBuilder setCursorPointer(CursorType cursor)

Sets the cursor type when the cursor is over the dataset item.

Parameters:

cursor - cursor type when the cursor is over the dataset item

Returns:

new builder instance