com.stimulsoft.report
Class StiReport

java.lang.Object
  extended by com.stimulsoft.base.serializing.StiSerializedObject
      extended by com.stimulsoft.report.StiReport
All Implemented Interfaces:
IStiReport, IStiSerializable, IStiSerializableRef, IStiUnitConvert, IStiEngineVersionProperty, java.io.Serializable, java.lang.Cloneable

public class StiReport
extends StiSerializedObject
implements IStiReport, java.lang.Cloneable, IStiUnitConvert, IStiEngineVersionProperty, IStiSerializableRef, java.io.Serializable

Report class.

See Also:
Serialized Form

Nested Class Summary
 class StiReport.StiJsonLoaderHelper
           
 
Field Summary
 StiBookmark bookmarkValue
           
 StiReport compiledReport
           
 boolean containsTables
           
 int currentPage
           
 int currentPrintPage
           
 java.lang.String[] dataBandsUsedInPageTotals
           
 java.lang.String[] DataBandsUsedInPageTotals
           
 IStiDesignerBase designer
           
 StiDictionary dictionary
           
 StiEngine engine
           
 int GroupLine
           
 StiEventHandler handlerBeginRender
           
 StiEventHandler handlerDesignerEvents
           
 StiEventHandler handlerEndRender
           
 StiEventHandler handlerExported
           
 StiEventHandler handlerExporting
           
 StiEventHandler handlerPaint
           
 StiEventHandler handlerPrinted
           
 StiEventHandler handlerRefreshPreview
           
 StiEventHandler handlerRefreshViewer
           
 StiEventHandler handlerRendering
           
 StiEventHandler handlerStatusChanged
           
 java.lang.String imageCachePath
           
 int IndexName
           
 java.util.HashMap<java.lang.String,java.lang.Object> interactionCollapsingStates
           
 boolean isDocument
           
 boolean isEditedInViewer
           
 boolean isInteractionRendering
           
 boolean isNeedsCompiling
           
 boolean isPackedReport
           
 boolean isPageDesigner
           
 boolean isRendered
           
 boolean isRendering
           
 boolean isSerializing
           
 boolean isStopped
           
 boolean isWpf
           
 StiReport.StiJsonLoaderHelper jsonLoaderHelper
           
 int LineABC
           
 int LineRoman
           
 int LineThrough
           
static java.lang.Object lockGlobalMeasureGraphics
           
 StiBookmark manualBookmark
           
 StiPagesCollection pages
           
 StiReport parentReport
           
 java.lang.String password
           
 StiBookmark pointerValue
           
 IStiProgressInformation progress
           
 int progressOfRendering
           
 StiRenderedWith renderedWith
           
 StiReportCacheMode reportCacheMode
           
 java.lang.String reportCachePath
           
 StiGraphics reportMeasureGraphics
           
 StiReportPass reportPass
           
 java.util.ArrayList<java.lang.String> reportRenderingMessages
           
 java.lang.String reportSource
           
 java.lang.String rtfCachePath
           
 boolean saveReportInResources
           
 StiStatusHandler statusHandler
           
 boolean stop
           
 java.util.ArrayList<StiReport> subReports
           
 StiReport SubReportsMasterReport
           
 boolean SubReportsPrintOnPreviousPage
           
 boolean SubReportsResetPageNumber
           
 java.lang.Object tag
           
 boolean useProgressInThread
           
 
Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
REFERENCE_EMPTY, REFERENCE_REPORT
 
Constructor Summary
StiReport()
           
 
Method Summary
 void addAnchor(java.lang.Object value)
          Adds anchor.
 void addPage(StiPage page)
           
 void applyStyleCollection(java.lang.String collectionName)
          Applies styles associated with the specified style collection to all components in the report.
 void applyStyles()
          Applies styles of a report to all components in the report.
static java.lang.Object changeType(java.lang.Object value, StiSystemType conversionType)
          Changes a type of the specified value.
static java.lang.Object changeType(java.lang.Object value, StiSystemType conversionType, java.lang.Boolean convertNulls)
          Changes a type of the specified value.
 java.lang.Object CheckExcelValue(java.lang.Object sender, java.lang.Object value)
           
 void Compile()
           
 void convert(StiUnit oldUnit, StiUnit newUnit)
          Convertes component from one unit into another.
 double convertToHInches(StiUnit unit, double value)
           
 StiRectangle convertToHInches(StiUnit unit, StiRectangle value)
           
 void correctFormatProperties()
          Fix - correct Format property of the Text components.
 void dispose()
           
 void exportDocument(StiExportFormat exportFormat, StiExportService exportService, java.io.File file, StiExportSettings settings, javax.swing.JFrame parent)
           
 void fillReportScript()
           
 java.lang.Object get(java.lang.String name)
           
 StiRuntimeVariables getAnchor(java.lang.Object value)
          Gets runtime values by the value of an anchor.
 int getAnchorPageNumber(java.lang.Object value)
           
 int getAnchorPageNumberThrough(java.lang.Object value)
           
 boolean getAutoLocalizeReportOnRun()
          Gets or sets property which allows automatic localization of the report when running starts.
 StiBeginRenderEvent getBeginRenderEvent()
          Occurs when the report rendering starts.
 StiBookmark getBookmark()
          Gets or sets the root bookmark.
 java.util.ArrayList<StiBusinessObjectData> getBusinessObjectsStore()
           
 boolean getCacheAllData()
          Gets or sets value, which indicates whether it is necessary to cache all data of the report in one DataSet or not.
 StiCalculationMode getCalculationMode()
          Gets or sets the method of calculation in report.
 int getCollate()
          Gets or sets value which can be used for pages collating.
 int getColumn()
           
 StiReport getCompiledReport()
           
 StiComponent GetComponentByName(java.lang.String componentName)
           
 StiComponentsCollection getComponents()
           
 StiComponentsCollection GetComponents()
          Returns a list of all components, including pages in the report.
 int getComponentsCount()
           
 boolean getConvertNulls()
          Gets or sets value which shows whether it is necessary to convert null or DBNull.
 java.lang.String getCulture()
           
 int getCurrentPage()
          Gets or sets the index of the current page.
 int getCurrentPrintPage()
           
 java.util.List<StiCustomFunction> getCustomFunctions()
           
 StiDataSourcesCollection getDataSources()
           
 StiDictionary getDictionary()
           
 StiEndRenderEvent getEndRenderEvent()
          Occurs when the report rendering is finished.
 StiEngine getEngine()
           
 StiEngineVersion getEngineVersion()
          Gets or sets version of engine which will be used for report rendering.
 java.lang.String getEngineVersionStr()
           
 StiExportedEvent getExportedEvent()
          Occurs when report ends exporting.
 StiExportingEvent getExportingEvent()
          Occurs when report starts exporting.
 StiGlobalizationContainerCollection getGlobalizationStrings()
          Gets a collection which consists of globalization strings.
