com.crystaldecisions.sdk.occa.report.definition
Class ChartTextOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ChartTextOptions
All Implemented Interfaces:
IChartTextOptions, IClone

public class ChartTextOptions
extends java.lang.Object
implements IChartTextOptions, IClone

This object allows you to set and get the text options for the chart title, subtitle, and footnote. When possible, use the IChartTextOptions interface.


Constructor Summary
ChartTextOptions()
           
ChartTextOptions(IChartTextOptions src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 ControllableMixin getControllableMixin()
           
 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.
 boolean hasContent(java.lang.Object srcChartTextOptions)
           
 boolean isDirectlyControllable()
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 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.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChartTextOptions

public ChartTextOptions(IChartTextOptions src)

ChartTextOptions

public ChartTextOptions()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getFootnote

public java.lang.String getFootnote()
Description copied from interface: IChartTextOptions

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

Specified by:
getFootnote in interface IChartTextOptions
Returns:
A String that specifies the chart footnote text.

getFootnoteFont

public IFontColor getFootnoteFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getFootnoteFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart footnote.

getSubtitle

public java.lang.String getSubtitle()
Description copied from interface: IChartTextOptions

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.

Specified by:
getSubtitle in interface IChartTextOptions
Returns:
A String containing the chart subtitle text.

getSubtitleFont

public IFontColor getSubtitleFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getSubtitleFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart subtitle.

getTitle

public java.lang.String getTitle()
Description copied from interface: IChartTextOptions

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

Specified by:
getTitle in interface IChartTextOptions
Returns:
A String containing the chart title text.

getTitleFont

public IFontColor getTitleFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getTitleFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart title.

hasContent

public boolean hasContent(java.lang.Object srcChartTextOptions)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setFootnote

public void setFootnote(java.lang.String footnote)
Description copied from interface: IChartTextOptions

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

Specified by:
setFootnote in interface IChartTextOptions
Parameters:
footnote - A String that specifies the chart footnote text.

setFootnoteFont

public void setFootnoteFont(IFontColor footnoteFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setFootnoteFont in interface IChartTextOptions
Parameters:
footnoteFont - An IFontColor object that specifies the font and color used for the chart footnote.

setSubtitle

public void setSubtitle(java.lang.String subtitle)
Description copied from interface: IChartTextOptions

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.

Specified by:
setSubtitle in interface IChartTextOptions
Parameters:
subtitle - A String containing the chart subtitle text.

setSubtitleFont

public void setSubtitleFont(IFontColor subtitleFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setSubtitleFont in interface IChartTextOptions
Parameters:
subtitleFont - An IFontColor object that specifies the font and color used for the chart subtitle.

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: IChartTextOptions

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

Specified by:
setTitle in interface IChartTextOptions
Parameters:
title - A String containing the chart title text.

setTitleFont

public void setTitleFont(IFontColor titleFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setTitleFont in interface IChartTextOptions
Parameters:
titleFont - An IFontColor object that specifies the font and color used for the chart title.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


getDataLabelFont

public IFontColor getDataLabelFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getDataLabelFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart data label.

getSeriesLabelFont

public IFontColor getSeriesLabelFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getSeriesLabelFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart series label.

getDataTitleFont

public IFontColor getDataTitleFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getDataTitleFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart data title.

getGroupLabelFont

public IFontColor getGroupLabelFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getGroupLabelFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart group label.

getGroupTitle

public java.lang.String getGroupTitle()
Description copied from interface: IChartTextOptions

Returns the chart group title text.

Specified by:
getGroupTitle in interface IChartTextOptions
Returns:
A String containing the chart group title text.

getGroupTitleFont

public IFontColor getGroupTitleFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getGroupTitleFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart group title.

getLegendFont

public IFontColor getLegendFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getLegendFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart legend.

getSeriesTitle

public java.lang.String getSeriesTitle()
Description copied from interface: IChartTextOptions

Returns the chart series title text.

Specified by:
getSeriesTitle in interface IChartTextOptions
Returns:
A String containing the chart series title text.

getSeriesTitleFont

public IFontColor getSeriesTitleFont()
Description copied from interface: IChartTextOptions

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

Specified by:
getSeriesTitleFont in interface IChartTextOptions
Returns:
An IFontColor object that specifies the font and color used for the chart series title.

setDataTitle

public void setDataTitle(java.lang.String DataTitle)
Description copied from interface: IChartTextOptions

Sets the chart data title text.

Specified by:
setDataTitle in interface IChartTextOptions
Parameters:
DataTitle - A String containing the chart data title text.

setDataLabelFont

public void setDataLabelFont(IFontColor dataLabelFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setDataLabelFont in interface IChartTextOptions
Parameters:
dataLabelFont - An IFontColor object that specifies the font and color used for the chart data label.

setSeriesLabelFont

public void setSeriesLabelFont(IFontColor seriesLabelFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setSeriesLabelFont in interface IChartTextOptions
Parameters:
seriesLabelFont - An IFontColor object that specifies the font and color used for the chart series label.

setDataTitleFont

public void setDataTitleFont(IFontColor dataTitleFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setDataTitleFont in interface IChartTextOptions
Parameters:
dataTitleFont - An IFontColor object that specifies the font and color used for the chart data title.

setGroupLabelFont

public void setGroupLabelFont(IFontColor groupLabelFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setGroupLabelFont in interface IChartTextOptions
Parameters:
groupLabelFont - An IFontColor object that specifies the font and color used for the chart group label.

setGroupTitle

public void setGroupTitle(java.lang.String groupTitle)
Description copied from interface: IChartTextOptions

Sets the chart group title text.

Specified by:
setGroupTitle in interface IChartTextOptions
Parameters:
groupTitle - A String containing the chart group title text.

setGroupTitleFont

public void setGroupTitleFont(IFontColor groupTitleFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setGroupTitleFont in interface IChartTextOptions
Parameters:
groupTitleFont - An IFontColor object that specifies the font and color used for the chart group title.

setSeriesTitleFont

public void setSeriesTitleFont(IFontColor seriesTitleFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setSeriesTitleFont in interface IChartTextOptions
Parameters:
seriesTitleFont - An IFontColor object that specifies the font and color used for the chart series title.

setLegendFont

public void setLegendFont(IFontColor legendFont)
Description copied from interface: IChartTextOptions

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

Specified by:
setLegendFont in interface IChartTextOptions
Parameters:
legendFont - An IFontColor object that specifies the font and color used for the chart legend.

setSeriesTitle

public void setSeriesTitle(java.lang.String seriesTitle)
Description copied from interface: IChartTextOptions

Sets the chart series title text.

Specified by:
setSeriesTitle in interface IChartTextOptions
Parameters:
seriesTitle - A String containing the chart series title text.

getDataTitle

public java.lang.String getDataTitle()
Description copied from interface: IChartTextOptions

Returns the chart data title text.

Specified by:
getDataTitle in interface IChartTextOptions
Returns:
A String containing the chart data title text.

doControllerModification

public void doControllerModification(java.lang.Object newObject)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)