com.crystaldecisions.sdk.occa.report.definition
Interface IReportDefinition

All Superinterfaces:
IClone
All Known Implementing Classes:
ReportDefinition

public interface IReportDefinition
extends IClone

This interface is used to get and set the values that define a particular report. It contains all of the information needed for the report's format and the content that populates a report. By default, a new report contains five area objects: the Report Header area, the Page Header area, the Details area, the Report Footer area, and the Page Footer area.

Report objects require a data source from which the report objects can retrieve the proper information to populate specified fields in the report. The IDataDefinition interface is used to specify how and where the information taken from the DataDefinition object is formatted and placed in a report.

See Also:
IArea

Method Summary
 IArea findAreaByName(java.lang.String name)
           
 IReportObject findObjectByName(java.lang.String name)
           Returns an IReportObject when the name of the report object is specified.
 ISection findSectionByName(java.lang.String name)
           Returns an ISection when the name of the report section is specified.
 Areas getAreas()
           Returns the collection of Area objects that specifies the areas used for the report object.
 IArea getDetailArea()
           Returns the detail area as an IArea.
 IArea getGroupFooterArea(int index)
           Returns the GroupFooterArea as an IArea.
 IArea getGroupHeaderArea(int index)
           Returns the GroupHeaderArea as an IArea.
 IArea getPageFooterArea()
           Returns the PageFooterArea as an IArea.
 IArea getPageHeaderArea()
           Returns the PageHeaderArea as an IArea.
 IArea getReportFooterArea()
           Returns the ReportFooterArea as an IArea.
 IArea getReportHeaderArea()
           Returns the ReportHeaderArea as an IArea.
 ReportStyle getReportStyle()
           For internal use only.
 void setAreas(Areas areas)
           Sets the collection of Area objects that specifies the areas used for the report object.
 void setReportStyle(ReportStyle reportStyle)
           For internal use only.
 

Method Detail

getAreas

Areas getAreas()

Returns the collection of Area objects that specifies the areas used for the report object.

Returns:
The Areas collection that specifies the areas used for the report object.

getReportStyle

ReportStyle getReportStyle()

For internal use only.


setAreas

void setAreas(Areas areas)

Sets the collection of Area objects that specifies the areas used for the report object.

Parameters:
areas - The Areas collection that specifies the areas used for the report object.

setReportStyle

void setReportStyle(ReportStyle reportStyle)

For internal use only.


findObjectByName

IReportObject findObjectByName(java.lang.String name)

Returns an IReportObject when the name of the report object is specified. The specified name is not case-sensitive.

Example:

This sample shows how to retrieve and modify a subreport. Properties that can be modified include the height, width, and position of the subreport.

 ReportDefController reportDefController = clientDoc.getReportDefController();
 ReportDefinition reportDefinition = reportDefController.getReportDefinition();
 SubreportObject subreport = (SubreportObject)reportDefinition.findObjectByName("reportObjectName");
 subreport.setWidth(10080);
 subreport.setHeight(7200);
 

Parameters:
name - The name of the report object as a String.
Returns:
The report object as an IReportObject.

findSectionByName

ISection findSectionByName(java.lang.String name)

Returns an ISection when the name of the report section is specified. The specified name is not case-sensitive.

Parameters:
name - The name of the section as a String.
Returns:
The report section as an ISection.

findAreaByName

IArea findAreaByName(java.lang.String name)

getDetailArea

IArea getDetailArea()

Returns the detail area as an IArea.

Returns:
The detail area as an IArea.

getGroupFooterArea

IArea getGroupFooterArea(int index)

Returns the GroupFooterArea as an IArea.

Parameters:
index - An int that specifies the level of the GroupFooterArea to retrieve.
Returns:
The GroupFooterArea as an IArea.

getGroupHeaderArea

IArea getGroupHeaderArea(int index)

Returns the GroupHeaderArea as an IArea.

Parameters:
index - An int that specifies the level of the GroupHeaderArea to retrieve.
Returns:
The GroupHeaderArea as an IArea.

getPageFooterArea

IArea getPageFooterArea()

Returns the PageFooterArea as an IArea.

Returns:
The PageFooterArea as an IArea.

getPageHeaderArea

IArea getPageHeaderArea()

Returns the PageHeaderArea as an IArea.

Returns:
The PageHeaderArea as an IArea.

getReportFooterArea

IArea getReportFooterArea()

Returns the ReportFooterArea as an IArea.

Returns:
The ReportFooterArea as an IArea.

getReportHeaderArea

IArea getReportHeaderArea()

Returns the ReportHeaderArea as an IArea.

Returns:
The ReportHeaderArea as an IArea.