static StiGraphics getGlobalMeasureGraphics()
           
 StiDesignerInfo getInfo()
           
 StiInteraction getInteraction()
           
 java.util.HashMap<java.lang.String,java.lang.Object> getInteractionCollapsingStates()
           
 boolean getIsDesigning()
          Gets value, which indicates that the report is being designed.
 boolean getIsExporting()
          Gets value, which indicates that the report is exporting.
 boolean getIsFirstPage()
           
 boolean getIsFirstPageThrough()
           
 boolean getIsFirstPass()
          Gets value which indicates that first report pass is rendered now.
 boolean getIsLastPage()
           
 boolean getIsLastPageThrough()
           
 boolean getIsModified()
           
 boolean getIsPageDesigner()
           
 boolean getIsPrinting()
          Gets or sets value, which indicates that the report printing is in process.
 boolean getIsRendered()
           
 boolean getIsRendering()
           
 boolean getIsSecondPass()
          Gets value which indicates that second report pass is rendered now.
 boolean getIsSerializing()
           
 boolean getIsStopped()
           
 java.lang.Boolean getIsSubmit()
           
 StiReport.StiJsonLoaderHelper getJsonLoaderHelper()
           
 java.lang.String getLicenseKey()
           
 int getLine()
           
 java.lang.String[] getListOfUsedData()
          Internal use only.
 java.util.Locale getLocale()
           
 StiMetaTagCollection getMetaTags()
          Gets the collection of meta tags.
 java.util.Hashtable<java.lang.String,java.lang.Boolean> getModifiedVariables()
           
 boolean getNeedsCompiling()
           
 StiNumberOfPass getNumberOfPass()
          Gets or sets the number of passes which the report generator makes while report rendering.
 int getPageIndex(int index)
           
 java.lang.String getPageNofM()
          Gets string value which contains "Page N of M".
 java.lang.String getPageNofMLocalizationString()
          Gets string value which contains localization template for "Page N of M".
 java.lang.String getPageNofMThrough()
          Gets string value which contains "Page N of M".
 int getPageNumber()
           
 int getPageNumberThrough()
          Gets or sets an index of the current page printed taking into consideration segmented pages.
 StiPagesCollection getPages()
          Gets a collection which consists of the template pages from the currect report.
 StiOrientation getParametersOrientation()
          Gets or sets value which indicates parameters panel orientation.
 StiReport getParentReport()
           
 StiBookmark getPointer()
           
 StiPreviewMode getPreviewMode()
          Gets or sets the preview mode of the report.
 int getPreviewSettings()
          Gets or sets controls which will be shown in the Viewer Window.
 StiPrintedEvent getPrintedEvent()
          Occurs when report ends printing.
 StiPrinterSettings getPrinterSettings()
          Gets or sets printer settings of current report.
 StiPrintingEvent getPrintingEvent()
          Occurs when report starts printing.
 IStiProgressInformation getProgress()
           
 int getReference()
           
 java.util.ArrayList<java.lang.String> getReferencedAssemblies()
          Gets or sets an array of referenced assemblies.
 int getRefreshTime()
          the time (in seconds) after which the report will be automatically rebuilt in the viewer.
 StiComponentsCollection GetRenderedComponents()
          Returns a list of all rendered components, including rendered pages in the report.
 StiPagesCollection getRenderedPages()
          Gets a collection of rendered pages from the current report.
 StiRenderingEvent getRenderingEvent()
          Occurs when a page is rendered.
 java.lang.String getReportAlias()
          Gets or sets a report alias.
 java.lang.String getReportAuthor()
          Gets or sets a report author.
 StiReportCacheMode getReportCacheMode()
          Gets or sets value, which indicates how report engine use report cache.
 java.util.Calendar getReportChanged()
          Gets or sets the date of the last report changes.
 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 getReportFile()
           
 java.lang.String getReportGuid()
          Gets or sets the report Guid.
 StiGraphics getReportMeasureGraphics()
           
 java.lang.String getReportName()
          Gets or sets a report name.
 StiReportPass getReportPass()
           
 java.util.ArrayList<java.lang.String> getReportRenderingMessages()
           
 StiReportResourceCollection getReportResources()
           
 StiReportUnitType getReportUnit()
          Gets the current measurement unit of the report.
 java.lang.String getReportVersion()
          Gets or sets version of the report engine which changed the report last time.
 boolean getRequestParameters()
          Gets or sets value which indicates whether to request parameters from a user before report rendering or render a report with the default value of parameters.
 java.lang.String getResourceFontName(java.lang.String resourceName)
           
 boolean getRetrieveOnlyUsedData()
          value, which indicates how report engine retrieve data - only used in the report data or all data.
 java.lang.String getScript()
           
 StiReportLanguageType getScriptLanguage()
          Gets or sets the current script language.
 int getSelectionTick()
           
 StiStatusHandler getStatusHandler()
           
 java.lang.String getStatusString()
           
 boolean getStop()
           
 int getStopBeforePage()
          Gets or sets a page number.
 boolean getStoreImagesInResources()
          Gets or sets value which indicates that images from report will be stored as assembly resources.
 StiStylesCollection getStyles()
          Gets a collection which consists of report styles.
 java.util.ArrayList<StiReport> getSubReports()
           
 int getTotalPageCount()
           
 int getTotalPageCountThrough()
          Gets or sets the number of pages in a report.
 java.util.Hashtable<java.lang.String,java.lang.Object> getTotals()
          Internal use only.
 StiUnit getUnit()
           
 boolean getUseProgressInThread()
           
 java.lang.Object getVariable(java.lang.String name)
           
 StiVariablesMap getVariables()
           
 void invokeBeginRender()
           
 void InvokeEndRender()
           
 void invokeExported(StiExportFormat exportFormat)
           
 void invokeExporting(StiExportFormat exportFormat)
           
 void invokePaint(StiEventHandlerArgs e)
           
 void invokePrinted()
           
 void invokePrinting()
           
 void invokeRefreshPreview()
           
 void invokeRefreshViewer()
           
 void invokeRendering()
           
 void invokeStatusChanged()
           
 boolean isInteractionRendering()
           
 boolean isInterpretation()
           
 boolean isJsonReport()
           
 boolean isPreviewDialogs()
           
 boolean isSaveInteractionParametersToDocument()
           
 boolean isShowProgress()
           
 void loadDocumentFonts()
           
 void loadFonts()
           
 void loadFromJson(java.lang.String text)
           
 void localizeReport(java.lang.String cultureName)
           
