org.pepstock.charba.client.impl.plugins

Class HtmlLegendOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.impl.plugins.HtmlLegendOptions

public final class HtmlLegendOptions
extends AbstractPluginOptions

Configuration options of HtmlLegend.ID plugin.
This is mapping the configuration both default global and per chart instance.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static Style.Cursor	DEFAULT_CURSOR_POINTER Default cursor type when the cursor is over the legend, Style.Cursor.POINTER.
static boolean	DEFAULT_DISPLAY Default display if legend must be showed.
static int	DEFAULT_MAXIMUM_LEGEND_COLUMNS Default maximum legends columns to show.

Constructor Summary

Constructors

Constructor and Description
HtmlLegendOptions() Builds the object with new java script object setting the default value of plugin. The global plugin options is used, if exists, as defaults values.
HtmlLegendOptions(IsChart chart) Builds the object with a chart instance in order to get the right defaults. If the plugin options have not been set by chart type, it will use the global.

Method Summary

Modifier and Type	Method and Description
Style.Cursor	getCursorPointer() Returns the cursor type when the cursor is over the dataset item.
HtmlLegendTextCallback	getLegendTextCallback() Returns the callback which can be implemented to change the text of legend for a specific item, as HTML.
int	getMaximumLegendColumns() Returns the maximum amount of columns of legend.
boolean	isDisplay() Returns if the legend is shown.
void	setCursorPointer(Style.Cursor cursor) Sets the cursor type when the cursor is over the dataset item.
void	setDisplay(boolean display) Sets if the legend is shown.
void	setLegendTextCallback(HtmlLegendTextCallback legendTextCallback) Sets the callback which can be implemented to change the text of legend for a specific item, as HTML.
void	setMaximumLegendColumns(int maxColumns) Sets the maximum amount of columns of legend.

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPluginOptions

getId, getPluginId, loadGlobalsPluginOptions, store, store, store, store

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

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, 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

Field Detail

DEFAULT_CURSOR_POINTER

public static final Style.Cursor DEFAULT_CURSOR_POINTER

Default cursor type when the cursor is over the legend, Style.Cursor.POINTER.

DEFAULT_MAXIMUM_LEGEND_COLUMNS

public static final int DEFAULT_MAXIMUM_LEGEND_COLUMNS

Default maximum legends columns to show.

See Also:

Constant Field Values

DEFAULT_DISPLAY

public static final boolean DEFAULT_DISPLAY

Default display if legend must be showed.

See Also:

Constant Field Values

Constructor Detail

HtmlLegendOptions

public HtmlLegendOptions()

Builds the object with new java script object setting the default value of plugin.
The global plugin options is used, if exists, as defaults values.

HtmlLegendOptions

public HtmlLegendOptions(IsChart chart)

Builds the object with a chart instance in order to get the right defaults.
If the plugin options have not been set by chart type, it will use the global.

Parameters:

chart - chart type to use to get the default values by chart

Method Detail

setDisplay

public void setDisplay(boolean display)

Sets if the legend is shown.

Parameters:

display - if the legend is shown.

isDisplay

public boolean isDisplay()

Returns if the legend is shown.

Returns:

true if the legend is shown.

getLegendTextCallback

public HtmlLegendTextCallback getLegendTextCallback()

Returns the callback which can be implemented to change the text of legend for a specific item, as HTML.

Returns:

the callback which can be implemented to change the text of legend for a specific item, as HTML

setLegendTextCallback

public void setLegendTextCallback(HtmlLegendTextCallback legendTextCallback)

Sets the callback which can be implemented to change the text of legend for a specific item, as HTML.

Parameters:

legendTextCallback - the callback which can be implemented to change the text of legend for a specific item, as HTML

setMaximumLegendColumns

public void setMaximumLegendColumns(int maxColumns)

Sets the maximum amount of columns of legend.

Parameters:

maxColumns - the maximum amount of columns of legend

getMaximumLegendColumns

public int getMaximumLegendColumns()

Returns the maximum amount of columns of legend.

Returns:

he maximum amount of columns of legend

setCursorPointer

public final void setCursorPointer(Style.Cursor cursor)

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

Parameters:

cursor - cursor type

See Also:

Style.Cursor

getCursorPointer

public final Style.Cursor getCursorPointer()

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

Returns:

cursor type

See Also:

Style.Cursor