org.pepstock.charba.client.options

Class Legend

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.commons.EventProvider

org.pepstock.charba.client.options.Legend

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

public final class Legend
extends EventProvider

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 com.google.gwt.event.shared.EventHandler> void	addHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type) Notifies the event provider when a new handler has been added.
LegendLabels	getLabels()
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 void	onClick(ChartNativeEvent event, GenericJavaScriptObject item) A callback that is called when a click event is registered on a label item
protected void	onHover(ChartNativeEvent event, GenericJavaScriptObject item) A callback that is called when a 'mousemove' event is registered on top of a label item
protected <H extends com.google.gwt.event.shared.EventHandler> void	removeHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type) Notifies the event provider when a new handler has been deregistered
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.

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

onAdd, onRemove

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

getChart

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

getLabels

public LegendLabels getLabels()

Returns:

the labels

addHandler

protected <H extends com.google.gwt.event.shared.EventHandler> void addHandler(com.google.gwt.event.shared.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

Type Parameters:

H - type of event handler

Parameters:

type - type of event

removeHandler

protected <H extends com.google.gwt.event.shared.EventHandler> void removeHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type)

Description copied from class: EventProvider

Notifies the event provider when a new handler has been deregistered

Specified by:

removeHandler in class EventProvider

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. For default see Options.getLegend().

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). For default see Options.getLegend().

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. For default see Options.getLegend().

setPosition

public void setPosition(Position position)

Sets the position of the legend.

Parameters:

position - Position of the legend.

See Also:

Position

getPosition

public Position getPosition()

Returns the position of the legend.

Returns:

Position of the legend. Default is For default see Options.getLegend().

See Also:

Position

onClick

protected void onClick(ChartNativeEvent event,
                       GenericJavaScriptObject item)

A callback that is called when a click event is registered on a label item

Parameters:

event - event generated by chart.

item - legend item affected by event.

onHover

protected void onHover(ChartNativeEvent event,
                       GenericJavaScriptObject item)

A callback that is called when a 'mousemove' event is registered on top of a label item

Parameters:

event - event generated by chart.

item - legend item affected by event.