static StiReport newInstance()
           
 void processAutoLocalizeReportOnRun()
           
 void RenameStyle(java.lang.String oldStylename, java.lang.String newStyleName)
           
 StiReport render()
          Renders a report.
 void Render()
          Renders a report.
 void Render(boolean showProgress)
          Renders a report.
 void Render(boolean showProgress, int fromPage, int toPage)
          Renders a report.
 void Render(StiRenderState renderState)
          Renders a report.
 void ResetAggregateFunctions()
           
 void saveDocument(java.io.OutputStream stream)
          Saves a rendered report in the stream.
 java.lang.String saveDocumentToString()
          Saves a rendered report to the string.
 java.lang.String saveToJsonInternal(StiJsonSaveMode mode)
           
 void set(java.lang.String name, java.lang.Object value)
           
 void setAutoLocalizeReportOnRun(boolean value)
           
 void setBeginRenderEvent(StiBeginRenderEvent value)
           
 void setBookmark(StiBookmark value)
           
 void setCacheAllData(boolean value)
           
 void setCalculationMode(StiCalculationMode value)
           
 void setCollate(int value)
           
 void setColumn(int value)
           
 void setCompiledReport(StiReport compiledReport)
           
 void setConvertNulls(boolean value)
           
 void setCulture(java.lang.String culture)
           
 void setCurrentPage(int value)
           
 void setCurrentPrintPage(int value)
           
 void setDictionary(StiDictionary dictionary)
           
 void setEndRenderEvent(StiEndRenderEvent value)
           
 void setEngine(StiEngine value)
           
 void setEngineVersion(StiEngineVersion value)
           
 void setExportedEvent(StiExportedEvent value)
           
 void setExportingEvent(StiExportingEvent value)
           
 void setGlobalizationStrings(StiGlobalizationContainerCollection globalizationStrings)
           
 void setGroupLine(int GroupLine)
           
 void setInfo(StiDesignerInfo value)
           
 void setInteractionCollapsingStates(java.util.HashMap<java.lang.String,java.lang.Object> interactionCollapsingStates)
           
 void setInteractionRendering(boolean isInteractionRendering)
           
 void setIsModified(boolean value)
           
 void setIsPageDesigner(boolean value)
           
 void setIsPrinting(boolean value)
           
 void setIsRendered(boolean value)
           
 void setIsRendering(boolean value)
           
 void setIsSerializing(boolean value)
           
 void setIsStopped(boolean value)
           
 void setIsSubmit(java.lang.Boolean isSubmit)
           
 void setJsonReport(boolean jsonReport)
           
 void setLicenseKey(java.lang.String licenseKey)
           
 void setLine(int line)
           
 void setListOfUsedData(java.lang.String[] listOfUsedData)
          Internal use only.
 void setMetaTags(StiMetaTagCollection metaTags)
           
 void setModifiedVariables(java.util.Hashtable<java.lang.String,java.lang.Boolean> modifiedVariables)
           
 void setNeedsCompiling(boolean value)
           
 void setNumberOfPass(StiNumberOfPass value)
           
 void setPageNofMLocalizationString(java.lang.String value)
           
 void setPageNumber(int value)
           
 void setPages(StiPagesCollection pages)
           
 void setParametersOrientation(StiOrientation value)
           
 void setParentReport(StiReport value)
           
 void setPointer(StiBookmark value)
           
 void setPreviewDialogs(boolean previewDialogs)
           
 void setPreviewMode(StiPreviewMode value)
           
 void setPreviewSettings(int value)
           
 void setPrintedEvent(StiPrintedEvent value)
           
 void setPrinterSettings(StiPrinterSettings value)
           
 void setPrintingEvent(StiPrintingEvent value)
           
 void setProgress(IStiProgressInformation value)
           
 void setReference(int reference)
          Установить значение ссылки.
 void setReferencedAssemblies(java.util.ArrayList<java.lang.String> value)
           
 void setRefreshTime(int refreshTime)
           
 void setRenderedPages(StiPagesCollection pagesCollection)
           
 void setRenderingEvent(StiRenderingEvent value)
           
 void setReportAlias(java.lang.String value)
           
 void setReportAuthor(java.lang.String value)
           
 void setReportCacheMode(StiReportCacheMode value)
           
 void setReportChanged(java.util.Calendar value)
           
 void setReportCreated(java.util.Calendar value)
           
 void setReportDescription(java.lang.String value)
           
 void setReportFile(java.lang.String reportFile)
           
 void setReportGuid(java.lang.String value)
           
 void setReportName(java.lang.String value)
           
 void setReportPass(StiReportPass value)
           
 void setReportRenderingMessages(java.util.ArrayList<java.lang.String> value)
           
 void setReportResources(StiReportResourceCollection reportResources)
           
 void setReportUnit(StiReportUnitType value)
           
 void setReportVersion(java.lang.String value)
           
 void setRequestParameters(boolean value)
           
 void setRetrieveOnlyUsedData(boolean retrieveOnlyUsedData)
          value, which indicates how report engine retrieve data - only used in the report data or all data.
 void setSaveInteractionParametersToDocument(boolean saveInteractionParametersToDocument)
           
 void setScript(java.lang.String script)
           
 void setScriptLanguage(StiReportLanguageType value)
           
 void setShowProgress(boolean showProgress)
           
 void setStatusHandler(StiStatusHandler statusHandler)
           
 void setStatusString(java.lang.String statusString)
           
 void setStop(boolean value)
           
 void setStopBeforePage(int value)
           
 void setStoreImagesInResources(boolean value)
           
 void setStyles(StiStylesCollection styles)
           
 void setSubReports(java.util.ArrayList<StiReport> value)
           
 void setTotalPageCount(int value)
           
 void setTotals(java.util.Hashtable<java.lang.String,java.lang.Object> value)
           
 void setUnit(StiUnit value)
           
 void setUseProgressInThread(boolean value)
           
 void setVariable(java.lang.String name, java.lang.Object value)
           
 void setVariables(StiVariablesMap variables)
           
 java.lang.String ToString(java.lang.Object obj)
          Internal use only.
 java.lang.String ToString(java.lang.Object sender, java.lang.Object obj)
           
 java.lang.String ToString(java.lang.Object sender, java.lang.Object obj, boolean allowExcelCheck)
           
 void updateReportVersion()
           
 void WriteToReportRenderingMessages(java.lang.String str)
           
 
Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject
cleanReference
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dictionary

