org.pepstock.charba.client.configuration

Class Legend

java.lang.Object

org.pepstock.charba.client.configuration.EventProvider<ExtendedOptions>

org.pepstock.charba.client.configuration.Legend

All Implemented Interfaces:

EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

public class Legend
extends EventProvider<ExtendedOptions>

The chart legend displays data about the datasets that area appearing on the chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected <H extends EventHandler> void	addHandler(GwtEvent.Type<H> type) Notifies the event provider when a new handler has been added.
AbstractChart<?,?>	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
LegendLabels	getLabels() Returns the legend labels element.
Position	getPosition() Returns the position of the legend.
boolean	isDisplay() Returns if the legend is shown.
boolean	isFullWidth() Returns if marks that this box should take the full width of the canvas (pushing down other boxes)
boolean	isReverse() Returns if the legend will show datasets in reverse order.
protected <H extends EventHandler> void	removeHandler(GwtEvent.Type<H> type) Notifies the event provider when a new handler has been unregistered
protected void	setConfiguration(T configuration)
void	setDisplay(boolean display) Sets if the legend is shown.
void	setFullWidth(boolean fullWidth) Marks that this box should take the full width of the canvas (pushing down other boxes).
void	setPosition(Position position) Sets the position of the legend.
void	setReverse(boolean reverse) Sets the legend will show datasets in reverse order.
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.EventProvider

onAdd, onRemove

Methods inherited from class java.lang.Object

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

Method Detail

getLabels

public LegendLabels getLabels()

Returns the legend labels element.

Returns:

the labels

addHandler

protected final <H extends EventHandler> void addHandler(GwtEvent.Type<H> type)

Description copied from class: EventProvider

Notifies the event provider when a new handler has been added.

Specified by:

addHandler in class EventProvider<ExtendedOptions>

Type Parameters:

H - type of event handler

Parameters:

type - type of event

removeHandler

protected final <H extends EventHandler> void removeHandler(GwtEvent.Type<H> type)

Description copied from class: EventProvider

Notifies the event provider when a new handler has been unregistered

Specified by:

removeHandler in class EventProvider<ExtendedOptions>

Type Parameters:

H - type of event handler

Parameters:

type - type of event handler

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:

if the legend is shown.

setFullWidth

public void setFullWidth(boolean fullWidth)

Marks that this box should take the full width of the canvas (pushing down other boxes).

Parameters:

fullWidth - Marks that this box should take the full width of the canvas (pushing down other boxes)

isFullWidth

public boolean isFullWidth()

Returns if marks that this box should take the full width of the canvas (pushing down other boxes)

Returns:

Marks that this box should take the full width of the canvas (pushing down other boxes).

setReverse

public void setReverse(boolean reverse)

Sets the legend will show datasets in reverse order.

Parameters:

reverse - legend will show datasets in reverse order.

isReverse

public boolean isReverse()

Returns if the legend will show datasets in reverse order.

Returns:

Legend will show datasets in reverse order.

setPosition

public void setPosition(Position position)

Sets the position of the legend.

Parameters:

position - Position of the legend.

getPosition

public Position getPosition()

Returns the position of the legend.

Returns:

Position of the legend.

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final AbstractChart<?,?> getChart()

Returns the chart instance

Returns:

the chart