org.pepstock.charba.client.defaults.global

Class Title

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.FontItem

org.pepstock.charba.client.defaults.global.Title

public final class Title
extends FontItem

Configures the default chart title which defines text to draw at the top of the chart.
"weight"property is not present.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
FontStyle	getFontStyle() Returns the font style, follows CSS font-style options (i.e.
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.
boolean	isDisplay() Returns if the title is shown.
boolean	isFullWidth() Returns if marks that this box should take the full width of the canvas (pushing down other boxes)
void	setDisplay(boolean display) Sets if the title is shown.
void	setFullWidth(boolean fullWidth) 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.

Methods inherited from class org.pepstock.charba.client.defaults.FontItem

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

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

getFontStyle

public FontStyle getFontStyle()

Description copied from class: FontItem

Returns the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Overrides:

getFontStyle in class FontItem

Returns:

the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit). Default is Options.getDefaultFontStyle().

See Also:

FontStyle

setDisplay

public void setDisplay(boolean display)

Sets if the title is shown.

Parameters:

display - if the title is shown.

isDisplay

public boolean isDisplay()

Returns if the title is shown.

Returns:

if the title is shown. Default is true.

setPosition

public void setPosition(Position position)

Sets the position of title.

Parameters:

position - the position of title.

See Also:

Position

getPosition

public Position getPosition()

Returns the position of title.

Returns:

the position of title. Default is Position.top.

See Also:

Position

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.

Returns:

Padding to apply around labels. Only top and bottom are implemented. Default is 10.

setFullWidth

public void setFullWidth(boolean fullWidth)

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

Parameters:

fullWidth - Marks that this box should take the full width of the canvas (pushing down other boxes)

isFullWidth

public boolean isFullWidth()

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

Returns:

Marks that this box should take the full width of the canvas (pushing down other boxes). Default is true.

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.

Returns:

the height of an individual line of text. Default is 1.2