org.pepstock.charba.client.options

Class LegendLabels

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.LegendLabels

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultLegendLabels, HasFont

public final class LegendLabels
extends NativeObjectContainer
implements IsDefaultLegendLabels, HasFont

This is the labels configuration of the legend.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
int	getBoxWidth() Returns the width of colored box.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
Fonter	getFonter() Returns a fonter instance to use into default methods of this interface.
int	getPadding() Returns the padding to apply around labels.
protected P	getParent() Returns the parent element.
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 colored box.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.
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.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.options.HasFont

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

Method Detail

getFonter

public final Fonter getFonter()

Description copied from interface: HasFont

Returns a fonter instance to use into default methods of this interface.

Specified by:

getFonter in interface HasFont

Returns:

a fonter instance

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).

Specified by:

isUsePointStyle in interface IsDefaultLegendLabels

Returns:

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

setBoxWidth

public void setBoxWidth(int boxWidth)

Sets the width of colored box.

Parameters:

boxWidth - width of colored box.

getBoxWidth

public int getBoxWidth()

Returns the width of colored box.

Specified by:

getBoxWidth in interface IsDefaultLegendLabels

Returns:

width of colored box.

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.

Specified by:

getPadding in interface IsDefaultLegendLabels

Returns:

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

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.