public StiDictionary dictionary

pages

public StiPagesCollection pages

reportCacheMode

public StiReportCacheMode reportCacheMode

compiledReport

public StiReport compiledReport

bookmarkValue

public StiBookmark bookmarkValue

DataBandsUsedInPageTotals

public java.lang.String[] DataBandsUsedInPageTotals

LineThrough

public int LineThrough

LineABC

public int LineABC

LineRoman

public int LineRoman

useProgressInThread

public boolean useProgressInThread

reportRenderingMessages

public java.util.ArrayList<java.lang.String> reportRenderingMessages

interactionCollapsingStates

public java.util.HashMap<java.lang.String,java.lang.Object> interactionCollapsingStates

progressOfRendering

public int progressOfRendering

progress

public IStiProgressInformation progress

subReports

public java.util.ArrayList<StiReport> subReports

reportSource

public java.lang.String reportSource

tag

public java.lang.Object tag

reportCachePath

public java.lang.String reportCachePath

imageCachePath

public java.lang.String imageCachePath

rtfCachePath

public java.lang.String rtfCachePath

parentReport

public StiReport parentReport

manualBookmark

public StiBookmark manualBookmark

reportMeasureGraphics

public StiGraphics reportMeasureGraphics

password

public java.lang.String password

dataBandsUsedInPageTotals

public java.lang.String[] dataBandsUsedInPageTotals

reportPass

public StiReportPass reportPass

isEditedInViewer

public boolean isEditedInViewer

isRendered

public boolean isRendered

isRendering

public boolean isRendering

isStopped

public boolean isStopped

stop

public boolean stop

isPageDesigner

public boolean isPageDesigner

isSerializing

public boolean isSerializing

isPackedReport

public boolean isPackedReport

isWpf

public boolean isWpf

isDocument

public boolean isDocument

isInteractionRendering

public boolean isInteractionRendering

isNeedsCompiling

public boolean isNeedsCompiling

saveReportInResources

public boolean saveReportInResources

lockGlobalMeasureGraphics

public static java.lang.Object lockGlobalMeasureGraphics

SubReportsResetPageNumber

public boolean SubReportsResetPageNumber

SubReportsPrintOnPreviousPage

public boolean SubReportsPrintOnPreviousPage

engine

public StiEngine engine

GroupLine

public int GroupLine

containsTables

public boolean containsTables

SubReportsMasterReport

public StiReport SubReportsMasterReport

currentPrintPage

public int currentPrintPage

currentPage

public int currentPage

IndexName

public int IndexName

statusHandler

public StiStatusHandler statusHandler

jsonLoaderHelper

public StiReport.StiJsonLoaderHelper jsonLoaderHelper

designer

public IStiDesignerBase designer

renderedWith

public StiRenderedWith renderedWith

handlerRendering

public StiEventHandler handlerRendering

handlerRefreshPreview

public StiEventHandler handlerRefreshPreview

handlerRefreshViewer

public StiEventHandler handlerRefreshViewer

handlerBeginRender

public StiEventHandler handlerBeginRender

handlerEndRender

public StiEventHandler handlerEndRender

handlerExported

public StiEventHandler handlerExported

handlerExporting

public StiEventHandler handlerExporting

handlerPaint

public StiEventHandler handlerPaint

handlerPrinted

public StiEventHandler handlerPrinted

handlerStatusChanged

public StiEventHandler handlerStatusChanged

handlerDesignerEvents

public StiEventHandler handlerDesignerEvents

pointerValue

public StiBookmark pointerValue
Constructor Detail

StiReport

public StiReport()
Method Detail

newInstance

public static StiReport newInstance()

fillReportScript

public void fillReportScript()

convert

public void convert(StiUnit oldUnit,
                    StiUnit newUnit)
Description copied from interface: IStiUnitConvert
Convertes component from one unit into another.

Specified by:
convert in interface IStiUnitConvert
Parameters:
oldUnit - Old units.
newUnit - New units.

setInfo

