|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.ReportDefinition
public class ReportDefinition
This object defines a particular report. It contains all of the information needed for the report's format and the content that populates a report. A new report by default 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| Constructor Summary | |
|---|---|
ReportDefinition()
|
|
ReportDefinition(IReportDefinition 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 |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
IArea |
findAreaByName(java.lang.String name)
For internal use only |
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. |
boolean |
getRptrReportFlag()
For internal use only. |
boolean |
hasContent(java.lang.Object srcReportDefinition)
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
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 |
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. |
void |
setRptrReportFlag(boolean rptrFlag)
For internal use only. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ReportDefinition(IReportDefinition src)
public ReportDefinition()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public 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.
public void endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only.
public Areas getAreas()
IReportDefinition
Returns the collection of Area objects that specifies the areas used for the
report object.
getAreas in interface IReportDefinitionAreas collection that specifies the areas used for the report object.public ReportStyle getReportStyle()
IReportDefinitionFor internal use only.
getReportStyle in interface IReportDefinitionpublic boolean hasContent(java.lang.Object srcReportDefinition)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only.
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOExceptionpublic void setAreas(Areas areas)
IReportDefinition
Sets the collection of Area objects that specifies the areas used for the
report object.
setAreas in interface IReportDefinitionareas - The Areas collection that specifies the areas used for the report
object.public void setReportStyle(ReportStyle reportStyle)
IReportDefinitionFor internal use only.
setReportStyle in interface IReportDefinition
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only.
public IReportObject findObjectByName(java.lang.String name)
IReportDefinition
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);
findObjectByName in interface IReportDefinitionname - The name of the report object as a String.
IReportObject.public ISection findSectionByName(java.lang.String name)
IReportDefinition
Returns an ISection when the name of the report section is specified. The specified
name is not case-sensitive.
findSectionByName in interface IReportDefinitionname - The name of the section as a String.
ISection.public IArea findAreaByName(java.lang.String name)
IReportDefinition
findAreaByName in interface IReportDefinitionpublic IArea getDetailArea()
IReportDefinition
Returns the detail area as an IArea.
getDetailArea in interface IReportDefinitionIArea.public IArea getGroupFooterArea(int index)
IReportDefinition
Returns the GroupFooterArea as an IArea.
getGroupFooterArea in interface IReportDefinitionindex - An int that specifies the level of the
GroupFooterArea to retrieve.
GroupFooterArea as an IArea.public IArea getGroupHeaderArea(int index)
IReportDefinition
Returns the GroupHeaderArea as an IArea.
getGroupHeaderArea in interface IReportDefinitionindex - An int that specifies the level of the
GroupHeaderArea to retrieve.
GroupHeaderArea as an IArea.public IArea getPageFooterArea()
IReportDefinition
Returns the PageFooterArea as an IArea.
getPageFooterArea in interface IReportDefinitionPageFooterArea as an IArea.public IArea getPageHeaderArea()
IReportDefinition
Returns the PageHeaderArea as an IArea.
getPageHeaderArea in interface IReportDefinitionPageHeaderArea as an IArea.public IArea getReportFooterArea()
IReportDefinition
Returns the ReportFooterArea as an IArea.
getReportFooterArea in interface IReportDefinitionReportFooterArea as an IArea.public IArea getReportHeaderArea()
IReportDefinition
Returns the ReportHeaderArea as an IArea.
getReportHeaderArea in interface IReportDefinitionReportHeaderArea as an IArea.public void setRptrReportFlag(boolean rptrFlag)
IReportDefinitionFor internal use only.
setRptrReportFlag in interface IReportDefinitionpublic boolean getRptrReportFlag()
IReportDefinitionFor internal use only.
getRptrReportFlag in interface IReportDefinition
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||