|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.document.DataDocument
com.crystaldecisions.sdk.occa.report.document.ReportDocument
public class ReportDocument
The object enables you to get and set report document information.
Constructor Summary | |
---|---|
ReportDocument()
|
|
ReportDocument(IReportDocument src)
|
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
Returns the new object that has been cloned. |
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
Copies the object. |
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
com.crystaldecisions.xml.serialization.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)
|
int |
getMajorVersion()
Returns the major version number of the report's format. |
int |
getMinorVersion()
Returns the minor version number of the report's format. |
IPrintOptions |
getPrintOptions()
For internal use only. |
ReportDefinition |
getReportDefinition()
Returns IReportDefinition , which contains areas, sections, and report objects in the report. |
IReportOptions |
getReportOptions()
Returns IReportOptions . |
ISummaryInfo |
getSummaryInfo()
Returns the report's summary information. |
boolean |
hasContent(java.lang.Object obj)
Returns whether or not an object has content. |
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(com.crystaldecisions.xml.serialization.XMLWriter writer,
com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
For internal use only. |
void |
save(com.crystaldecisions.xml.serialization.XMLWriter writer,
java.lang.String sTag,
com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setMajorVersion(int majorVersion)
Sets the major version number of the report's format. |
void |
setMinorVersion(int minorVersion)
Sets the minor version number of the report's format. |
void |
setPrintOptions(IPrintOptions printOptions)
For internal use only. |
void |
setReportDefinition(IReportDefinition reportDef)
Sets IReportDefinition , which contains areas, sections, and report objects in the report. |
void |
setReportOptions(IReportOptions reportOptions)
Sets IReportOptions . |
void |
setSummaryInfo(ISummaryInfo summaryInfo)
Sets the report's summary information. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.document.DataDocument |
---|
getControllableMixin, getDatabase, getDataDefinition, getName, getOptions, getRemoteID, getTimestamp, getUID, setDatabase, setDataDefinition, setName, setOptions, setRemoteID, setTimestamp, setUID |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDataDocument |
---|
getDatabase, getDataDefinition, setDatabase, setDataDefinition |
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDocument |
---|
getName, getOptions, getRemoteID, getTimestamp, getUID, setName, setOptions, setRemoteID, setTimestamp, setUID |
Constructor Detail |
---|
public ReportDocument(IReportDocument src)
public ReportDocument()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
Returns the new object that has been cloned.
clone
in class DataDocument
deepClone
- true
to use deep clone,
false
to use shallow.
public void copyTo(java.lang.Object destObject, boolean deepCopy)
Copies the object.
copyTo
in class DataDocument
destObject
- The destination object to copy to.deepCopy
- true
to use deep copy,
false
to use shallow.public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
For internal use only.
createMember
in class DataDocument
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
endElement
in class DataDocument
public int getMajorVersion()
IReportDocument
Returns the major version number of the report's format.
getMajorVersion
in interface IReportDocument
int
.public int getMinorVersion()
IReportDocument
Returns the minor version number of the report's format.
getMinorVersion
in interface IReportDocument
int
.public ReportDefinition getReportDefinition()
IReportDocument
Returns IReportDefinition
, which contains areas, sections, and report objects in the report.
This object provides access to areas in the report;
each area may contain multiple sections,
and each section may contain multiple report objects.
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.
getReportDefinition
in interface IReportDocument
ReportDefinition
object.public IReportOptions getReportOptions()
IReportDocument
Returns IReportOptions
.
Use IReportOptions
to modify the report's behavior
and capabilities such as how it should handle server data,
dates, queries, printing, viewing, and other such options.
getReportOptions
in interface IReportDocument
IReportOptions
as an object.public IPrintOptions getPrintOptions()
For internal use only.
public ISummaryInfo getSummaryInfo()
IReportDocument
Returns the report's summary information. The summary information consists of the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.
getSummaryInfo
in interface IReportDocument
ISummaryInfo
object.public boolean hasContent(java.lang.Object obj)
Returns whether or not an object has content.
hasContent
in class DataDocument
obj
- The object to check for content.
true
if the object has content, otherwise
false
.public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
readElement
in class DataDocument
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class DataDocument
java.io.IOException
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class DataDocument
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
saveContents
in class DataDocument
java.io.IOException
public void setMajorVersion(int majorVersion)
IReportDocument
Sets the major version number of the report's format.
setMajorVersion
in interface IReportDocument
majorVersion
- The major version number as an int
.public void setMinorVersion(int minorVersion)
IReportDocument
Sets the minor version number of the report's format.
setMinorVersion
in interface IReportDocument
minorVersion
- The minor version number as an int
.public void setReportDefinition(IReportDefinition reportDef)
IReportDocument
Sets IReportDefinition
, which contains areas, sections, and report objects in the report.
This property provides access to areas in the report;
each area may contain multiple sections,
and each section may contain multiple report objects.
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.
setReportDefinition
in interface IReportDocument
reportDef
- The ReportDefinition
object.public void setReportOptions(IReportOptions reportOptions)
IReportDocument
Sets IReportOptions
.
Use IReportOptions
to modify the report's behavior
and capabilities such as how it should handle server data,
dates, queries, printing, viewing, and other such options.
setReportOptions
in interface IReportDocument
reportOptions
- The IReportOptions
object.public void setPrintOptions(IPrintOptions printOptions)
For internal use only.
public void setSummaryInfo(ISummaryInfo summaryInfo)
IReportDocument
Sets the report's summary information. The summary information consists of the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.
setSummaryInfo
in interface IReportDocument
summaryInfo
- The ISummaryInfo
object.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
startElement
in class DataDocument
public void doControllerModification(java.lang.Object newObject)
doControllerModification
in class DataDocument
public boolean isDirectlyControllable()
isDirectlyControllable
in class DataDocument
public void enumerateMembers(IMemberVisitor visitor)
enumerateMembers
in class DataDocument
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |