com.crystaldecisions.sdk.occa.report.definition
Class ReportDefinition

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.ReportDefinition
All Implemented Interfaces:
IReportDefinition, IClone

public class ReportDefinition
extends java.lang.Object
implements IReportDefinition, IClone

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.

See Also:
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 doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 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.
 ControllableMixin getControllableMixin()
           
 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 hasContent(java.lang.Object srcReportDefinition)
           
 boolean isDirectlyControllable()
           
 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 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

ReportDefinition

public ReportDefinition(IReportDefinition src)

ReportDefinition

public ReportDefinition()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

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.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getAreas

public Areas getAreas()
Description copied from interface: IReportDefinition

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

Specified by:
getAreas in interface IReportDefinition
Returns:
The Areas collection that specifies the areas used for the report object.

getReportStyle

public ReportStyle getReportStyle()
Description copied from interface: IReportDefinition

For internal use only.

Specified by:
getReportStyle in interface IReportDefinition

hasContent

public boolean hasContent(java.lang.Object srcReportDefinition)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setAreas

public void setAreas(Areas areas)
Description copied from interface: IReportDefinition

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

Specified by:
setAreas in interface IReportDefinition
Parameters:
areas - The Areas collection that specifies the areas used for the report object.

setReportStyle

public void setReportStyle(ReportStyle reportStyle)
Description copied from interface: IReportDefinition

For internal use only.

Specified by:
setReportStyle in interface IReportDefinition

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


findObjectByName

public IReportObject findObjectByName(java.lang.String name)
Description copied from interface: 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);
 

Specified by:
findObjectByName in interface IReportDefinition
Parameters:
name - The name of the report object as a String.
Returns:
The report object as an IReportObject.

findSectionByName

public ISection findSectionByName(java.lang.String name)
Description copied from interface: IReportDefinition

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

Specified by:
findSectionByName in interface IReportDefinition
Parameters:
name - The name of the section as a String.
Returns:
The report section as an ISection.

findAreaByName

public IArea findAreaByName(java.lang.String name)
Specified by:
findAreaByName in interface IReportDefinition

getDetailArea

public IArea getDetailArea()
Description copied from interface: IReportDefinition

Returns the detail area as an IArea.

Specified by:
getDetailArea in interface IReportDefinition
Returns:
The detail area as an IArea.

getGroupFooterArea

public IArea getGroupFooterArea(int index)
Description copied from interface: IReportDefinition

Returns the GroupFooterArea as an IArea.

Specified by:
getGroupFooterArea in interface IReportDefinition
Parameters:
index - An int that specifies the level of the GroupFooterArea to retrieve.
Returns:
The GroupFooterArea as an IArea.

getGroupHeaderArea

public IArea getGroupHeaderArea(int index)
Description copied from interface: IReportDefinition

Returns the GroupHeaderArea as an IArea.

Specified by:
getGroupHeaderArea in interface IReportDefinition
Parameters:
index - An int that specifies the level of the GroupHeaderArea to retrieve.
Returns:
The GroupHeaderArea as an IArea.

getPageFooterArea

public IArea getPageFooterArea()
Description copied from interface: IReportDefinition

Returns the PageFooterArea as an IArea.

Specified by:
getPageFooterArea in interface IReportDefinition
Returns:
The PageFooterArea as an IArea.

getPageHeaderArea

public IArea getPageHeaderArea()
Description copied from interface: IReportDefinition

Returns the PageHeaderArea as an IArea.

Specified by:
getPageHeaderArea in interface IReportDefinition
Returns:
The PageHeaderArea as an IArea.

getReportFooterArea

public IArea getReportFooterArea()
Description copied from interface: IReportDefinition

Returns the ReportFooterArea as an IArea.

Specified by:
getReportFooterArea in interface IReportDefinition
Returns:
The ReportFooterArea as an IArea.

getReportHeaderArea

public IArea getReportHeaderArea()
Description copied from interface: IReportDefinition

Returns the ReportHeaderArea as an IArea.

Specified by:
getReportHeaderArea in interface IReportDefinition
Returns:
The ReportHeaderArea as an IArea.

getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)