org.pepstock.charba.client.options

Class Title

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Title

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultTitle, HasFont

public final class Title
extends NativeObjectContainer
implements IsDefaultTitle

Configures the default chart title which defines text to draw at the top of the chart.

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.
double	getLineHeight() Returns the height of an individual line of text.
String	getLineHeightAsString() Returns the height of an individual line of text.
int	getPadding() Returns the padding to apply around labels.
protected P	getParent() Returns the parent element.
Position	getPosition() Returns the position of title.
List<String>	getText() Returns the title text to display, as a list of strings.
boolean	isDisplay() Returns true if the title is shown.
boolean	isFullWidth() Returns true if marks that this box should take the full width of the canvas (pushing down other boxes)
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) Sets true if the title is 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	setFullWidth(boolean fullWidth) If true, marks that this box should take the full width of the canvas (pushing down other boxes).
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.
void	setPadding(int padding) Sets the padding to apply around labels.
void	setPosition(Position position) Sets the position of title.
void	setText(String... text) Sets the title text to display.

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

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

setDisplay

public void setDisplay(boolean display)

Sets true if the title is shown.

Parameters:

display - if true the title is shown.

isDisplay

public boolean isDisplay()

Returns true if the title is shown.

Specified by:

isDisplay in interface IsDefaultTitle

Returns:

if true the title is shown.

setPosition

public void setPosition(Position position)

Sets the position of title.

Parameters:

position - the position of title.

getPosition

public Position getPosition()

Returns the position of title.

Specified by:

getPosition in interface IsDefaultTitle

Returns:

the position of title.

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 IsDefaultTitle

Returns:

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

setFullWidth

public void setFullWidth(boolean fullWidth)

If true, marks that this box should take the full width of the canvas (pushing down other boxes).

Parameters:

fullWidth - if true, marks that this box should take the full width of the canvas (pushing down other boxes)

isFullWidth

public boolean isFullWidth()

Returns true if marks that this box should take the full width of the canvas (pushing down other boxes)

Specified by:

isFullWidth in interface IsDefaultTitle

Returns:

true if marks that this box should take the full width of the canvas (pushing down other boxes).

setText

public void setText(String... text)

Sets the title text to display. If specified as an array, text is rendered on multiple lines.

Parameters:

text - the title text to display. If specified as an array, text is rendered on multiple lines.

getText

public List<String> getText()

Returns the title text to display, as a list of strings.

Returns:

a list of strings or an empty list if not exist

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.