org.pepstock.charba.client.options

Class PointLabels

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.PointLabels

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultPointLabels, HasFont

public final class PointLabels
extends NativeObjectContainer
implements IsDefaultPointLabels

It is used to configure the point labels that are shown on the perimeter of the scale.
Note that these options only apply if display is true.

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.
IsColor	getFontColor() Returns the font color.
String	getFontColorAsString() Returns the font color
List<IsColor>	getFontColors() Returns the font colors as list.
List<String>	getFontColorsAsString() Returns the font colors as list.
Fonter	getFonter() Returns a fonter instance to use into default methods of this interface.
double	getLineHeight() Returns the height of an individual line of text.
String	getLineHeightAsString() Returns the height of an individual line of text.
protected P	getParent() Returns the parent element.
boolean	isDisplay() If true, labels are shown.
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, labels are shown.
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	setFontColor(IsColor... fontColors) Sets an array of font colors.
void	setFontColor(String... fontColors) Sets an array of font colors.
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, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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.IsDefaultPointLabels

getLineHeight

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

getFontFamily, getFontSize, getFontStyle

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

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

Method Detail

setDisplay

public void setDisplay(boolean display)

If true, labels are shown.

Parameters:

display - if true, labels are shown.

isDisplay

public boolean isDisplay()

If true, labels are shown.

Specified by:

isDisplay in interface IsDefaultPointLabels

Returns:

if true, labels are shown.

setFontColor

public void setFontColor(IsColor... fontColors)

Sets an array of font colors.

Parameters:

fontColors - an array of font colors

setFontColor

public void setFontColor(String... fontColors)

Sets an array of font colors.

Parameters:

fontColors - an array of font colors

getFontColorAsString

public String getFontColorAsString()

Description copied from interface: IsDefaultFontItem

Returns the font color

Specified by:

getFontColorAsString in interface IsDefaultFontItem

Specified by:

getFontColorAsString in interface HasFont

Returns:

Font color

getFontColor

public IsColor getFontColor()

Description copied from interface: HasFont

Returns the font color.

Specified by:

getFontColor in interface HasFont

Returns:

font color.

getFontColorsAsString

public List<String> getFontColorsAsString()

Returns the font colors as list.

Returns:

Font color as list

getFontColors

public List<IsColor> getFontColors()

Returns the font colors as list.

Returns:

Font color as list

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.