org.pepstock.charba.client.options

Class Legend

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.options.AbstractModel<Plugins,T>

org.pepstock.charba.client.options.Legend

All Implemented Interfaces:

IsDefaultLegend, IsDefaultPluginElement, IsDefaultTextDirectionHandler

public final class Legend
extends AbstractModel<Plugins,T>
implements IsDefaultLegend

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
ElementAlign	getAlign() Returns the alignment of the element.
Set<Event>	getEvents() Returns the browser events that the legend should listen to.
LegendLabels	getLabels() Returns the legend labels element.
int	getMaxHeight() Returns the maximum width of the legend, in pixels.
int	getMaxWidth() Returns the maximum width of the legend, in pixels.
Position	getPosition() Returns the position of element.
default TextDirection	getTextDirection() Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
org.pepstock.charba.client.options.TextDirectionHandler	getTextDirectionHandler() Returns a text direction handler instance to use in the default methods of this interface.
LegendTitle	getTitle() Returns the legend title element.
boolean	isDisplay() Returns true if the element is shown.
boolean	isFullSize() Returns if that this box should take the full width/height of the canvas (moving other boxes).
boolean	isReverse() Returns if the legend will show datasets in reverse order.
default boolean	isRtl() Returns true for rendering the object from right to left.
void	setAlign(ElementAlign alignment) Sets the alignment of the element.
void	setDisplay(boolean display) Sets true if the element is shown.
void	setEvents(Event... events) Sets the browser events that the legend should listen to.
void	setEvents(Set<Event> events) Sets the browser events that the legend should listen to.
void	setFullSize(boolean fullSize) Marks that this box should take the full width/height of the canvas (moving other boxes).
void	setMaxHeight(int maxHeight) Sets the maximum height of the legend, in pixels.
void	setMaxWidth(int maxWidth) Sets the maximum width of the legend, in pixels.
void	setPosition(Position position) Sets the position of element.
void	setReverse(boolean reverse) Sets the legend will show datasets in reverse order.
default void	setRtl(boolean rtl) Sets true for rendering the tooltips from right to left.
default void	setTextDirection(TextDirection textDirection) Sets the text direction of the tooltips that will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas.

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

getDefaultValues, getParent, loadPadding, setCallbackToModel, setCallbackToModel, setEventToModel

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

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

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultPluginElement

getAlign, getPosition, isDisplay

Method Detail

getTextDirectionHandler

public org.pepstock.charba.client.options.TextDirectionHandler getTextDirectionHandler()

Returns a text direction handler instance to use in the default methods of this interface.

Returns:

a text direction handler instance

getLabels

public LegendLabels getLabels()

Returns the legend labels element.

Specified by:

getLabels in interface IsDefaultLegend

Returns:

the labels

getTitle

public LegendTitle getTitle()

Returns the legend title element.

Specified by:

getTitle in interface IsDefaultLegend

Returns:

the title

setEvents

public void setEvents(Event... events)

Sets the browser events that the legend should listen to.

Parameters:

events - the browser events that the legend should listen to.

setEvents

public void setEvents(Set<Event> events)

Sets the browser events that the legend should listen to.

Parameters:

events - the browser events that the legend should listen to.

getEvents

public Set<Event> getEvents()

Returns the browser events that the legend should listen to.

Specified by:

getEvents in interface IsDefaultLegend

Returns:

the browser events that the legend should listen to.

setMaxWidth

public void setMaxWidth(int maxWidth)

Sets the maximum width of the legend, in pixels.

Parameters:

maxWidth - the maximum width of the legend, in pixels

getMaxWidth

public int getMaxWidth()

Returns the maximum width of the legend, in pixels.

Specified by:

getMaxWidth in interface IsDefaultLegend

Returns:

the maximum width of the legend, in pixels

setMaxHeight

public void setMaxHeight(int maxHeight)

Sets the maximum height of the legend, in pixels.

Parameters:

maxHeight - the maximum height of the legend, in pixels

getMaxHeight

public int getMaxHeight()

Returns the maximum width of the legend, in pixels.

Specified by:

getMaxHeight in interface IsDefaultLegend

Returns:

the maximum width of the legend, in pixels

setFullSize

public void setFullSize(boolean fullSize)

Marks that this box should take the full width/height of the canvas (moving other boxes).

Parameters:

fullSize - Marks that this box should take the full width/height of the canvas (moving other boxes)

isFullSize

public boolean isFullSize()

Returns if that this box should take the full width/height of the canvas (moving other boxes).

Specified by:

isFullSize in interface IsDefaultLegend

Returns:

true if that this box should take the full width/height of the canvas (moving 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.

Specified by:

isReverse in interface IsDefaultLegend

Returns:

true if legend will show datasets in reverse order.

setRtl

public void setRtl(boolean rtl)

Sets true for rendering the tooltips from right to left.

Parameters:

rtl - true for rendering the tooltips from right to left

isRtl

public boolean isRtl()

Description copied from interface: IsDefaultTextDirectionHandler

Returns true for rendering the object from right to left.

Specified by:

isRtl in interface IsDefaultTextDirectionHandler

Returns:

true for rendering the object from right to left.

setTextDirection

public void setTextDirection(TextDirection textDirection)

Sets the text direction of the tooltips that will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas.

Parameters:

textDirection - the text direction of the tooltips.

getTextDirection

public TextDirection getTextDirection()

Description copied from interface: IsDefaultTextDirectionHandler

Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.

Specified by:

getTextDirection in interface IsDefaultTextDirectionHandler

Returns:

the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas

setDisplay

public void setDisplay(boolean display)

Sets true if the element is shown.

Parameters:

display - if true the element is shown.

isDisplay

public boolean isDisplay()

Returns true if the element is shown.

Specified by:

isDisplay in interface IsDefaultPluginElement

Returns:

if true the element is shown.

setPosition

public void setPosition(Position position)

Sets the position of element.

Parameters:

position - the position of element.

getPosition

public Position getPosition()

Returns the position of element.

Specified by:

getPosition in interface IsDefaultPluginElement

Returns:

the position of element.

setAlign

public void setAlign(ElementAlign alignment)

Sets the alignment of the element.

Parameters:

alignment - alignment of the element.

getAlign

public ElementAlign getAlign()

Returns the alignment of the element.

Specified by:

getAlign in interface IsDefaultPluginElement

Returns:

alignment of the element.