com.stimulsoft.report.saveLoad

Class StiDocument

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.saveLoad.StiDocument

All Implemented Interfaces:

IStiSerializable, IStiSerializableRef

public class StiDocument
extends StiSerializedObject

Describes the class that is used for for storing a rendered report.

Field Summary

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiDocument()
StiDocument(StiReport report) Creates a new object of the type StiDocument.

Method Summary

Methods

Modifier and Type	Method and Description
StiBookmark	getBookmark() Gets or sets the root bookmark of a document.
StiPagesCollection	getPages() Gets collection of rendered report pages.
StiReport	getReport() Gets or sets the report which rendered pages are used for rendering of a document.
java.lang.String	getReportAlias() Gets or sets a report alias.
java.lang.String	getReportAuthor() Gets or sets a report author.
java.util.Calendar	getReportCreated() Gets or sets the date of the report creation.
java.lang.String	getReportDescription() Gets or sets a report description.
java.lang.String	getReportName() Gets or sets a report name.
java.lang.String	getReportVersion() Gets or sets version a report engine.
StiResourcesCollection	getResources() Gets collection of variables of report.
StiStylesCollection	getStyles()
StiUnit	getUnit()
StiVariablesCollection	getVariables() Gets collection of variables of report.
void	setBookmark(StiBookmark value)
void	setPages(StiPagesCollection pagesCollection)
void	setReport(StiReport value)
void	setReportAlias(java.lang.String value)
void	setReportAuthor(java.lang.String value)
void	setReportCreated(java.util.Calendar value)
void	setReportDescription(java.lang.String value)
void	setReportName(java.lang.String value)
void	setReportVersion(java.lang.String value)
void	setResources(StiResourcesCollection resources)
void	setStyles(StiStylesCollection styles)
void	setUnit(StiUnit value)
void	setVariables(StiVariablesCollection value)

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StiDocument

public StiDocument()

StiDocument

public StiDocument(StiReport report)

Creates a new object of the type StiDocument.

Parameters:

report - Rendered report.

Method Detail

getReportName

public final java.lang.String getReportName()

Gets or sets a report name.

setReportName

public final void setReportName(java.lang.String value)

getReportAlias

public final java.lang.String getReportAlias()

Gets or sets a report alias.

setReportAlias

public final void setReportAlias(java.lang.String value)

getReportAuthor

public final java.lang.String getReportAuthor()

Gets or sets a report author.

setReportAuthor

public final void setReportAuthor(java.lang.String value)

getReportVersion

public final java.lang.String getReportVersion()

Gets or sets version a report engine.

setReportVersion

public final void setReportVersion(java.lang.String value)

getReportDescription

public final java.lang.String getReportDescription()

Gets or sets a report description.

setReportDescription

public final void setReportDescription(java.lang.String value)

getReportCreated

public final java.util.Calendar getReportCreated()

Gets or sets the date of the report creation.

setReportCreated

public final void setReportCreated(java.util.Calendar value)

getUnit

public final StiUnit getUnit()

setUnit

public final void setUnit(StiUnit value)

getPages

public final StiPagesCollection getPages()

Gets collection of rendered report pages.

setPages

public final void setPages(StiPagesCollection pagesCollection)

getVariables

public final StiVariablesCollection getVariables()

Gets collection of variables of report.

getResources

public final StiResourcesCollection getResources()

Gets collection of variables of report.

setResources

public void setResources(StiResourcesCollection resources)

setVariables

public final void setVariables(StiVariablesCollection value)

getBookmark

public final StiBookmark getBookmark()

Gets or sets the root bookmark of a document.

setBookmark

public final void setBookmark(StiBookmark value)

getStyles

public final StiStylesCollection getStyles()

setStyles

public void setStyles(StiStylesCollection styles)

getReport

public final StiReport getReport()

Gets or sets the report which rendered pages are used for rendering of a document.

setReport

public final void setReport(StiReport value)