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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportObject
      extended by com.crystaldecisions.sdk.occa.report.definition.ChartObject
All Implemented Interfaces:
IChartObject, IReportObject, IClone

public class ChartObject
extends ReportObject
implements IChartObject, IClone

This object is used to determine how a chart will look when it appears on the report. It inherits properties and methods from the ReportObject object. As well as containing information about the chart's size and border, this object gives you access to the ChartDefinition object and the ChartStyle object. When possible, use the IChartObject interface.

NOTE: At this time, the RAS SDK does not support manipulating charts based on crosstabs or charts based on OLAP fields. You can only delete these objects.


Constructor Summary
ChartObject()
           
ChartObject(IChartObject 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)
           
 ChartDefinition getChartDefinition()
           Returns an IChartDefinition object.
 int getChartGroupIndex()
           Returns in which group area to place the chart.
 AreaSectionKind getChartReportArea()
           Returns the AreaSectionKind on the report where the chart is located.
 IChartStyle getChartStyle()
           Returns an IChartStyle object.
 GraphicInstance getGraphicInstance()
           
 boolean hasContent(java.lang.Object srcChartObject)
           
 boolean isChartStyleChangedSinceSync()
          for internal use only
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void resyncChartStyleFromGraphic()
          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 setChartDefinition(IChartDefinition chartDefinition)
           Returns an IChartDefinition object.
 void setChartGroupIndex(int chartGroupIndex)
           Sets in which group area to place the chart.
 void setChartReportArea(AreaSectionKind chartReportArea)
           Sets the AreaSectionKind on the report where the chart is located.
 void setChartStyle(IChartStyle chartStyle)
           Sets an IChartStyle object.
 void setGraphicInstance(GraphicInstance graphicInstance)
           
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 void updateSyncedChartStyle()
          for internal use only
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.definition.ReportObject
getBorder, getBorderMargins, getControllableMixin, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getVersion, getWidth, isDirectlyControllable, setBorder, setFormat, setHeight, setKind, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setVersion, setWidth
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.definition.IReportObject
getBorder, getBorderMargins, getFormat, getHeight, getKind, getLeft, getLinkedURI, getName, getReplacementConditionFormulas, getReportPartBookmark, getSectionCode, getSectionName, getTop, getWidth, setBorder, setFormat, setHeight, setLeft, setLinkedURI, setName, setReplacementConditionFormulas, setReportPartBookmark, setSectionCode, setSectionName, setTop, setWidth
 

Constructor Detail

ChartObject

public ChartObject(IChartObject src)

ChartObject

public ChartObject()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class ReportObject

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class ReportObject

createMember

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

For internal use only.

Overrides:
createMember in class ReportObject

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: ReportObject

For internal use only.

Overrides:
endElement in class ReportObject

getChartDefinition

public ChartDefinition getChartDefinition()
Description copied from interface: IChartObject

Returns an IChartDefinition object. The IChartDefinition object specifies the type of chart that appears on the report and defines the fields that are being charted on.

Specified by:
getChartDefinition in interface IChartObject
Returns:
An IChartDefinition object that specifies the type of chart that appears on the report.

getChartGroupIndex

public int getChartGroupIndex()
Description copied from interface: IChartObject

Returns in which group area to place the chart. Use the getChartReportArea method to determine if the chart appears in the report's group area. If it does, you can then use the setChartGroupIndex method to specify the group area in which to place the chart.

Specified by:
getChartGroupIndex in interface IChartObject
Returns:
An int that specifies in which group area to place the chart.

getChartReportArea

public AreaSectionKind getChartReportArea()
Description copied from interface: IChartObject

Returns the AreaSectionKind on the report where the chart is located. A report consists of the following kinds of areas:

If a group, summary, or subtotal is added to the report, the program creates two additional sections:

When a group, summary, or subtotal is added, the Group Header area appears directly above the Details area and the Group Footer area appears directly below the Details area.