public final void setInfo(StiDesignerInfo value)

getGlobalMeasureGraphics

public static StiGraphics getGlobalMeasureGraphics()

getReportMeasureGraphics

public StiGraphics getReportMeasureGraphics()

getPageNumberThrough

public final int getPageNumberThrough()
Gets or sets an index of the current page printed taking into consideration segmented pages. Number starts from 1. Property ResetPageNumber is ignored.


getTotalPageCountThrough

public final int getTotalPageCountThrough()
Gets or sets the number of pages in a report. Property ResetPageNumber is ignored.


getPageNumber

public int getPageNumber()

getPageNofM

public final java.lang.String getPageNofM()
Gets string value which contains "Page N of M". Property ResetPageNumber can reset value of N.


getPageNofMThrough

public final java.lang.String getPageNofMThrough()
Gets string value which contains "Page N of M". Property ResetPageNumber is ignored.


getPageNofMLocalizationString

public final java.lang.String getPageNofMLocalizationString()
Gets string value which contains localization template for "Page N of M". For example: Page {0} of {1}. By default this property equal to null and report engine use global localization string.


setPageNofMLocalizationString

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

getInfo

public StiDesignerInfo getInfo()

setPageNumber

public final void setPageNumber(int value)

getTotalPageCount

public int getTotalPageCount()

setTotalPageCount

public final void setTotalPageCount(int value)

getReportPass

public final StiReportPass getReportPass()

setReportPass

public final void setReportPass(StiReportPass value)

getIsRendering

public final boolean getIsRendering()

setIsRendering

public final void setIsRendering(boolean value)

addPage

public void addPage(StiPage page)

setReference

public void setReference(int reference)
Description copied from interface: IStiSerializableRef
Установить значение ссылки.

Specified by:
setReference in interface IStiSerializableRef
Overrides:
setReference in class StiSerializedObject
Parameters:
reference - значение ссылки

getReference

public int getReference()
Specified by:
getReference in interface IStiSerializableRef
Overrides:
getReference in class StiSerializedObject
Returns:
значение ссылки.

setDictionary

public void setDictionary(StiDictionary dictionary)

getDictionary

public StiDictionary getDictionary()

getEngineVersionStr

public java.lang.String getEngineVersionStr()

getReportFile

public java.lang.String getReportFile()

getScript

public java.lang.String getScript()

setReportFile

public void setReportFile(java.lang.String reportFile)

setScript

public void setScript(java.lang.String script)

getUnit

public final StiUnit getUnit()

setUnit

public final void setUnit(StiUnit value)

getBeginRenderEvent

public final StiBeginRenderEvent getBeginRenderEvent()
Occurs when the report rendering starts.


setBeginRenderEvent

public final void setBeginRenderEvent(StiBeginRenderEvent value)

getRenderingEvent

public final StiRenderingEvent getRenderingEvent()
Occurs when a page is rendered.


setRenderingEvent

public final void setRenderingEvent(StiRenderingEvent value)

getEndRenderEvent

public final StiEndRenderEvent getEndRenderEvent()
Occurs when the report rendering is finished.


setEndRenderEvent

public final void setEndRenderEvent(StiEndRenderEvent value)

getExportingEvent

public final StiExportingEvent getExportingEvent()
Occurs when report starts exporting.


setExportingEvent

public final void setExportingEvent(StiExportingEvent value)

getExportedEvent

public final StiExportedEvent getExportedEvent()
Occurs when report ends exporting.


setExportedEvent

public final void setExportedEvent(StiExportedEvent value)

getPrintingEvent

public final StiPrintingEvent getPrintingEvent()
Occurs when report starts printing.


setPrintingEvent

public final void setPrintingEvent(StiPrintingEvent value)

getPrintedEvent

public final StiPrintedEvent getPrintedEvent()
Occurs when report ends printing.


setPrintedEvent

public final void setPrintedEvent(StiPrintedEvent value)

getMetaTags

public StiMetaTagCollection getMetaTags()
Gets the collection of meta tags. Meta tags can be used for storing specific information in report. Meta tags will be saved in report file.


setMetaTags

public void setMetaTags(StiMetaTagCollection metaTags)

getReportVersion

public final java.lang.String getReportVersion()
Gets or sets version of the report engine which changed the report last time.


setReportVersion

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

getReportGuid

public final java.lang.String getReportGuid()
Gets or sets the report Guid.


setReportGuid

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

getAnchor

public StiRuntimeVariables getAnchor(java.lang.Object value)
Gets runtime values by the value of an anchor.

Parameters:
value - An anchor value.
Returns:
A runtime value.

getPageIndex

public int getPageIndex(int index)

getPages

public final StiPagesCollection getPages()
Gets a collection which consists of the template pages from the currect report.


setPages

public void setPages(StiPagesCollection pages)

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)

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)

getReportChanged

public final java.util.Calendar getReportChanged()
Gets or sets the date of the last report changes.


setReportChanged

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

getEngineVersion

public final StiEngineVersion getEngineVersion()
Gets or sets version of engine which will be used for report rendering. EngineV1 is old version of engine. EngineV2 is newest version of engine. Its more powerful and more flexible.

Specified by:
getEngineVersion in interface IStiEngineVersionProperty

setEngineVersion

public final void setEngineVersion(StiEngineVersion value)
Specified by:
setEngineVersion in interface IStiEngineVersionProperty

getStyles

public final StiStylesCollection getStyles()
Gets a collection which consists of report styles.


setStyles

public void setStyles(StiStylesCollection styles)

getNumberOfPass

public final StiNumberOfPass getNumberOfPass()
Gets or sets the number of passes which the report generator makes while report rendering.


setNumberOfPass

public final void setNumberOfPass(StiNumberOfPass value)

getCalculationMode

public final StiCalculationMode getCalculationMode()
Gets or sets the method of calculation in report.


setCalculationMode

public final void setCalculationMode(StiCalculationMode value)

getReportUnit

