Klasse ChartTitle

java.lang.Object

com.inet.report.chart.ChartTitle

Alle implementierten Schnittstellen:

Serializable

public class ChartTitle
extends Object
implements Serializable

A chart title that displays a text string with defined font and color.

Seit:

8.0

Siehe auch:

• Serialisierte Form

Feldübersicht

Felder

Modifikator und Typ	Feld	Beschreibung
static final String	TOKEN_AXIS	The XML token for an axis title.
static final String	TOKEN_FOOTNOTE	The XML token for a footnote title.
static final String	TOKEN_HEADER	The XML token for a header title.
static final String	TOKEN_SUBTITLE	The XML token for a subtitle.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ChartTitle(Font titleFont, int color)	Creates a chart title with the given properties.

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
ChartTitle	clone()
int	getColor()	Returns the ABGR value of color for this title.
Font	getFont()	Returns the font of the label.
String	getTitle()	Returns this title's text.
FormulaField	getTitleFormula()	Returns the property formula for the chart title, if it is specified.
boolean	isEqualToDefault(ChartTitle defaultTitle)	Returns true if this title is equal to default.
boolean	isShowAutoTitle()	Returns whether or not this title is to be an automatically generated label.
void	readProperties(Element element, Chart2 chart)	Reads the XML properties of a chart title.
void	saveProperties(StringBuilder buffer, String type, int depth)	Writes the properties of the title to PrintWriter.
void	setColor(int titleColor)	Sets the ABGR value of color for this title.
void	setFont(Font titleFont)	Sets the font of the label.
void	setShowAutoTitle(boolean showAutoTitle)	Sets whether or not this title is to be an automatically generated label.
void	setTitle(String title)	Sets this title. Note: to use this property turn off the showing of auto title.
void	setTitleFormula(FormulaField titleFormula)	Sets the formula which returns the title.

Von Klasse geerbte Methoden Object

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

Felddetails

TOKEN_HEADER

public static final String TOKEN_HEADER

The XML token for a header title.

Siehe auch:

• Konstantenfeldwerte

TOKEN_SUBTITLE

public static final String TOKEN_SUBTITLE

The XML token for a subtitle.

Siehe auch:

• Konstantenfeldwerte

TOKEN_FOOTNOTE

public static final String TOKEN_FOOTNOTE

The XML token for a footnote title.

Siehe auch:

• Konstantenfeldwerte

TOKEN_AXIS

public static final String TOKEN_AXIS

The XML token for an axis title.

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

ChartTitle

public ChartTitle(Font titleFont,
 int color)

Creates a chart title with the given properties.

Parameter:

titleFont - the title font

color - the title color

Seit:

8.0

Methodendetails

isShowAutoTitle

public boolean isShowAutoTitle()

Returns whether or not this title is to be an automatically generated label.

Gibt zurück:

whether or not this title is to be an automatically generated label

Seit:

8.0

Siehe auch:

• setShowAutoTitle(boolean)

setShowAutoTitle

public void setShowAutoTitle(boolean showAutoTitle)

Sets whether or not this title is to be an automatically generated label.

Parameter:

showAutoTitle - whether or not the title is to be automatically generated

Seit:

8.0

Siehe auch:

• isShowAutoTitle()

getTitle

public String getTitle()

Returns this title's text. If this title has been set to show an automatically generated label, this will show the automatically generated text, otherwise this will show the title set with setTitle.

Gibt zurück:

the title text

Seit:

8.0

Siehe auch:

• setTitle(String)
• setShowAutoTitle(boolean)
• setAutoTitle(String)

setTitle

public void setTitle(String title)

Sets this title.
Note: to use this property turn off the showing of auto title.

Parameter:

title - the label (null not permitted)

Seit:

8.0

Siehe auch:

• getTitle()
• setShowAutoTitle(boolean)

getColor

public int getColor()

Returns the ABGR value of color for this title.

Gibt zurück:

the ABGR value representing the label color.

Seit:

8.0

Siehe auch:

• ColorUtils.toJavaColor(int)
• setColor(int)

setColor

public void setColor(int titleColor)

Sets the ABGR value of color for this title.

Parameter:

titleColor - ABGR components of the color

Löst aus:

IllegalArgumentException - by RDC.COLOR_NO_COLOR.

Seit:

8.0

Siehe auch:

• ColorUtils.toCcColor(Color)
• getColor()

getFont

public Font getFont()

Returns the font of the label.

Gibt zurück:

the font.

Seit:

8.0

Siehe auch:

• setFont(Font)

setFont

public void setFont(Font titleFont)

Sets the font of the label.

Parameter:

titleFont - the label font (null not permitted)

Seit:

8.0

Siehe auch:

• getFont()

isEqualToDefault

public boolean isEqualToDefault(ChartTitle defaultTitle)

Returns true if this title is equal to default.

Parameter:

defaultTitle - the default title

Gibt zurück:

true if equal to default.

Seit:

8.0

saveProperties

public void saveProperties(StringBuilder buffer,
 String type,
 int depth)

Writes the properties of the title to PrintWriter.

Parameter:

buffer - the output

type - the type of this title: header, footer or subtitle

depth - the depth of XML indent

Seit:

8.0

Siehe auch:

• TOKEN_HEADER
• TOKEN_FOOTNOTE
• TOKEN_SUBTITLE

readProperties

public void readProperties(Element element,
 Chart2 chart)

Reads the XML properties of a chart title.

Parameter:

element - DOM element

chart - the current chart

Seit:

8.0

Siehe auch:

• saveProperties(StringBuilder, String, int)

clone

public ChartTitle clone()

Setzt außer Kraft:

clone in Klasse Object

setTitleFormula

public void setTitleFormula(FormulaField titleFormula)

Sets the formula which returns the title. Note that this formula is only used when showAutoTitle is off.

Parameter:

titleFormula - the formula foe the title

Seit:

i-net Clear Reports 12.0

getTitleFormula

public FormulaField getTitleFormula()

Returns the property formula for the chart title, if it is specified.

Gibt zurück:

the formula or can be null.

Seit:

i-net Clear Reports 12.0