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()
          For internal use only
 java.lang.String getDataTitle()
          For internal use only
 IFontColor getDataTitleFont()
          For internal use only
 java.lang.String getFootnote()
           Returns the chart footnote text.
 IFontColor getFootnoteFont()
           Returns the font used for the chart footnote.
 IFontColor getGroupLabelFont()
          For internal use only
 java.lang.String getGroupTitle()
          For internal use only
 IFontColor getGroupTitleFont()
          For internal use only
 IFontColor getLegendFont()
          For internal use only
 IFontColor getSeriesLabelFont()
          For internal use only
 java.lang.String getSeriesTitle()
          For internal use only
 IFontColor getSeriesTitleFont()
          For internal use only
 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)
          For internal use only
 void setDataTitle(java.lang.String dataTitle)
          For internal use only
 void setDataTitleFont(IFontColor dataTitleFont)
          For internal use only
 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)
          For internal use only
 void setGroupTitle(java.lang.String groupTitle)
          For internal use only
 void setGroupTitleFont(IFontColor groupTitleFont)
          For internal use only
 void setLegendFont(IFontColor legendFont)
          For internal use only
 void setSeriesLabelFont(IFontColor seriesLabelFont)
          For internal use only
 void setSeriesTitle(java.lang.String seriesTitle)
          For internal use only
 void setSeriesTitleFont(IFontColor seriesTitleFont)
          For internal use only
 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()
For internal use only


setGroupTitle

void setGroupTitle(java.lang.String groupTitle)
For internal use only


getSeriesTitle

java.lang.String getSeriesTitle()
For internal use only


setSeriesTitle

void setSeriesTitle(java.lang.String seriesTitle)
For internal use only


getDataTitle

java.lang.String getDataTitle()
For internal use only


setDataTitle

void setDataTitle(java.lang.String dataTitle)
For internal use only


getGroupTitleFont

IFontColor getGroupTitleFont()
For internal use only


setGroupTitleFont

void setGroupTitleFont(IFontColor groupTitleFont)
For internal use only


getSeriesTitleFont

IFontColor getSeriesTitleFont()
For internal use only


setSeriesTitleFont

void setSeriesTitleFont(IFontColor seriesTitleFont)
For internal use only


getDataTitleFont

IFontColor getDataTitleFont()
For internal use only


setDataTitleFont

void setDataTitleFont(IFontColor dataTitleFont)
For internal use only


getGroupLabelFont

IFontColor getGroupLabelFont()
For internal use only


setGroupLabelFont

void setGroupLabelFont(IFontColor groupLabelFont)
For internal use only


getDataLabelFont

IFontColor getDataLabelFont()
For internal use only


setDataLabelFont

void setDataLabelFont(IFontColor dataLabelFont)
For internal use only


getSeriesLabelFont

IFontColor getSeriesLabelFont()
For internal use only


setSeriesLabelFont

void setSeriesLabelFont(IFontColor seriesLabelFont)
For internal use only


getLegendFont

IFontColor getLegendFont()
For internal use only


setLegendFont

void setLegendFont(IFontColor legendFont)
For internal use only