public final StiReportUnitType getReportUnit()
Gets the current measurement unit of the report.


setReportUnit

public final void setReportUnit(StiReportUnitType value)

getCacheAllData

public final boolean getCacheAllData()
Gets or sets value, which indicates whether it is necessary to cache all data of the report in one DataSet or not.


setCacheAllData

public final void setCacheAllData(boolean value)

getReportCacheMode

public final StiReportCacheMode getReportCacheMode()
Gets or sets value, which indicates how report engine use report cache.


setReportCacheMode

public final void setReportCacheMode(StiReportCacheMode value)

getConvertNulls

public final boolean getConvertNulls()
Gets or sets value which shows whether it is necessary to convert null or DBNull.


setConvertNulls

public final void setConvertNulls(boolean value)

getStoreImagesInResources

public final boolean getStoreImagesInResources()
Gets or sets value which indicates that images from report will be stored as assembly resources.


setStoreImagesInResources

public final void setStoreImagesInResources(boolean value)

getPreviewMode

public final StiPreviewMode getPreviewMode()
Gets or sets the preview mode of the report.


setPreviewMode

public final void setPreviewMode(StiPreviewMode value)

getStopBeforePage

public final int getStopBeforePage()
Gets or sets a page number. When this page is reached then the report rendering is stopped.


setStopBeforePage

public final void setStopBeforePage(int value)

getPreviewSettings

public final int getPreviewSettings()
Gets or sets controls which will be shown in the Viewer Window.


setPreviewSettings

public final void setPreviewSettings(int value)

getCollate

public final int getCollate()
Gets or sets value which can be used for pages collating. The value of the property cannot be less then 1.


setCollate

public final void setCollate(int value)

getPrinterSettings

public final StiPrinterSettings getPrinterSettings()
Gets or sets printer settings of current report.


setPrinterSettings

public final void setPrinterSettings(StiPrinterSettings value)

getReferencedAssemblies

public final java.util.ArrayList<java.lang.String> getReferencedAssemblies()
Gets or sets an array of referenced assemblies.


setReferencedAssemblies

public final void setReferencedAssemblies(java.util.ArrayList<java.lang.String> value)

getScriptLanguage

public final StiReportLanguageType getScriptLanguage()
Gets or sets the current script language.


setScriptLanguage

public final void setScriptLanguage(StiReportLanguageType value)

getGlobalizationStrings

public final StiGlobalizationContainerCollection getGlobalizationStrings()
Gets a collection which consists of globalization strings.


setGlobalizationStrings

public void setGlobalizationStrings(StiGlobalizationContainerCollection globalizationStrings)

localizeReport

public void localizeReport(java.lang.String cultureName)
                    throws StiException
Throws:
StiException

getAutoLocalizeReportOnRun

public final boolean getAutoLocalizeReportOnRun()
Gets or sets property which allows automatic localization of the report when running starts.


setAutoLocalizeReportOnRun

public final void setAutoLocalizeReportOnRun(boolean value)

getParametersOrientation

public final StiOrientation getParametersOrientation()
Gets or sets value which indicates parameters panel orientation.


setParametersOrientation

public final void setParametersOrientation(StiOrientation value)

getRequestParameters

public final boolean getRequestParameters()
Gets or sets value which indicates whether to request parameters from a user before report rendering or render a report with the default value of parameters.


setRequestParameters

public final void setRequestParameters(boolean value)

getIsSerializing

public boolean getIsSerializing()

setIsSerializing

public final void setIsSerializing(boolean value)

getIsModified

public final boolean getIsModified()

setIsModified

public final void setIsModified(boolean value)

getDataSources

public StiDataSourcesCollection getDataSources()

getEngine

public StiEngine getEngine()

setEngine

public final void setEngine(StiEngine value)

getBusinessObjectsStore

public java.util.ArrayList<StiBusinessObjectData> getBusinessObjectsStore()

GetComponents

public StiComponentsCollection GetComponents()
Returns a list of all components, including pages in the report.

Returns:

GetRenderedComponents

public StiComponentsCollection GetRenderedComponents()
Returns a list of all rendered components, including rendered pages in the report.

Returns:
List of all rendered components.

applyStyleCollection

public void applyStyleCollection(java.lang.String collectionName)
Applies styles associated with the specified style collection to all components in the report.

Parameters:
collectionName -

applyStyles

public void applyStyles()
Applies styles of a report to all components in the report.


correctFormatProperties

public void correctFormatProperties()
Fix - correct Format property of the Text components. It's serialization order issue, Format property is calculated before all properties are applied to the TextFormat.


RenameStyle

public void RenameStyle(java.lang.String oldStylename,
                        java.lang.String newStyleName)

getComponents

public StiComponentsCollection getComponents()

getComponentsCount

public int getComponentsCount()

getVariables

public StiVariablesMap getVariables()

setVariables

public void setVariables(StiVariablesMap variables)

getIsPageDesigner

public final boolean getIsPageDesigner()

setIsPageDesigner

public final void setIsPageDesigner(boolean value)

WriteToReportRenderingMessages

public final void WriteToReportRenderingMessages(java.lang.String str)

getReportRenderingMessages

public final java.util.ArrayList<java.lang.String> getReportRenderingMessages()

setReportRenderingMessages

public final void setReportRenderingMessages(java.util.ArrayList<java.lang.String> value)

setCompiledReport

public void setCompiledReport(StiReport compiledReport)

getCompiledReport

public StiReport getCompiledReport()

getBookmark

public final StiBookmark getBookmark()
Gets or sets the root bookmark. Internal use only.


setBookmark

public final void setBookmark(StiBookmark value)

getPointer

public StiBookmark getPointer()

setPointer

public void setPointer(StiBookmark value)

getSelectionTick

public int getSelectionTick()

getRenderedPages

public final StiPagesCollection getRenderedPages()
Gets a collection of rendered pages from the current report.


setRenderedPages

public final void setRenderedPages(StiPagesCollection pagesCollection)

