|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ReportObject
com.crystaldecisions.sdk.occa.report.definition.ChartObject
public class ChartObject
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 |
---|
public ChartObject(IChartObject src)
public ChartObject()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
clone
in class ReportObject
public void copyTo(java.lang.Object destObject, boolean deepCopy)
copyTo
in class ReportObject
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
ReportObject
For internal use only.
createMember
in class ReportObject
public void endElement(java.lang.String eleName, java.util.Map objState)
ReportObject
For internal use only.
endElement
in class ReportObject
public ChartDefinition getChartDefinition()
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.
getChartDefinition
in interface IChartObject
IChartDefinition
object that specifies the type of chart that appears on the
report.public int getChartGroupIndex()
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.
getChartGroupIndex
in interface IChartObject
int
that specifies in which group area to place the chart.public AreaSectionKind getChartReportArea()
IChartObject
Returns the AreaSectionKind
on the report where the chart is located.
A report consists of the following kinds of areas:
This section is generally used for the report title and other information you want to appear at the beginning of the report. It can also be used for charts that include data for the entire report.
This section is generally used for information that you want to appear at the top of each page. This can include such things as chapter names, the name of the document, and other similar information. This section can also be used to display field titles above the fields on a report.
This section is used for the body of the report and is printed once per record. The bulk of the report data generally appears in this section.
This section is used for information you want to appear only once at the end of the report (such as grand totals) and for charts that include data for the entire report.
This section usually contains the page number and any other information you want to appear on the bottom of each page.
If a group, summary, or subtotal is added to the report, the program creates two additional sections:
This section typically holds the group name field and can be used to display charts that include data specific to the group. It is printed once at the beginning of a group.
This section generally holds the summary value, if any, and can be used to display charts. It is printed once at the end of a group.
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.
getChartReportArea
in interface IChartObject
AreaSectionKind
object that specifies the area on the report where the
chart is located.public IChartStyle getChartStyle()
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.
getChartStyle
in interface IChartObject
IChartStyle
object that specifies the chart type that appears on the report.public boolean hasContent(java.lang.Object srcChartObject)
hasContent
in class ReportObject
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
ReportObject
For internal use only.
readElement
in class ReportObject
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
ReportObject
For internal use only.
save
in class ReportObject
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
ReportObject
For internal use only.
save
in class ReportObject
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
ReportObject
For internal use only.
saveContents
in class ReportObject
java.io.IOException
public void setChartDefinition(IChartDefinition chartDefinition)
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.
setChartDefinition
in interface IChartObject
chartDefinition
- An IChartDefinition
object that specifies the type of chart that appears on the
report.public void setChartGroupIndex(int chartGroupIndex)
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.
setChartGroupIndex
in interface IChartObject
chartGroupIndex
- An int
that specifies in which group area to place the chart.public void setChartReportArea(AreaSectionKind chartReportArea)
IChartObject
Sets the AreaSectionKind
on the report where the chart is located. A report
consists of the following kinds of areas:
This section is generally used for the report title and other information you want to appear . at the beginning of the report. It can also be used for charts that include data for the entire report.
This section is generally used for information that you want to appear at the top of each page. This can include such things as chapter names, the name of the document, and other similar information. This section can also be used to display field titles above the fields on a report.
This section is used for the body of the report and is printed once per record. The bulk of the report data generally appears in this section.
This section is used for information you want to appear only once at the end of the report (such as grand totals) and for charts that include data for the entire report.
This section usually contains the page number and any other information you want to appear on the bottom of each page.
If a group, summary, or subtotal is added to the report, the program creates two additional sections:
This section typically holds the group name field and can be used to display charts that include data specific to the group. It is printed once at the beginning of a group.
This section generally holds the summary value, if any, and can be used to display charts. It is printed once at the end of a group.
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.
setChartReportArea
in interface IChartObject
chartReportArea
- An AreaSectionKind
object that specifies the area on the report where the
chart is located.public void setChartStyle(IChartStyle chartStyle)
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.
setChartStyle
in interface IChartObject
chartStyle
- An IChartStyle
object that specifies the chart type that appears on the report.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
ReportObject
For internal use only.
startElement
in class ReportObject
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
doControllerModification
in class ReportObject
ReportSDKException
public void enumerateMembers(IMemberVisitor visitor)
enumerateMembers
in class ReportObject
public GraphicInstance getGraphicInstance()
getGraphicInstance
in interface IChartObject
public void setGraphicInstance(GraphicInstance graphicInstance)
setGraphicInstance
in interface IChartObject
public boolean isChartStyleChangedSinceSync()
public void resyncChartStyleFromGraphic()
public void updateSyncedChartStyle()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |