Package com.stimulsoft.report

Class StiReport

java.lang.Object
com.stimulsoft.base.serializing.StiSerializedObject
com.stimulsoft.report.StiReport
All Implemented Interfaces:
IStiReport, IStiSerializable, IStiSerializableRef, IStiUnitConvert, IStiEngineVersionProperty, Serializable, Cloneable
public class StiReport extends StiSerializedObject implements IStiReport, Cloneable, IStiUnitConvert, IStiEngineVersionProperty, IStiSerializableRef, Serializable
Report class.
See Also:

  • Field Details

    • dictionary

      public StiDictionary dictionary

    • pages

      public StiPagesCollection pages

    • reportCacheMode

      public StiReportCacheMode reportCacheMode

    • compiledReport

      public StiReport compiledReport

    • bookmarkValue

      public StiBookmark bookmarkValue

    • DataBandsUsedInPageTotals

      public String[] DataBandsUsedInPageTotals

    • LineThrough

      public int LineThrough

    • LineABC

      public int LineABC

    • LineRoman

      public int LineRoman

    • useProgressInThread

      public boolean useProgressInThread

    • reportRenderingMessages

      public ArrayList<String> reportRenderingMessages

    • interactionCollapsingStates

      public HashMap<String,Object> interactionCollapsingStates

    • progressOfRendering

      public int progressOfRendering

    • progress

      public IStiProgressInformation progress

    • subReports

      public ArrayList<StiReport> subReports

    • reportSource

      public String reportSource

    • tag

      public Object tag

    • reportCachePath

      public String reportCachePath

    • imageCachePath

      public String imageCachePath

    • rtfCachePath

      public String rtfCachePath

    • parentReport

      public StiReport parentReport

    • manualBookmark

      public StiBookmark manualBookmark

    • reportMeasureGraphics

      public StiGraphics reportMeasureGraphics

    • password

      public String password

    • dataBandsUsedInPageTotals

      public 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 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

    • isReportRenderingAfterSubmit

      public boolean isReportRenderingAfterSubmit

    • parametersDisplayMode

      public StiParametersDisplayMode parametersDisplayMode

    • 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 Details

    • StiReport

      public StiReport()

  • Method Details

    • 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()

    • getPageLine

      public String getPageLine()
      Gets current line starts at the beginning of a report

    • getPageNofM

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

    • getPageNofMThrough

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

    • getPageNofMLocalizationString

      public final 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(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)
      Specified by:
      setReference in interface IStiSerializableRef
      Overrides:
      setReference in class StiSerializedObject

    • getReference

      public int getReference()
      Specified by:
      getReference in interface IStiSerializableRef
      Overrides:
      getReference in class StiSerializedObject

    • setDictionary

      public void setDictionary(StiDictionary dictionary)

    • getDictionary

      public StiDictionary getDictionary()

    • getEngineVersionStr

      public String getEngineVersionStr()

    • getReportFile

      public String getReportFile()

    • getScript

      public String getScript()

    • setReportFile

      public void setReportFile(String reportFile)

    • setScript

      public void setScript(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 String getReportVersion()
      Gets or sets version of the report engine which changed the report last time.

    • setReportVersion

      public final void setReportVersion(String value)

    • getReportGuid

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

    • setReportGuid

      public final void setReportGuid(String value)

    • getAnchor

      public StiRuntimeVariables getAnchor(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 String getReportName()
      Gets or sets a report name.

    • setReportName

      public final void setReportName(String value)

    • getReportAlias

      public final String getReportAlias()
      Gets or sets a report alias.

    • setReportAlias

      public final void setReportAlias(String value)

    • getReportAuthor

      public final String getReportAuthor()
      Gets or sets a report author.

    • setReportAuthor

      public final void setReportAuthor(String value)

    • getReportDescription

      public final String getReportDescription()
      Gets or sets a report description.

    • setReportDescription

      public final void setReportDescription(String value)

    • getReportCreated

      public final Calendar getReportCreated()
      Gets or sets the date of the report creation.

    • setReportCreated

      public final void setReportCreated(Calendar value)

    • getReportChanged

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

    • setReportChanged

      public final void setReportChanged(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)

    • 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 long getPreviewSettings()
      Gets or sets controls which will be shown in the Viewer Window.

    • setPreviewSettings

      public final void setPreviewSettings(long 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 ArrayList<String> getReferencedAssemblies()
      Gets or sets an array of referenced assemblies.

    • setReferencedAssemblies

      public final void setReferencedAssemblies(ArrayList<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(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 ArrayList<StiBusinessObjectData> getBusinessObjectsStore()

    • getScriptTimeout

      public int getScriptTimeout()

    • setScriptTimeout

      public void setScriptTimeout(int scriptTimeout)

    • 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(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(String oldStylename, 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(String str)

    • getReportRenderingMessages

      public final ArrayList<String> getReportRenderingMessages()

    • setReportRenderingMessages

      public final void setReportRenderingMessages(ArrayList<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(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 ArrayList<StiReport> getSubReports()

    • setSubReports

      public final void setSubReports(ArrayList<StiReport> value)

    • setStatusString

      public void setStatusString(String statusString)

    • CheckExcelValue

      public final Object CheckExcelValue(Object sender, Object value)

    • ToString

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

    • ToString

      public final String ToString(Object sender, Object obj)

    • ToString

      public final String ToString(Object sender, 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 Object getVariable(String name)

    • setVariable

      public final void setVariable(String name, 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, File file, StiExportSettings settings, JFrame parent) throws Throwable
      Throws:
      Throwable

    • invokeExported

      public void invokeExported(StiExportFormat exportFormat)

    • onExported

      protected void onExported(StiExportEventArgs e)

    • invokeExporting

      public void invokeExporting(StiExportFormat exportFormat)

    • onExporting

      protected void onExporting(StiExportEventArgs e)

    • invokePaint

      public void invokePaint(EventArgs e)

    • invokePrinted

      public void invokePrinted()

    • invokePrinting

      public void invokePrinting()

    • invokeRefreshPreview

      public void invokeRefreshPreview()

    • invokeStatusChanged

      public void invokeStatusChanged()

    • getTotals

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

    • setTotals

      public final void setTotals(Hashtable<String,Object> value)

    • saveDocument

      public void saveDocument(OutputStream stream)
      Saves a rendered report in the stream.
      Parameters:
      stream - A stream to save a rendered report.

    • saveDocumentToString

      public String saveDocumentToString() throws IOException
      Saves a rendered report to the string.
      Returns:
      A string which contains the report template.
      Throws:
      IOException

    • getStatusHandler

      public StiStatusHandler getStatusHandler()
      Returns:
      the statusHandler

    • setStatusHandler

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

    • getStatusString

      public 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 Boolean getIsSubmit()
      Returns:
      the isSubmit

    • setIsSubmit

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

    • getCustomFunctions

      public 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 HashMap<String,Object> getInteractionCollapsingStates()
      Returns:
      the interactionCollapsingStates

    • setInteractionCollapsingStates

      public void setInteractionCollapsingStates(HashMap<String,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 Object get(String name)

    • set

      public void set(String name, Object value)

    • getCulture

      public String getCulture()
      Returns:
      the culture

    • setCulture

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

    • getModifiedVariables

      public HashMap<String,Boolean> getModifiedVariables()
      Returns:
      the modifiedVariables

    • setModifiedVariables

      public void setModifiedVariables(HashMap<String,Boolean> modifiedVariables)
      Parameters:
      modifiedVariables - the modifiedVariables to set

    • changeType

      public static Object changeType(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 Object changeType(Object value, StiSystemType conversionType, 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 String[] getListOfUsedData()
      Internal use only. List of used datasources for RetrieveOnlyUsedData feature.
      Returns:
      the listOfUsedData

    • setListOfUsedData

      public void setListOfUsedData(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 String saveToJsonInternal(StiJsonSaveMode mode) throws JSONException
      Throws:
      JSONException

    • loadFromJson

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

    • getJsonLoaderHelper

      public StiReport.StiJsonLoaderHelper getJsonLoaderHelper()
      Returns:
      the jsonLoaderHelper

    • getLicenseKey

      public String getLicenseKey()
      Returns:
      the licenseKey

    • setLicenseKey

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

    • getParametersDisplayMode

      public StiParametersDisplayMode getParametersDisplayMode()

    • setParametersDisplayMode

      public void setParametersDisplayMode(StiParametersDisplayMode parametersDisplayMode)

    • getReportResources

      public StiReportResourceCollection getReportResources()

    • setReportResources

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

    • loadFonts

      public void loadFonts()

    • loadDocumentFonts

      public void loadDocumentFonts()

    • getPreviewToolBarOptions

      public StiPreviewToolBarOptions getPreviewToolBarOptions()
      Returns:
      the previewToolBarOptions

    • setPreviewToolBarOptions

      public void setPreviewToolBarOptions(StiPreviewToolBarOptions previewToolBarOptions)
      Parameters:
      previewToolBarOptions - the previewToolBarOptions to set

    • 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 String getResourceFontName(String resourceName)

    • addAnchor

      public void addAnchor(Object value)
      Adds anchor.
      Parameters:
      value -

    • getAnchorPageNumber

      public int getAnchorPageNumber(Object value)

    • getAnchorPageNumberThrough

      public int getAnchorPageNumberThrough(Object value)

    • dispose

      public void dispose()

    • getLocale

      public Locale getLocale()

    • getKey

      public String getKey()
      Returns:
      the key

    • setKey

      public void setKey(String key)
      Parameters:
      key - the key to set

    • getLabel

      public String getLabel(String variableName)
      Returns a label of the specified variable.
      Parameters:
      variableName -
      Returns:

    • isAllowScriptsInExpressions

      public boolean isAllowScriptsInExpressions()
      Specifies whether scripts can be used in expressions. You can write a script with 'return' statement in any expression if true.
      Returns:

    • setAllowScriptsInExpressions

      public void setAllowScriptsInExpressions(boolean allowScriptsInExpressions)
      Specifies whether scripts can be used in expressions. You can write a script with 'return' statement in any expression if true.
      Parameters:
      allowScriptsInExpressions -

    • isAllowScriptsToRun

      public boolean isAllowScriptsToRun()
      Specifies whether scripts can be run in Interpretation mode. In Compilation mode, scripts are compiled and run unconditionally.
      Returns:

    • setAllowScriptsToRun

      public void setAllowScriptsToRun(boolean allowScriptsToRun)
      Specifies whether scripts can be run in Interpretation mode. In Compilation mode, scripts are compiled and run unconditionally.
      Parameters:
      allowScriptsToRun -

    • getParam

      public Object getParam(String paramName)
      Returns a value of the specified variable or parameter.
      Parameters:
      paramName -
      Returns:

    • getHtmlPreviewMode

      public StiHtmlPreviewMode getHtmlPreviewMode()
      Returns:
      the htmlPreviewMode

    • setHtmlPreviewMode

      public void setHtmlPreviewMode(StiHtmlPreviewMode htmlPreviewMode)
      Parameters:
      htmlPreviewMode - the htmlPreviewMode to set

    • getCustomFonts

      public HashMap<Font,byte[]> getCustomFonts()

    • setCustomFonts

      public void setCustomFonts(HashMap<Font,byte[]> customFonts)

    • getParameterWidth

      public int getParameterWidth()
      A width in pixels of a parameter in the viewer. The default value is used if a zero value is specified.
      Returns:

    • setParameterWidth

      public void setParameterWidth(int parameterWidth)

    • getParameterAlignment

      public StiHorAlignment getParameterAlignment()
      A horizontal alignment of parameters in the viewer
      Returns:

    • setParameterAlignment

      public void setParameterAlignment(StiHorAlignment parameterAlignment)

    • getExportSettings

      public StiExportSettingsList getExportSettings()

    • setExportSettings

      public void setExportSettings(StiExportSettingsList exportSettings)
      Allows you to specify default options for the report export parameters that will be used when exporting the document.
      Parameters:
      exportSettings -

    • getExportSettingsString

      public String getExportSettingsString()

    • isStoreImagesInResources

      public boolean isStoreImagesInResources()
      If enabled, all images (including those defined in resources and duplicate images) are stored in the report’s Resources, and report elements use only references to them.
      Returns:

    • setStoreImagesInResources

      public void setStoreImagesInResources(boolean storeImagesInResources)
      If enabled, all images (including those defined in resources and duplicate images) are stored in the report’s Resources, and report elements use only references to them.

    • setExportSettingsString

      public void setExportSettingsString(String value)

    • regOleDbConnection

      public StiDatabase regOleDbConnection(String name, String connectionString, boolean synchronize)

    • regOdbcConnection

      public StiDatabase regOdbcConnection(String name, String connectionString, boolean synchronize)

    • regMySqlConnection

      public StiDatabase regMySqlConnection(String name, String connectionString, boolean synchronize)

    • regDuckDbConnection

      public StiDatabase regDuckDbConnection(String name, String connectionString, boolean synchronize)

    • regPostgreSqlConnection

      public StiDatabase regPostgreSqlConnection(String name, String connectionString, boolean synchronize)

    • regOracleConnection

      public StiDatabase regOracleConnection(String name, String connectionString, boolean synchronize)

    • regSqlServerConnection

      public StiDatabase regSqlServerConnection(String name, String connectionString, boolean synchronize)

    • regJsonFile

      public StiDatabase regJsonFile(String name, String fileName, boolean synchronize)
      Registers a new connection to the JSON data file.
      Parameters:
      name - A name of the JSON connection in the dictionary.
      fileName - A file path to the JSON data file.
      synchronize - If true, then Data Sources, Columns and Relations from the JSON data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regExcelFile

      public StiDatabase regExcelFile(String name, String fileName, boolean synchronize)
      Registers a new connection to the EXCEL data file.
      Parameters:
      name - A name of the EXCEL connection in the dictionary.
      fileName - A file path to the EXCEL data file.
      synchronize - If true, then Data Sources, Columns and Relations from the EXCEL data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regCsvFile

      public StiDatabase regCsvFile(String name, String fileName, boolean synchronize)
      Registers a new connection to the CSV data file.
      Parameters:
      name - A name of the CSV connection in the dictionary.
      fileName - A file path to the CSV data file.
      synchronize - If true, then Data Sources, Columns and Relations from the CSV data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regDbfFile

      public StiDatabase regDbfFile(String name, String fileName, boolean synchronize)
      Registers a new connection to the DBF data file.
      Parameters:
      name - A name of the DBF connection in the dictionary.
      fileName - A file path to the DBF data file.
      synchronize - If true, then Data Sources, Columns and Relations from the DBF data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regXmlFile

      public StiDatabase regXmlFile(String name, String fileName, boolean synchronize)
      Registers a new connection to the XML data file.
      Parameters:
      name - A name of the XML connection in the dictionary.
      fileName - A file path to the XML data file.
      synchronize - If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regXmlFile

      public StiDatabase regXmlFile(String name, String fileNameSchema, String fileNameData, boolean synchronize)
      Registers a new XML connection to the data file.
      Parameters:
      name - A name of the XML connection in the dictionary.
      fileNameSchema - A file path to the XML schema file.
      fileNameData - A file path to the XML data file.
      synchronize - If true, then Data Sources, Columns and Relations from the data file will be created or updated in the Dictionary.
      Returns:
      The created XML connection in the dictionary.

    • regJsonData

      public StiDatabase regJsonData(String name, byte[] data, boolean synchronize)
      Registers a new connection to the JSON data file.
      Parameters:
      name - A name of the JSON connection in the dictionary.
      data - A data for this new connection.
      synchronize - If true, then Data Sources, Columns and Relations from the JSON data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regExcelData

      public StiDatabase regExcelData(String name, byte[] data, boolean synchronize)
      Registers a new connection to the EXCEL data file.
      Parameters:
      name - A name of the EXCEL connection in the dictionary.
      data - A data for this new connection.
      synchronize - If true, then Data Sources, Columns and Relations from the EXCEL data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regCsvData

      public StiDatabase regCsvData(String name, byte[] data, boolean synchronize)
      Registers a new connection to the CSV data file.
      Parameters:
      name - A name of the CSV connection in the dictionary.
      data - A data for this new connection.
      synchronize - If true, then Data Sources, Columns and Relations from the CSV data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regDbfData

      public StiDatabase regDbfData(String name, byte[] data, boolean synchronize)
      Registers a new connection to the DBF data file.
      Parameters:
      name - A name of the DBF connection in the dictionary.
      data - A data for this new connection.
      synchronize - If true, then Data Sources, Columns and Relations from the DBF data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regXmlData

      public StiDatabase regXmlData(String name, byte[] data, boolean synchronize)
      Registers a new connection to the XML data file.
      Parameters:
      name - A name of the XML connection in the dictionary.
      data - A data for this new connection.
      synchronize - If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regXmlData

      public StiDatabase regXmlData(String name, byte[] schema, byte[] data, boolean synchronize)
      Registers a new connection to the XML data file.
      Parameters:
      name - A name of the XML connection in the dictionary.
      schema - A XSD-schema for this new connection.
      data - A XML-data for this new connection.
      synchronize - If true, then Data Sources, Columns and Relations from the XML data file will be created or updated in the Dictionary.
      Returns:
      The created connection in the dictionary.

    • regData

      public void regData(String name, DataTable table)

    • resetRenderedState

      public StiReport resetRenderedState()

    • getCompilerResults

      public CompilerResults getCompilerResults()

    • setCompilerResults

      public void setCompilerResults(CompilerResults compilerResults)