com.crystaldecisions.sdk.occa.report.definition
Interface IChartTextOptions

All Superinterfaces:
IClone
All Known Implementing Classes:
ChartTextOptions

public interface IChartTextOptions
extends IClone

This interface allows you to set and get the text options for the chart title, subtitle, and footnote.


Method Summary
 IFontColor getDataLabelFont()
           Returns the font used for the chart data label.
 java.lang.String getDataTitle()
           Returns the chart data title text.
 IFontColor getDataTitleFont()
           Returns the font used for the chart data title.
 java.lang.String getFootnote()
           Returns the chart footnote text.
 IFontColor getFootnoteFont()
           Returns the font used for the chart footnote.
 IFontColor getGroupLabelFont()
           Returns the font used for the chart group label.
 java.lang.String getGroupTitle()
           Returns the chart group title text.
 IFontColor getGroupTitleFont()
           Returns the font used for the chart group title.
 IFontColor getLegendFont()
           Returns the font used for the chart legend.
 IFontColor getSeriesLabelFont()
           Returns the font used for the chart series label.
 java.lang.String getSeriesTitle()
           Returns the chart series title text.
 IFontColor getSeriesTitleFont()
           Returns the font used for the chart series title.
 java.lang.String getSubtitle()
           Returns the chart subtitle text.
 IFontColor getSubtitleFont()
           Returns the font used for the chart subtitle.
 java.lang.String getTitle()
           Returns the chart title text.
 IFontColor getTitleFont()
           Returns the font used for the chart title.
 void setDataLabelFont(IFontColor dataLabelFont)
           Sets the font used for the chart data label.
 void setDataTitle(java.lang.String dataTitle)
           Sets the chart data title text.
 void setDataTitleFont(IFontColor dataTitleFont)
           Sets the font used for the chart series title.
 void setFootnote(java.lang.String footnote)
           Sets the chart footnote text.
 void setFootnoteFont(IFontColor footnoteFont)
           Sets the font used for the chart footnote.
 void setGroupLabelFont(IFontColor groupLabelFont)
           Sets the font used for the chart group label.
 void setGroupTitle(java.lang.String groupTitle)
           Sets the chart group title text.
 void setGroupTitleFont(IFontColor groupTitleFont)
           Sets the font used for the chart group title.
 void setLegendFont(IFontColor legendFont)
           Sets the font used for the chart legend.
 void setSeriesLabelFont(IFontColor seriesLabelFont)
           Sets the font used for the chart series label.
 void setSeriesTitle(java.lang.String seriesTitle)
           Sets the chart series title text.
 void setSeriesTitleFont(IFontColor seriesTitleFont)
           Sets the font used for the chart series title.
 void setSubtitle(java.lang.String subtitle)
           Sets the chart subtitle text.
 void setSubtitleFont(IFontColor subtitleFont)
           Sets the font used for the chart subtitle.
 void setTitle(java.lang.String title)
           Sets the chart title text.
 void setTitleFont(IFontColor titleFont)
           Sets the font used for the chart title.
 

Method Detail

getFootnote

java.lang.String getFootnote()

Returns the chart footnote text. By default, the footnote is placed at the bottom right corner of your chart.

Returns:
A String that specifies the chart footnote text.

getFootnoteFont

IFontColor getFootnoteFont()

Returns the font used for the chart footnote. The default color is black.

Returns:
An IFontColor object that specifies the font and color used for the chart footnote.

getSubtitle

java.lang.String getSubtitle()

Returns the chart subtitle text. A subtitle can provide additional information about your chart. By default, the subtitle is placed at the top center of your chart, directly below the chart title.

Returns:
A String containing the chart subtitle text.

getSubtitleFont

IFontColor getSubtitleFont()

Returns the font used for the chart subtitle. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart subtitle.

getTitle

java.lang.String getTitle()

Returns the chart title text. The title is placed at the top center of your chart.

Returns:
A String containing the chart title text.

getTitleFont

IFontColor getTitleFont()

Returns the font used for the chart title. The default color is black and style is bold.

Returns:
An IFontColor object that specifies the font and color used for the chart title.

setFootnote

void setFootnote(java.lang.String footnote)

Sets the chart footnote text. By default, the footnote is placed at the bottom right corner of your chart.

Parameters:
footnote - A String that specifies the chart footnote text.

setFootnoteFont

void setFootnoteFont(IFontColor footnoteFont)

