com.crystaldecisions.sdk.occa.report.partsdefinition
Class ReportPartsDefinition

java.lang.Object
  |
  +--com.crystaldecisions.sdk.occa.report.partsdefinition.ReportPartsDefinition

public class ReportPartsDefinition

extends java.lang.Object

This class defines which report objects to display in the CrystalReportPartsViewer.

This object is used to set the setReportParts method of the CrystalReportPartsViewer object.

See the Getting Started > Tutorials section of the Viewer Java SDK Guide for an example of how to use the ReportPartsDefinition class.

Constructor Summary

ReportPartsDefinition()

Method Summary

boolean	containsReportPartIDs(ReportPartIDs ids) For internal use only.
ReportPartIDs	findDrillDownParts(java.lang.String name) For internal use only.
java.lang.String	getDataContext() Returns the data sub tree of the report where the engine should start to look for the report object.
ReportPartNode	getParentNode(java.lang.String name) For internal use only.
ReportPartIDs	getReportPartIDs() For internal use only.
ReportPartNodes	getReportPartNodes() Returns the parent collection of ReportPartNodes containing the information representing all the levels of drill down.
java.lang.String	getTitle() Returns the title displayed at the top of the CrystalReportPartsViewer.
void	setDataContext(java.lang.String dataContext) Sets the data sub tree of the report where the engine should start to look for the report object.
void	setReportPartNodes(ReportPartNodes nodes) Sets the parent collection of ReportPartNodes containing the information representing all the levels of drill down.
void	setTitle(java.lang.String newTitle) Sets the title displayed at the top of the CrystalReportPartsViewer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportPartsDefinition

public ReportPartsDefinition()

Method Detail

containsReportPartIDs

public boolean containsReportPartIDs(ReportPartIDs ids)

For internal use only.

findDrillDownParts

public ReportPartIDs findDrillDownParts(java.lang.String name)

For internal use only.

getDataContext

public java.lang.String getDataContext()

Returns the data sub tree of the report where the engine should start to look for the report object.

Returns:

The data sub tree of the report as a String.

See Also:

setDataContext

getParentNode

public ReportPartNode getParentNode(java.lang.String name)

For internal use only.

getReportPartIDs

public ReportPartIDs getReportPartIDs()

For internal use only.

getReportPartNodes

public ReportPartNodes getReportPartNodes()

Returns the parent collection of ReportPartNodes containing the information representing all the levels of drill down.

Note: The parent ReportPartNodes collection contains one or more ReportPartNode objects that may contain ReportPartNodes collections defining the lower drill-down paths.

Returns:

The parent collection of ReportPartNodes.

See Also:

setReportPartNodes

getTitle

public java.lang.String getTitle()

Returns the title displayed at the top of the CrystalReportPartsViewer.

Returns:

The title displayed at the top of the CrystalReportPartsViewer as a String.

See Also:

setTitle

setDataContext

public void setDataContext(java.lang.String dataContext)

Sets the data sub tree of the report where the engine should start to look for the report object.

Note: The data context can be specified using either strings or integers to describe the report nodes.

Parameters:

dataContext - A String that specifies the data sub tree of the report.

See Also:

getDataContext

setReportPartNodes

public void setReportPartNodes(ReportPartNodes nodes)

Sets the parent collection of ReportPartNodes containing the information representing all the levels of drill down.

Note: The parent ReportPartNodes collection contains one or more ReportPartNode objects that may contain ReportPartNodes collections defining the lower drill-down paths.

Parameters:

nodes - the ReportPartNodes object to associate with the ReportPartsDefinition object

See Also:

getReportPartNodes

setTitle

public void setTitle(java.lang.String newTitle)

Sets the title displayed at the top of the CrystalReportPartsViewer.

Note:

• The setDisplayTitle method of the CrystalReportPartsViewer class must be set to true in order to display the title.
• The title can also be set using the setReportTitle method of the CrystalReportPartsViewer class.
• The setReportTitle method overrides the setTitle method.

Parameters:

newTitle - A String that specifies the title displayed at the top of the CrystalReportPartsViewer.

See Also:

getTitle