org.pepstock.charba.client.defaults.globals

Class DefaultLegend

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultLegend

All Implemented Interfaces:

IsDefaultLegend, IsDefaultPluginElement, IsDefaultTextDirectionHandler

public final class DefaultLegend
extends Object
implements IsDefaultLegend

CHART.JS default values for LEGEND element.

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.
IsDefaultLegendLabels	getLabels() Returns the labels object defaults.
int	getMaxHeight() Returns the maximum height of the legend, in pixels.
int	getMaxWidth() Returns the maximum width of the legend, in pixels.
Position	getPosition() Returns the position of element.
TextDirection	getTextDirection() Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
IsDefaultLegendTitle	getTitle() Returns the title object defaults.
boolean	isDisplay() Returns if the element is shown.
boolean	isFullSize() Returns true if marks 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.
boolean	isRtl() Returns true for rendering the object from right to left.

Methods inherited from class java.lang.Object

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

Method Detail

getLabels

public IsDefaultLegendLabels getLabels()

Description copied from interface: IsDefaultLegend

Returns the labels object defaults.

Specified by:

getLabels in interface IsDefaultLegend

Returns:

the labels object instance

getTitle

public IsDefaultLegendTitle getTitle()

Description copied from interface: IsDefaultLegend

Returns the title object defaults.

Specified by:

getTitle in interface IsDefaultLegend

Returns:

the title object instance

getEvents

public Set<Event> getEvents()

Description copied from interface: IsDefaultLegend

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.

isDisplay

public boolean isDisplay()

Description copied from interface: IsDefaultPluginElement

Returns if the element is shown.

Specified by:

isDisplay in interface IsDefaultPluginElement

Returns:

if the element is shown.

isFullSize

public boolean isFullSize()

Description copied from interface: IsDefaultLegend

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

Specified by:

isFullSize in interface IsDefaultLegend

Returns:

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

isReverse

public boolean isReverse()

Description copied from interface: IsDefaultLegend

Returns if the legend will show datasets in reverse order.

Specified by:

isReverse in interface IsDefaultLegend

Returns:

legend will show datasets in reverse order.

getPosition

public Position getPosition()

Description copied from interface: IsDefaultPluginElement

Returns the position of element.

Specified by:

getPosition in interface IsDefaultPluginElement

Returns:

the position of element.

getAlign

public ElementAlign getAlign()

Description copied from interface: IsDefaultPluginElement

Returns the alignment of the element.

Specified by:

getAlign in interface IsDefaultPluginElement

Returns:

alignment of the element.

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.

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

getMaxWidth

public int getMaxWidth()

Description copied from interface: IsDefaultLegend

Returns the maximum width of the legend, in pixels.

Specified by:

getMaxWidth in interface IsDefaultLegend

Returns:

the maximum width of the legend, in pixels

getMaxHeight

public int getMaxHeight()

Description copied from interface: IsDefaultLegend

Returns the maximum height of the legend, in pixels.

Specified by:

getMaxHeight in interface IsDefaultLegend

Returns:

the maximum height of the legend, in pixels