Package com.storedobject.chart

Class Title

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.Title

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasPosition, VisibleProperty

public class Title
extends VisiblePart
implements Component, HasPosition

Title for the chart. If you are adding more than one title, please make sure that you set appropriate positions to eliminate overlap.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Title(String text)	Create a title with a given text.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final int	getGap()	Get the gap between title and sub-title.
final Position	getPosition(boolean create)	Get the position of this on the chart display area.
String	getSubtext()	Get the sub-text that will be shown as the sub-title in the second line.
final TextStyle	getSubtextStyle(boolean create)	Get the sub-text style.
String	getText()	Get the text of the title.
final TextStyle	getTextStyle(boolean create)	Get the text style.
void	setGap(int gap)	Set the gap between title and sub-title.
final void	setPosition(Position position)	Set the position of this.
void	setSubtext(String subtext)	Set the sub-text that will be shown as the sub-title in the second line.
void	setSubtextStyle(TextStyle textStyle)	Set the sub-text style.
void	setText(String text)	Set the text of the title.
void	setTextStyle(TextStyle textStyle)	Set the text style.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.VisiblePart

isVisible, setVisible

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.Component

addParts

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getName, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

Title

public Title(String text)

Create a title with a given text.

Parameters:

text - Text to display as title.

Method Details

getText

public String getText()

Get the text of the title.

Returns:

Title text.

setText

public void setText(String text)

Set the text of the title.

Parameters:

text - Text of the title.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

validate

public void validate()

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Overrides:

validate in class VisiblePart

getSubtext

public String getSubtext()

Get the sub-text that will be shown as the sub-title in the second line.

Returns:

Text of the sub-title. It could be null.

setSubtext

public void setSubtext(String subtext)

Set the sub-text that will be shown as the sub-title in the second line.

Parameters:

subtext - Text of the sub-title. It could be null.

getPosition

public final Position getPosition(boolean create)

Description copied from interface: HasPosition

Get the position of this on the chart display area. (If true is passed as the parameter, a new position will be created if not already exists).

Specified by:

getPosition in interface HasPosition

Parameters:

create - Whether to create it or not.

Returns:

Position.

setPosition

public final void setPosition(Position position)

Description copied from interface: HasPosition

Set the position of this.

Specified by:

setPosition in interface HasPosition

Parameters:

position - Position to set.

getTextStyle

public final TextStyle getTextStyle(boolean create)

Get the text style.

Parameters:

create - Whether to create if not exists or not.

Returns:

Text style.

setTextStyle

public void setTextStyle(TextStyle textStyle)

Set the text style.

Parameters:

textStyle - Text style to set.

getSubtextStyle

public final TextStyle getSubtextStyle(boolean create)

Get the sub-text style.

Parameters:

create - Whether to create if not exists or not.

Returns:

Text style.

setSubtextStyle

public void setSubtextStyle(TextStyle textStyle)

Set the sub-text style.

Parameters:

textStyle - Text style to set.

getGap

public final int getGap()

Get the gap between title and sub-title.

Returns:

Gap in pixels.

setGap

public void setGap(int gap)

Set the gap between title and sub-title.

Parameters:

gap - Gap in pixels.