org.pepstock.charba.client.defaults.chart

Class DefaultChartLegend

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartLegend

All Implemented Interfaces:

IsDefaultLegend, IsDefaultTextDirectioner

public final class DefaultChartLegend
extends Object
implements IsDefaultLegend

Defaults for legend option element, based on chart type.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
LegendAlign	getAlign() Returns the alignment of the legend.
IsDefaultLegendLabels	getLabels() Returns the labels object defaults.
Position	getPosition() Returns the position of the legend.
TextDirection	getTextDirection() Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
boolean	isDisplay() Returns true if the legend is shown.
boolean	isFullWidth() Returns true 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.
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

isDisplay

public boolean isDisplay()

Description copied from interface: IsDefaultLegend

Returns true if the legend is shown.

Specified by:

isDisplay in interface IsDefaultLegend

Returns:

true if the legend is shown.

isFullWidth

public boolean isFullWidth()

Description copied from interface: IsDefaultLegend

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

Specified by:

isFullWidth in interface IsDefaultLegend

Returns:

true if marks that this box should take the full width of the canvas (pushing down 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: IsDefaultLegend

Returns the position of the legend.

Specified by:

getPosition in interface IsDefaultLegend

Returns:

position of the legend.

getAlign

public LegendAlign getAlign()

Description copied from interface: IsDefaultLegend

Returns the alignment of the legend.

Specified by:

getAlign in interface IsDefaultLegend

Returns:

alignment of the legend.

isRtl

public boolean isRtl()

Description copied from interface: IsDefaultTextDirectioner

Returns true for rendering the object from right to left.

Specified by:

isRtl in interface IsDefaultTextDirectioner

Returns:

true for rendering the object from right to left.

getTextDirection

public TextDirection getTextDirection()

Description copied from interface: IsDefaultTextDirectioner

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 IsDefaultTextDirectioner

Returns:

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