getIsDesigning

public final boolean getIsDesigning()
Gets value, which indicates that the report is being designed.


getIsExporting

public final boolean getIsExporting()
Gets value, which indicates that the report is exporting.


getIsPrinting

public final boolean getIsPrinting()
Gets or sets value, which indicates that the report printing is in process.


setIsPrinting

public final void setIsPrinting(boolean value)

getCurrentPrintPage

public final int getCurrentPrintPage()

setCurrentPrintPage

public final void setCurrentPrintPage(int value)

getStop

public boolean getStop()

setStop

public final void setStop(boolean value)

invokeRendering

public void invokeRendering()

getParentReport

public final StiReport getParentReport()

setParentReport

public final void setParentReport(StiReport value)

getColumn

public final int getColumn()

setColumn

public final void setColumn(int value)

getIsStopped

public final boolean getIsStopped()

setIsStopped

public final void setIsStopped(boolean value)

getIsRendered

public final boolean getIsRendered()

setIsRendered

public final void setIsRendered(boolean value)

Compile

public void Compile()

invokeRefreshViewer

public void invokeRefreshViewer()

setGroupLine

public void setGroupLine(int GroupLine)

getInteraction

public StiInteraction getInteraction()

invokeBeginRender

public void invokeBeginRender()

ResetAggregateFunctions

public void ResetAggregateFunctions()

InvokeEndRender

public void InvokeEndRender()

GetComponentByName

public final StiComponent GetComponentByName(java.lang.String componentName)

render

public final StiReport render()
Renders a report.

Returns:

Render

public final void Render()
Renders a report.


Render

public final void Render(boolean showProgress)
Renders a report.

Parameters:
showProgress - Whether it is necessary to show the progress of report rendering or not.

Render

public final void Render(boolean showProgress,
                         int fromPage,
                         int toPage)
Renders a report.

Parameters:
showProgress - Whether it is necessary to show the progress of report rendering or not.

Render

public void Render(StiRenderState renderState)
Renders a report.

Parameters:
showProgress - Whether it is necessary to show the progress of report rendering or not.

getUseProgressInThread

public boolean getUseProgressInThread()

setUseProgressInThread

public void setUseProgressInThread(boolean value)

processAutoLocalizeReportOnRun

public void processAutoLocalizeReportOnRun()

getProgress

public final IStiProgressInformation getProgress()

setProgress

public final void setProgress(IStiProgressInformation value)

getSubReports

public java.util.ArrayList<StiReport> getSubReports()

setSubReports

public final void setSubReports(java.util.ArrayList<StiReport> value)

setStatusString

public void setStatusString(java.lang.String statusString)

CheckExcelValue

public final java.lang.Object CheckExcelValue(java.lang.Object sender,
                                              java.lang.Object value)

ToString

public final java.lang.String ToString(java.lang.Object obj)
Internal use only. Used only for converting an object to the string.


ToString

public final java.lang.String ToString(java.lang.Object sender,
                                       java.lang.Object obj)

ToString

public final java.lang.String ToString(java.lang.Object sender,
                                       java.lang.Object obj,
                                       boolean allowExcelCheck)

getIsFirstPage

public final boolean getIsFirstPage()

getIsLastPage

public final boolean getIsLastPage()

getIsFirstPageThrough

public final boolean getIsFirstPageThrough()

getIsLastPageThrough

public final boolean getIsLastPageThrough()

getIsFirstPass

public final boolean getIsFirstPass()
Gets value which indicates that first report pass is rendered now.


getIsSecondPass

public final boolean getIsSecondPass()
Gets value which indicates that second report pass is rendered now.


getCurrentPage

public final int getCurrentPage()
Gets or sets the index of the current page. Counting starts from 0.


setCurrentPage

public final void setCurrentPage(int value)

setLine

public void setLine(int line)

getLine

public int getLine()

getNeedsCompiling

public final boolean getNeedsCompiling()

setNeedsCompiling

public final void setNeedsCompiling(boolean value)

getVariable

public final java.lang.Object getVariable(java.lang.String name)

setVariable

public final void setVariable(java.lang.String name,
                              java.lang.Object value)

convertToHInches

public final double convertToHInches(StiUnit unit,
                                     double value)

convertToHInches

public final StiRectangle convertToHInches(StiUnit unit,
                                           StiRectangle value)

exportDocument

public void exportDocument(StiExportFormat exportFormat,
                           StiExportService exportService,
                           java.io.File file,
                           StiExportSettings settings,
                           javax.swing.JFrame parent)
                    throws java.lang.Throwable
Throws:
java.lang.Throwable

invokeExported

public void invokeExported(StiExportFormat exportFormat)

invokeExporting

public void invokeExporting(StiExportFormat exportFormat)

invokePaint

public void invokePaint(StiEventHandlerArgs e)

invokePrinted

public void invokePrinted()

invokePrinting

public void invokePrinting()

invokeRefreshPreview

public void invokeRefreshPreview()

invokeStatusChanged

public void invokeStatusChanged()

getTotals

public final java.util.Hashtable<java.lang.String,java.lang.Object> getTotals()
Internal use only.


setTotals

public final void setTotals(java.util.Hashtable<java.lang.String,java.lang.Object> value)

saveDocument

public void saveDocument(java.io.OutputStream stream)
Saves a rendered report in the stream.

Parameters:
stream - A stream to save a rendered report.

saveDocumentToString

public java.lang.String saveDocumentToString()
                                      throws java.io.IOException
Saves a rendered report to the string.

Returns:
A string which contains the report template.
Throws:
java.io.IOException

getStatusHandler

public StiStatusHandler getStatusHandler()
Returns:
the statusHandler

setStatusHandler

public void setStatusHandler(StiStatusHandler statusHandler)
Parameters:
statusHandler - the statusHandler to set

getStatusString

public java.lang.String getStatusString()
Returns:
the statusString

isInterpretation

public boolean isInterpretation()

isPreviewDialogs

