org.pepstock.charba.client.options

Class ScaleLabel

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.ScaleLabel

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultScaleLabel, HasFont

public final class ScaleLabel
extends NativeObjectContainer
implements IsDefaultScaleLabel

When creating a chart, you want to tell the viewer what data they are viewing. To do this, you need to label the axis.
The scale label configuration defines options for the scale title. Note that this only applies to cartesian axes.

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.
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.
String	getLabelString() Returns the text for the scale string.
double	getLineHeight() Returns the height of an individual line of text.
String	getLineHeightAsString() Returns the height of an individual line of text.
ScaleLabelPadding	getPadding() Returns the padding element.
protected P	getParent() Returns the parent element.
boolean	isDisplay() If true, display the axis title.
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.
void	setDisplay(boolean display) If true, display the axis title.
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	setLabelString(String labelString) Sets the text for the scale string.
void	setLineHeight(double lineHeight) Sets the height of an individual line of text.
void	setLineHeight(String lineHeight) Sets the height of an individual line of text.

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.defaults.IsDefaultScaleLabel

getLineHeight

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultFontItem

getFontColorAsString, getFontFamily, getFontSize, getFontStyle

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

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

Method Detail

getPadding

public ScaleLabelPadding getPadding()

Returns the padding element.

Specified by:

getPadding in interface IsDefaultScaleLabel

Returns:

the padding

setDisplay

public void setDisplay(boolean display)

If true, display the axis title.

Parameters:

display - if true, display the axis title.

isDisplay

public boolean isDisplay()

If true, display the axis title.

Specified by:

isDisplay in interface IsDefaultScaleLabel

Returns:

if true, display the axis title.

setLabelString

public void setLabelString(String labelString)

Sets the text for the scale string.

Parameters:

labelString - the text for the scale string.

getLabelString

public String getLabelString()

Returns the text for the scale string.

Specified by:

getLabelString in interface IsDefaultScaleLabel

Returns:

the text for the scale string.

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

setLineHeight

public final void setLineHeight(double lineHeight)

Sets the height of an individual line of text.

Parameters:

lineHeight - height of an individual line of text.

setLineHeight

public final void setLineHeight(String lineHeight)

Sets the height of an individual line of text.

Parameters:

lineHeight - height of an individual line of text.

getLineHeight

public final double getLineHeight()

Returns the height of an individual line of text.

Returns:

the height of an individual line of text.

getLineHeightAsString

public final String getLineHeightAsString()

Returns the height of an individual line of text.

Returns:

the height of an individual line of text.

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.