org.pepstock.charba.client.defaults.global

Class LegendLabels

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.FontItem

org.pepstock.charba.client.defaults.global.LegendLabels

public final class LegendLabels
extends FontItem

This is the labels configuration of the legend.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
int	getBoxWidth() Returns the width of coloured box.
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).
void	setBoxWidth(int boxWidth) Sets the width of coloured box.
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.defaults.FontItem

getFontColor, getFontColorAsString, getFontFamily, getFontSize, getFontStyle, setFontColor, setFontColor, setFontFamily, setFontSize, setFontStyle

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

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

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). Default is false.

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. Default is 40.

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. Default is 10.