public boolean isPreviewDialogs()
Returns:
the previewDialogs

setPreviewDialogs

public void setPreviewDialogs(boolean previewDialogs)
Parameters:
previewDialogs - the previewDialogs to set

getIsSubmit

public java.lang.Boolean getIsSubmit()
Returns:
the isSubmit

setIsSubmit

public void setIsSubmit(java.lang.Boolean isSubmit)
Parameters:
isSubmit - the isSubmit to set

getCustomFunctions

public java.util.List<StiCustomFunction> getCustomFunctions()
Returns:
the customFunctions

isShowProgress

public boolean isShowProgress()
Returns:
the showProgress

setShowProgress

public void setShowProgress(boolean showProgress)
Parameters:
showProgress - the showProgress to set

getInteractionCollapsingStates

public java.util.HashMap<java.lang.String,java.lang.Object> getInteractionCollapsingStates()
Returns:
the interactionCollapsingStates

setInteractionCollapsingStates

public void setInteractionCollapsingStates(java.util.HashMap<java.lang.String,java.lang.Object> interactionCollapsingStates)
Parameters:
interactionCollapsingStates - the interactionCollapsingStates to set

isInteractionRendering

public boolean isInteractionRendering()
Returns:
the isInteractionRendering

setInteractionRendering

public void setInteractionRendering(boolean isInteractionRendering)
Parameters:
isInteractionRendering - the isInteractionRendering to set

get

public java.lang.Object get(java.lang.String name)

set

public void set(java.lang.String name,
                java.lang.Object value)

getCulture

public java.lang.String getCulture()
Returns:
the culture

setCulture

public void setCulture(java.lang.String culture)
Parameters:
culture - the culture to set

getModifiedVariables

public java.util.Hashtable<java.lang.String,java.lang.Boolean> getModifiedVariables()
Returns:
the modifiedVariables

setModifiedVariables

public void setModifiedVariables(java.util.Hashtable<java.lang.String,java.lang.Boolean> modifiedVariables)
Parameters:
modifiedVariables - the modifiedVariables to set

changeType

public static java.lang.Object changeType(java.lang.Object value,
                                          StiSystemType conversionType)
Changes a type of the specified value.

Parameters:
value - A parameter which type will be changed.
conversionType - A type to which the value parameter will be converted.
Returns:
Returns a value of the converted type.

changeType

public static java.lang.Object changeType(java.lang.Object value,
                                          StiSystemType conversionType,
                                          java.lang.Boolean convertNulls)
Changes a type of the specified value.

Parameters:
value - A parameter which type will be changed.
conversionType - A type to which the value parameter will be converted.
convertNulls - A parameter which, when converting zero values, instead of null, returns String.Empty, false for Boolean, ' ' for char or null for DateTime.
Returns:
Returns a value of the converted type.

getListOfUsedData

public java.lang.String[] getListOfUsedData()
Internal use only. List of used datasources for RetrieveOnlyUsedData feature.

Returns:
the listOfUsedData

setListOfUsedData

public void setListOfUsedData(java.lang.String[] listOfUsedData)
Internal use only. List of used datasources for RetrieveOnlyUsedData feature.

Parameters:
listOfUsedData - the listOfUsedData to set

getRetrieveOnlyUsedData

public boolean getRetrieveOnlyUsedData()
value, which indicates how report engine retrieve data - only used in the report data or all data.

Returns:
the retrieveOnlyUsedData

setRetrieveOnlyUsedData

public void setRetrieveOnlyUsedData(boolean retrieveOnlyUsedData)
value, which indicates how report engine retrieve data - only used in the report data or all data.

Parameters:
retrieveOnlyUsedData - the retrieveOnlyUsedData to set

isJsonReport

public boolean isJsonReport()
Returns:
the jsonReport

setJsonReport

public void setJsonReport(boolean jsonReport)
Parameters:
jsonReport - the jsonReport to set

updateReportVersion

public void updateReportVersion()

saveToJsonInternal

public java.lang.String saveToJsonInternal(StiJsonSaveMode mode)
                                    throws JSONException
Throws:
JSONException

loadFromJson

public void loadFromJson(java.lang.String text)
                  throws JSONException,
                         java.text.ParseException
Throws:
JSONException
java.text.ParseException

getJsonLoaderHelper

public StiReport.StiJsonLoaderHelper getJsonLoaderHelper()
Returns:
the jsonLoaderHelper

getLicenseKey

public java.lang.String getLicenseKey()
Returns:
the licenseKey

setLicenseKey

public void setLicenseKey(java.lang.String licenseKey)
Parameters:
licenseKey - the licenseKey to set

getReportResources

public StiReportResourceCollection getReportResources()

setReportResources

public void setReportResources(StiReportResourceCollection reportResources)
Parameters:
reportResources - the reportResources to set

loadFonts

public void loadFonts()

loadDocumentFonts

public void loadDocumentFonts()

getRefreshTime

public int getRefreshTime()
the time (in seconds) after which the report will be automatically rebuilt in the viewer.

Returns:
the refreshTime

setRefreshTime

public void setRefreshTime(int refreshTime)
Parameters:
refreshTime - the refreshTime to set

isSaveInteractionParametersToDocument

public boolean isSaveInteractionParametersToDocument()
Returns:
the saveInteractionParametersToDocument

setSaveInteractionParametersToDocument

public void setSaveInteractionParametersToDocument(boolean saveInteractionParametersToDocument)
Parameters:
saveInteractionParametersToDocument - the saveInteractionParametersToDocument to set

getResourceFontName

public java.lang.String getResourceFontName(java.lang.String resourceName)

addAnchor

public void addAnchor(java.lang.Object value)
Adds anchor.

Parameters:
value -

getAnchorPageNumber

public int getAnchorPageNumber(java.lang.Object value)

getAnchorPageNumberThrough

public int getAnchorPageNumberThrough(java.lang.Object value)

dispose

public void dispose()

getLocale

public java.util.Locale getLocale()