Package org.primefaces.model.charts.optionconfig.title

Class Title

java.lang.Object

org.primefaces.model.charts.optionconfig.title.Title

All Implemented Interfaces:

Serializable

public class Title
extends Object
implements Serializable

The title configuration is passed into the options.title namespace.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Title()

Method Summary

Modifier and Type	Method	Description
String	encode()	Write the options of Title
String	getFontColor()	Gets the fontColor
String	getFontFamily()	Gets the fontFamily
Number	getFontSize()	Gets the fontSize
String	getFontStyle()	Gets the fontStyle
Object	getLineHeight()	Gets the lineHeight
Number	getPadding()	Gets the padding
String	getPosition()	Gets the position
Object	getText()	Gets the text
boolean	isDisplay()	Gets the display
void	setDisplay(boolean display)	Sets the display
void	setFontColor(String fontColor)	Sets the fontColor
void	setFontFamily(String fontFamily)	Sets the fontFamily
void	setFontSize(Number fontSize)	Sets the fontSize
void	setFontStyle(String fontStyle)	Sets the fontStyle
void	setLineHeight(Object lineHeight)	Sets the lineHeight
void	setPadding(Number padding)	Sets the padding
void	setPosition(String position)	Sets the position
void	setText(Object text)	Sets the text

Methods inherited from class java.lang.Object

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

Constructor Detail

Title

public Title()

Method Detail

isDisplay

public boolean isDisplay()

Gets the display

Returns:

display

setDisplay

public void setDisplay(boolean display)

Sets the display

Parameters:

display - is the title shown

getPosition

public String getPosition()

Gets the position

Returns:

position

setPosition

public void setPosition(String position)

Sets the position

Parameters:

position - Position of title.

getFontSize

public Number getFontSize()

Gets the fontSize

Returns:

fontSize

setFontSize

public void setFontSize(Number fontSize)

Sets the fontSize

Parameters:

fontSize - Font size

getFontFamily

public String getFontFamily()

Gets the fontFamily

Returns:

fontFamily

setFontFamily

public void setFontFamily(String fontFamily)

Sets the fontFamily

Parameters:

fontFamily - Font family for the title text.

getFontColor

public String getFontColor()

Gets the fontColor

Returns:

fontColor

setFontColor

public void setFontColor(String fontColor)

Sets the fontColor

Parameters:

fontColor - Font color

getFontStyle

public String getFontStyle()

Gets the fontStyle

Returns:

fontStyle

setFontStyle

public void setFontStyle(String fontStyle)

Sets the fontStyle

Parameters:

fontStyle - Font style

getPadding

public Number getPadding()

Gets the padding

Returns:

padding

setPadding

public void setPadding(Number padding)

Sets the padding

Parameters:

padding - Number of pixels to add above and below the title text.

getLineHeight

public Object getLineHeight()

Gets the lineHeight

Returns:

lineHeight

setLineHeight

public void setLineHeight(Object lineHeight)

Sets the lineHeight

Parameters:

lineHeight - Height of an individual line of text

getText

public Object getText()

Gets the text

Returns:

text

setText

public void setText(Object text)

Sets the text

Parameters:

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

encode

public String encode()
              throws IOException

Write the options of Title

Returns:

options as JSON object

Throws:

IOException - If an I/O error occurs