Package org.pepstock.charba.client.defaults.chart

Class DefaultChartLegendLabels

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartLegendLabels

All Implemented Interfaces:

IsDefaultBoxHandler, IsDefaultFontContainer, IsDefaultLegendLabels, IsDefaultPointStyleHandler

public final class DefaultChartLegendLabels
extends Object
implements IsDefaultLegendLabels

Defaults for legend labels option element, based on chart type.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
int	getBoxHeight()	Returns the height of colored box.
int	getBoxWidth()	Returns the width of colored box.
String	getColorAsString()	Returns the font color as string.
IsDefaultFont	getFont()	Returns the font element.
int	getPadding()	Returns the padding to apply around labels.
PointStyle	getPointStyle()	Returns the style of the point.
Canvas	getPointStyleAsCanvas()	Returns the style of the point as canvas. If property is missing or not an canvas, returns null.
Img	getPointStyleAsImage()	Returns the style of the point as image. If property is missing or not an image, returns null.
PointStyleType	getPointStyleType()	Returns the type of point style.
double	getPointStyleWidth()	Returns if usePointStyle is true, the width of the point style used for the legend (only for PointStyle.CIRCLE, PointStyle.RECT and PointStyle.LINE).
TextAlign	getTextAlign()	Returns the horizontal alignment of the label text.
boolean	isUsePointStyle()	Returns if label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).

Methods inherited from class java.lang.Object

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

Method Detail

getColorAsString

public String getColorAsString()

Description copied from interface: IsDefaultFontContainer

Returns the font color as string.

Specified by:

getColorAsString in interface IsDefaultFontContainer

Returns:

font color as string

getFont

public IsDefaultFont getFont()

Description copied from interface: IsDefaultFontContainer

Returns the font element.

Specified by:

getFont in interface IsDefaultFontContainer

Returns:

the font

isUsePointStyle

public boolean isUsePointStyle()

Description copied from interface: IsDefaultLegendLabels

Returns if label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).

Specified by:

isUsePointStyle in interface IsDefaultLegendLabels

Returns:

if label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).

getPointStyleWidth

public double getPointStyleWidth()

Description copied from interface: IsDefaultLegendLabels

Returns if usePointStyle is true, the width of the point style used for the legend (only for PointStyle.CIRCLE, PointStyle.RECT and PointStyle.LINE).

Specified by:

getPointStyleWidth in interface IsDefaultLegendLabels

Returns:

if usePointStyle is true, the width of the point style used for the legend (only for PointStyle.CIRCLE, PointStyle.RECT and PointStyle.LINE).

getPointStyle

public PointStyle getPointStyle()

Description copied from interface: IsDefaultPointStyleHandler

Returns the style of the point.

Specified by:

getPointStyle in interface IsDefaultPointStyleHandler

Returns:

the style of the point.

getBoxWidth

public int getBoxWidth()

Description copied from interface: IsDefaultBoxHandler

Returns the width of colored box.

Specified by:

getBoxWidth in interface IsDefaultBoxHandler

Returns:

width of colored box.

getBoxHeight

public int getBoxHeight()

Description copied from interface: IsDefaultBoxHandler

Returns the height of colored box.

Specified by:

getBoxHeight in interface IsDefaultBoxHandler

Returns:

height of colored box.

getPadding

public int getPadding()

Description copied from interface: IsDefaultLegendLabels

Returns the padding to apply around labels. Only top and bottom are implemented.

Specified by:

getPadding in interface IsDefaultLegendLabels

Returns:

Padding to apply around labels. Only top and bottom are implemented.

getPointStyleType

public PointStyleType getPointStyleType()

Description copied from interface: IsDefaultPointStyleHandler

Returns the type of point style.

Specified by:

getPointStyleType in interface IsDefaultPointStyleHandler

Returns:

the type of point style

getPointStyleAsCanvas

public Canvas getPointStyleAsCanvas()

Description copied from interface: IsDefaultPointStyleHandler

Returns the style of the point as canvas.
If property is missing or not an canvas, returns null.

Specified by:

getPointStyleAsCanvas in interface IsDefaultPointStyleHandler

Returns:

image of the style of the point as canvas.
If property is missing or not a canvas, returns null.

getPointStyleAsImage

public Img getPointStyleAsImage()

Description copied from interface: IsDefaultPointStyleHandler

Returns the style of the point as image.
If property is missing or not an image, returns null.

Specified by:

getPointStyleAsImage in interface IsDefaultPointStyleHandler

Returns:

image of the style of the point as image.
If property is missing or not a image, returns null.

getTextAlign

public TextAlign getTextAlign()

Description copied from interface: IsDefaultLegendLabels

Returns the horizontal alignment of the label text.

Specified by:

getTextAlign in interface IsDefaultLegendLabels

Returns:

the horizontal alignment of the label text.