|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportDefinition
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.
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 |
---|
Areas getAreas()
Returns the collection of Area
objects that specifies the areas used for the
report object.
Areas
collection that specifies the areas used for the report object.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.
areas
- The Areas
collection that specifies the areas used for the report
object.void setReportStyle(ReportStyle reportStyle)
For internal use only.
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);
name
- The name of the report object as a String
.
IReportObject
.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.
name
- The name of the section as a String
.
ISection
.IArea findAreaByName(java.lang.String name)
IArea getDetailArea()
Returns the detail area as an IArea
.
IArea
.IArea getGroupFooterArea(int index)
Returns the GroupFooterArea
as an IArea
.
index
- An int
that specifies the level of the
GroupFooterArea
to retrieve.
GroupFooterArea
as an IArea
.IArea getGroupHeaderArea(int index)
Returns the GroupHeaderArea
as an IArea
.
index
- An int
that specifies the level of the
GroupHeaderArea
to retrieve.
GroupHeaderArea
as an IArea
.IArea getPageFooterArea()
Returns the PageFooterArea
as an IArea
.
PageFooterArea
as an IArea
.IArea getPageHeaderArea()
Returns the PageHeaderArea
as an IArea
.
PageHeaderArea
as an IArea
.IArea getReportFooterArea()
Returns the ReportFooterArea
as an IArea
.
ReportFooterArea
as an IArea
.IArea getReportHeaderArea()
Returns the ReportHeaderArea
as an IArea
.
ReportHeaderArea
as an IArea
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |