|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ChartTextOptions
public class ChartTextOptions
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 |
---|
public ChartTextOptions(IChartTextOptions src)
public ChartTextOptions()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
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.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public java.lang.String getFootnote()
IChartTextOptions
Returns the chart footnote text. By default, the footnote is placed at the bottom right corner of your chart.
getFootnote
in interface IChartTextOptions
String
that specifies the chart footnote text.public IFontColor getFootnoteFont()
IChartTextOptions
Returns the font used for the chart footnote. The default color is black.
getFootnoteFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart footnote.public java.lang.String getSubtitle()
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.
getSubtitle
in interface IChartTextOptions
String
containing the chart subtitle text.public IFontColor getSubtitleFont()
IChartTextOptions
Returns the font used for the chart subtitle. The default color is blue.
getSubtitleFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart subtitle.public java.lang.String getTitle()
IChartTextOptions
Returns the chart title text. The title is placed at the top center of your chart.
getTitle
in interface IChartTextOptions
String
containing the chart title text.public IFontColor getTitleFont()
IChartTextOptions
Returns the font used for the chart title. The default color is black and style is bold.
getTitleFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart title.public boolean hasContent(java.lang.Object srcChartTextOptions)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setFootnote(java.lang.String footnote)
IChartTextOptions
Sets the chart footnote text. By default, the footnote is placed at the bottom right corner of your chart.
setFootnote
in interface IChartTextOptions
footnote
- A String
that specifies the chart footnote text.public void setFootnoteFont(IFontColor footnoteFont)
IChartTextOptions
Sets the font used for the chart footnote. The default color is black.
setFootnoteFont
in interface IChartTextOptions
footnoteFont
- An IFontColor
object that specifies the font and color used for the chart footnote.public void setSubtitle(java.lang.String subtitle)
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.
setSubtitle
in interface IChartTextOptions
subtitle
- A String
containing the chart subtitle text.public void setSubtitleFont(IFontColor subtitleFont)
IChartTextOptions
Sets the font used for the chart subtitle. The default color is blue.
setSubtitleFont
in interface IChartTextOptions
subtitleFont
- An IFontColor
object that specifies the font and color used for the chart subtitle.public void setTitle(java.lang.String title)
IChartTextOptions
Sets the chart title text. The title is placed at the top center of your chart.
setTitle
in interface IChartTextOptions
title
- A String
containing the chart title text.public void setTitleFont(IFontColor titleFont)
IChartTextOptions
Sets the font used for the chart title. The default color is black and style is bold.
setTitleFont
in interface IChartTextOptions
titleFont
- An IFontColor
object that specifies the font and color used for the chart title.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public IFontColor getDataLabelFont()
IChartTextOptions
Returns the font used for the chart data label. The default color is blue.
getDataLabelFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart data label.public IFontColor getSeriesLabelFont()
IChartTextOptions
Returns the font used for the chart series label. The default color is blue.
getSeriesLabelFont
in interface IChartTextOptions
IFontColor
object that specifies the font and
color used for the chart series label.public IFontColor getDataTitleFont()
IChartTextOptions
Returns the font used for the chart data title. The default color is blue.
getDataTitleFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart data title.public IFontColor getGroupLabelFont()
IChartTextOptions
Returns the font used for the chart group label. The default color is blue.
getGroupLabelFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart group label.public java.lang.String getGroupTitle()
IChartTextOptions
Returns the chart group title text.
getGroupTitle
in interface IChartTextOptions
String
containing the chart group title text.public IFontColor getGroupTitleFont()
IChartTextOptions
Returns the font used for the chart group title. The default color is blue.
getGroupTitleFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart group title.public IFontColor getLegendFont()
IChartTextOptions
Returns the font used for the chart legend. The default color is blue.
getLegendFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart legend.public java.lang.String getSeriesTitle()
IChartTextOptions
Returns the chart series title text.
getSeriesTitle
in interface IChartTextOptions
String
containing the chart series title text.public IFontColor getSeriesTitleFont()
IChartTextOptions
Returns the font used for the chart series title. The default color is blue.
getSeriesTitleFont
in interface IChartTextOptions
IFontColor
object that specifies the font and color used for the chart series title.public void setDataTitle(java.lang.String DataTitle)
IChartTextOptions
Sets the chart data title text.
setDataTitle
in interface IChartTextOptions
DataTitle
- A String
containing the chart data title text.public void setDataLabelFont(IFontColor dataLabelFont)
IChartTextOptions
Sets the font used for the chart data label. The default color is blue.
setDataLabelFont
in interface IChartTextOptions
dataLabelFont
- An IFontColor
object that specifies the font and color used for the chart data label.public void setSeriesLabelFont(IFontColor seriesLabelFont)
IChartTextOptions
Sets the font used for the chart series label. The default color is blue.
setSeriesLabelFont
in interface IChartTextOptions
seriesLabelFont
- An IFontColor
object that specifies the font and
color used for the chart series label.public void setDataTitleFont(IFontColor dataTitleFont)
IChartTextOptions
Sets the font used for the chart series title. The default color is blue.
setDataTitleFont
in interface IChartTextOptions
dataTitleFont
- An IFontColor
object that specifies the font and color used for the chart data title.public void setGroupLabelFont(IFontColor groupLabelFont)
IChartTextOptions
Sets the font used for the chart group label. The default color is blue.
setGroupLabelFont
in interface IChartTextOptions
groupLabelFont
- An IFontColor
object that specifies the font and color used for the chart group label.public void setGroupTitle(java.lang.String groupTitle)
IChartTextOptions
Sets the chart group title text.
setGroupTitle
in interface IChartTextOptions
groupTitle
- A String
containing the chart group title text.public void setGroupTitleFont(IFontColor groupTitleFont)
IChartTextOptions
Sets the font used for the chart group title. The default color is blue.
setGroupTitleFont
in interface IChartTextOptions
groupTitleFont
- An IFontColor
object that specifies the font and color used for the chart group title.public void setSeriesTitleFont(IFontColor seriesTitleFont)
IChartTextOptions
Sets the font used for the chart series title. The default color is blue.
setSeriesTitleFont
in interface IChartTextOptions
seriesTitleFont
- An IFontColor
object that specifies the font and color used for the chart series title.public void setLegendFont(IFontColor legendFont)
IChartTextOptions
Sets the font used for the chart legend. The default color is blue.
setLegendFont
in interface IChartTextOptions
legendFont
- An IFontColor
object that specifies the font and color used for the chart legend.public void setSeriesTitle(java.lang.String seriesTitle)
IChartTextOptions
Sets the chart series title text.
setSeriesTitle
in interface IChartTextOptions
seriesTitle
- A String
containing the chart series title text.public java.lang.String getDataTitle()
IChartTextOptions
Returns the chart data title text.
getDataTitle
in interface IChartTextOptions
String
containing the chart data title text.public void doControllerModification(java.lang.Object newObject)
public ControllableMixin getControllableMixin()
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |