org.pepstock.charba.client.options

Class LegendLabels

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.LegendLabels

public final class LegendLabels
extends ChartContainer

This is the labels configuration of the legend.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected LegendLabelItem[]	generateLegendLabels() Called to generate legend items for each thing in the legend.
int	getBoxWidth() Returns the width of coloured box.
LegendFilterHandler	getFilterHandler()
IsColor	getFontColor() Returns the font color for label
java.lang.String	getFontColorAsString() Returns the font color for label
java.lang.String	getFontFamily() Returns the font family for the label, follows CSS font-family options.
int	getFontSize() Returns the font size for label.
FontStyle	getFontStyle() Returns the font style for the label, follows CSS font-style options (i.e.
LegendLabelsCallback	getLabelsCallBack()
int	getPadding() Returns the padding to apply around labels.
boolean	isUsePointStyle() Returns if label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).
protected boolean	onFilter(GenericJavaScriptObject item) Called to filter legend items out of the legend.
void	setBoxWidth(int boxWidth) Sets the width of coloured box.
void	setFontColor(IsColor fontColor) Sets the font color for label
void	setFontColor(java.lang.String fontColor) Sets the font color for label
void	setFontFamily(java.lang.String fontFamily) Sets the font family for the label, follows CSS font-family options.
void	setFontSize(int fontSize) Sets the font size for label.
void	setFontStyle(FontStyle fontStyle) Sets the font style for the label, follows CSS font-style options (i.e.
void	setLabelsCallBack(LegendLabelsCallback legendLabelsCallBack)
void	setLegendFilterHandler(LegendFilterHandler filterHandler)
void	setPadding(int padding) Sets the padding to apply around labels.
void	setUsePointStyle(boolean usePointStyle) Sets if label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case).

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

getLabelsCallBack

public LegendLabelsCallback getLabelsCallBack()

Returns:

the legendCallBack

setLabelsCallBack

public void setLabelsCallBack(LegendLabelsCallback legendLabelsCallBack)

Parameters:

legendLabelsCallBack - the legendCallBack to set

getFilterHandler

public LegendFilterHandler getFilterHandler()

Returns:

the legendFilterHandler

setLegendFilterHandler

public void setLegendFilterHandler(LegendFilterHandler filterHandler)

Parameters:

filterHandler - the legendFilterHandler to set

setFontSize

public void setFontSize(int fontSize)

Sets the font size for label.

Parameters:

fontSize - Font size for label.

getFontSize

public int getFontSize()

Returns the font size for label.

Returns:

Font size for label. For default see Options.getLegend().

setFontStyle

public void setFontStyle(FontStyle fontStyle)

Sets the font style for the label, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Parameters:

fontStyle - Font style for the label, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

See Also:

FontStyle

getFontStyle

public FontStyle getFontStyle()

Returns the font style for the label, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Returns:

the font style for the label, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit). For default see Options.getLegend().

See Also:

FontStyle

setFontColor

public void setFontColor(IsColor fontColor)

Sets the font color for label

Parameters:

fontColor - Font color for label

setFontColor

public void setFontColor(java.lang.String fontColor)

Sets the font color for label

Parameters:

fontColor - Font color for label

getFontColorAsString

public java.lang.String getFontColorAsString()

Returns the font color for label

Returns:

Font color for label. For default see Options.getLegend().

getFontColor

public IsColor getFontColor()

Returns the font color for label

Returns:

Font color for label. For default see Options.getLegend().

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Sets the font family for the label, follows CSS font-family options.

Parameters:

fontFamily - Font family for the label, follows CSS font-family options.

getFontFamily

public java.lang.String getFontFamily()

Returns the font family for the label, follows CSS font-family options.

Returns:

Font family for the label, follows CSS font-family options. For default see Options.getLegend().

setUsePointStyle

public void setUsePointStyle(boolean usePointStyle)

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

Parameters:

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

isUsePointStyle

public boolean isUsePointStyle()

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

Returns:

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

setBoxWidth

public void setBoxWidth(int boxWidth)

Sets the width of coloured box.

Parameters:

boxWidth - width of coloured box.

getBoxWidth

public int getBoxWidth()

Returns the width of coloured box.

Returns:

width of coloured box. For default see Options.getLegend().

setPadding

public void setPadding(int padding)

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

Parameters:

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

getPadding

public int getPadding()

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

Returns:

Padding to apply around labels. Only top and bottom are implemented. For default see Options.getLegend().

generateLegendLabels

protected LegendLabelItem[] generateLegendLabels()

Called to generate legend items for each thing in the legend. Default implementation returns the text + styling for the color box.

Returns:

array of legend items.

onFilter

protected boolean onFilter(GenericJavaScriptObject item)

Called to filter legend items out of the legend. Receives 1 parameter, a Legend Item.

Parameters:

item - legend item to check.

Returns:

true to maintain the item, otherwise false to hide it.