Sets the font used for the chart footnote. The default color is black.

Parameters:
footnoteFont - An IFontColor object that specifies the font and color used for the chart footnote.

setSubtitle

void setSubtitle(java.lang.String subtitle)

Sets the chart subtitle text. A subtitle can provide additional information about your chart. By default, the subtitle is placed at the top center of your chart, directly below the chart title.

Parameters:
subtitle - A String containing the chart subtitle text.

setSubtitleFont

void setSubtitleFont(IFontColor subtitleFont)

Sets the font used for the chart subtitle. The default color is blue.

Parameters:
subtitleFont - An IFontColor object that specifies the font and color used for the chart subtitle.

setTitle

void setTitle(java.lang.String title)

Sets the chart title text. The title is placed at the top center of your chart.

Parameters:
title - A String containing the chart title text.

setTitleFont

void setTitleFont(IFontColor titleFont)

Sets the font used for the chart title. The default color is black and style is bold.

Parameters:
titleFont - An IFontColor object that specifies the font and color used for the chart title.

getGroupTitle

java.lang.String getGroupTitle()

Returns the chart group title text.

Returns:
A String containing the chart group title text.

setGroupTitle

void setGroupTitle(java.lang.String groupTitle)

Sets the chart group title text.

Parameters:
groupTitle - A String containing the chart group title text.

getSeriesTitle

java.lang.String getSeriesTitle()

Returns the chart series title text.

Returns:
A String containing the chart series title text.

setSeriesTitle

void setSeriesTitle(java.lang.String seriesTitle)

Sets the chart series title text.

Parameters:
seriesTitle - A String containing the chart series title text.

getDataTitle

java.lang.String getDataTitle()

Returns the chart data title text.

Returns:
A String containing the chart data title text.

setDataTitle

void setDataTitle(java.lang.String dataTitle)

Sets the chart data title text.

Parameters:
dataTitle - A String containing the chart data title text.

getGroupTitleFont

IFontColor getGroupTitleFont()

Returns the font used for the chart group title. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart group title.

setGroupTitleFont

void setGroupTitleFont(IFontColor groupTitleFont)

Sets the font used for the chart group title. The default color is blue.

Parameters:
groupTitleFont - An IFontColor object that specifies the font and color used for the chart group title.

getSeriesTitleFont

IFontColor getSeriesTitleFont()

Returns the font used for the chart series title. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart series title.

setSeriesTitleFont

void setSeriesTitleFont(IFontColor seriesTitleFont)

Sets the font used for the chart series title. The default color is blue.

Parameters:
seriesTitleFont - An IFontColor object that specifies the font and color used for the chart series title.

getDataTitleFont

IFontColor getDataTitleFont()

Returns the font used for the chart data title. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart data title.

setDataTitleFont

void setDataTitleFont(IFontColor dataTitleFont)

Sets the font used for the chart series title. The default color is blue.

Parameters:
dataTitleFont - An IFontColor object that specifies the font and color used for the chart data title.

getGroupLabelFont

IFontColor getGroupLabelFont()

Returns the font used for the chart group label. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart group label.

setGroupLabelFont

void setGroupLabelFont(IFontColor groupLabelFont)

Sets the font used for the chart group label. The default color is blue.

Parameters:
groupLabelFont - An IFontColor object that specifies the font and color used for the chart group label.

getDataLabelFont

IFontColor getDataLabelFont()

Returns the font used for the chart data label. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart data label.

setDataLabelFont

void setDataLabelFont(IFontColor dataLabelFont)

Sets the font used for the chart data label. The default color is blue.

Parameters:
dataLabelFont - An IFontColor object that specifies the font and color used for the chart data label.

getSeriesLabelFont

IFontColor getSeriesLabelFont()

Returns the font used for the chart series label. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart series label.

setSeriesLabelFont

void setSeriesLabelFont(IFontColor seriesLabelFont)

Sets the font used for the chart series label. The default color is blue.

Parameters:
seriesLabelFont - An IFontColor object that specifies the font and color used for the chart series label.

getLegendFont

IFontColor getLegendFont()

Returns the font used for the chart legend. The default color is blue.

Returns:
An IFontColor object that specifies the font and color used for the chart legend.

setLegendFont

void setLegendFont(IFontColor legendFont)

Sets the font used for the chart legend. The default color is blue.

Parameters:
legendFont - An IFontColor object that specifies the font and color used for the chart legend.