If you set up additional groups, the program creates new group areas between the Details area and the existing Group Header and Group Footer area(s).

Like the original areas, each of these newly added areas can contain one or more sections. By default, they each contain a single section.

Specified by:
getChartReportArea in interface IChartObject
Returns:
An AreaSectionKind object that specifies the area on the report where the chart is located.

getChartStyle

public IChartStyle getChartStyle()
Description copied from interface: IChartObject

Returns an IChartStyle object. The IChartStyle object specifies the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote.

Specified by:
getChartStyle in interface IChartObject
Returns:
An IChartStyle object that specifies the chart type that appears on the report.

hasContent

public boolean hasContent(java.lang.Object srcChartObject)
Overrides:
hasContent in class ReportObject

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: ReportObject

For internal use only.

Overrides:
readElement in class ReportObject

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: ReportObject

For internal use only.

Overrides:
save in class ReportObject
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: ReportObject

For internal use only.

Overrides:
save in class ReportObject
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: ReportObject

For internal use only.

Overrides:
saveContents in class ReportObject
Throws:
java.io.IOException

setChartDefinition

public void setChartDefinition(IChartDefinition chartDefinition)
Description copied from interface: IChartObject

Returns an IChartDefinition object. The IChartDefinition object specifies the type of chart that appears on the report and defines the fields that are being charted on.

Specified by:
setChartDefinition in interface IChartObject
Parameters:
chartDefinition - An IChartDefinition object that specifies the type of chart that appears on the report.

setChartGroupIndex

public void setChartGroupIndex(int chartGroupIndex)
Description copied from interface: IChartObject

Sets in which group area to place the chart. Use the getChartReportArea method to determine if the chart appears in the report's group area. If it does, you can then use the setChartGroupIndex method to specify the group area in which to place the chart.

Specified by:
setChartGroupIndex in interface IChartObject
Parameters:
chartGroupIndex - An int that specifies in which group area to place the chart.

setChartReportArea

public void setChartReportArea(AreaSectionKind chartReportArea)
Description copied from interface: IChartObject

Sets the AreaSectionKind on the report where the chart is located. A report consists of the following kinds of areas:

If a group, summary, or subtotal is added to the report, the program creates two additional sections:

When a group, summary, or subtotal is added, the Group Header area appears directly above the Details area and the Group Footer area appears directly below the Details area.

If you set up additional groups, the program creates new group areas between the Details area and the existing Group Header and Group Footer area(s).

Like the original areas, each of these newly added areas can contain one or more sections. By default, they each contain a single section.

Specified by:
setChartReportArea in interface IChartObject
Parameters:
chartReportArea - An AreaSectionKind object that specifies the area on the report where the chart is located.

setChartStyle

public void setChartStyle(IChartStyle chartStyle)
Description copied from interface: IChartObject

Sets an IChartStyle object. The IChartStyle object specifies the chart type (for example, a bar chart or pie chart) that appears on the report and gives you access to the text options for the chart title, subtitle, and footnote.

Specified by:
setChartStyle in interface IChartObject
Parameters:
chartStyle - An IChartStyle object that specifies the chart type that appears on the report.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
Description copied from class: ReportObject

For internal use only.

Overrides:
startElement in class ReportObject

doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
Overrides:
doControllerModification in class ReportObject
Throws:
ReportSDKException

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
Overrides:
enumerateMembers in class ReportObject

getGraphicInstance

public GraphicInstance getGraphicInstance()
Specified by:
getGraphicInstance in interface IChartObject

setGraphicInstance

public void setGraphicInstance(GraphicInstance graphicInstance)
Specified by:
setGraphicInstance in interface IChartObject

isChartStyleChangedSinceSync

public boolean isChartStyleChangedSinceSync()
for internal use only


resyncChartStyleFromGraphic

public void resyncChartStyleFromGraphic()
for internal use only


updateSyncedChartStyle

public void updateSyncedChartStyle()
for internal use only