org.pepstock.charba.client.options

Class Title

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<P,D>

org.pepstock.charba.client.options.FontItem<Options,IsDefaultTitle>

org.pepstock.charba.client.options.Title

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultTitle

public final class Title
extends FontItem<Options,IsDefaultTitle>
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
double	getLineHeight() Returns the height of an individual line of text.
int	getPadding() Returns the padding to apply around labels.
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)
void	setDisplay(boolean display) Sets true if the title is shown.
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	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.options.FontItem

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

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

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

getFontColorAsString, getFontFamily, getFontSize, getFontStyle

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

setLineHeight

public void setLineHeight(double lineHeight)

Sets the height of an individual line of text.

Parameters:

lineHeight - height of an individual line of text.

getLineHeight

public double getLineHeight()

Returns the height of an individual line of text.

Specified by:

getLineHeight in interface IsDefaultTitle

Returns:

the height of an individual line of text.

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