Package com.stimulsoft.report.engine.engineV2

Class StiEngine

java.lang.Object
com.stimulsoft.report.engine.engineV2.StiEngine
public class StiEngine extends Object

  • Field Details

    • OldWYSIWYG

      public static final boolean OldWYSIWYG
      See Also:

    • isDynamicBookmarksMode

      public boolean isDynamicBookmarksMode

    • isCrossBandsMode

      public boolean isCrossBandsMode

    • staticBands

      public StiStaticBandsHelper staticBands

    • masterEngine

      public StiEngine masterEngine

    • hashCheckSize

      public HashMap<StiComponent,StiSize> hashCheckSize

    • emptyBands

      public StiEmptyBandsV2Helper emptyBands

    • pageNumbers

      public StiPageNumberHelper pageNumbers

    • currentDataBandOfPageLine

      public StiDataBand currentDataBandOfPageLine
      The current data band associated with the page line.

    • pageLineRenderingEnabled

      public boolean pageLineRenderingEnabled
      A value indicating whether page line rendering is enabled.

    • columnsOnPanel

      public StiColumnsOnPanel columnsOnPanel

    • positionBottomY

      public double positionBottomY

    • containerForRender

      public StiContainer containerForRender

    • hashDataBandLastLine

      public Map<String,Integer> hashDataBandLastLine

    • templatePage

      public StiPage templatePage

    • templateContainer

      public StiContainer templateContainer

    • report

      public StiReport report

    • StartIndexPageForPageTotal

      public int StartIndexPageForPageTotal
      Contain start index of page for page total calculation. Used for running total

    • IndexPageForPageTotal

      public int IndexPageForPageTotal
      Contain index of page for page total calculation.

    • SilentMode

      public boolean SilentMode
      If a variable is true then output as a band is not done.

    • RenderState

      public StiRenderState RenderState
      Contains an information that is necessary to show progress of report rendering.

    • IndexOfLatestDataBand

      public StiIndex IndexOfLatestDataBand
      An index of the last rendered DataBand. The Index is used to put the AddLevel before this DataBand and make KeepFooterTogether properties work correct.

    • generateNewPageBeforeBand

      public boolean generateNewPageBeforeBand
      It is required to generate a new page before the next band. A flag is used to prevent empty pages after a band. A new page is not generated after the specified band but not before the next band. If there is no the next band then there is no a new page.

    • ignoreSkipFirst

      public boolean ignoreSkipFirst
      If true then the engine should ignore the value of the SkipFirst property of a band. It is necessary if NewPageAfter or NewColumnAfter are processed.

    • generateNewColumnBeforeBand

      public boolean generateNewColumnBeforeBand
      Requires to generate a new column before the next band. A flag is used to prevent empty columns after a band. A new column is not generated after the specified band but not before the next band. If there is no the next band then there is no a new column.

    • pageBreakSkipFirstCollection

      public Hashtable pageBreakSkipFirstCollection
      ��������� ������ ��� ����������� ������ �������� ��������� ����� �������� ��� ����� ������� ��� ������ �������� SkipFirst. ���� ���� ��� ��������� ���� ��� ��������� ����� �������� ��� �������, �� �� ��������� � ��� ���������.

    • IndexOfStartList

      public int IndexOfStartList
      Contains an index that indicates a position of the beginning the current column output. If there are no columns then contains 0.

    • skipFirstPageBeforePrintEvent

      public boolean skipFirstPageBeforePrintEvent
      ���� ������ ��� ������������� ������� BeforePrintEvent ��� ��������, ��� ��� ��� ������� ���������� ����� ��� ������ ��������� � ������� ��������

    • FirstCallNewPage

      public boolean FirstCallNewPage
      ���� ��������������� ������ ��� ��� ����� �������� �������. ��� �����������, ��� �������� �� ���������� ��������� UnlimitedHeight ������ ����������� �� ����� �������� � �� ������� �������� � ���������� ��������

    • DenyClearPrintOnAllPagesIgnoreList

      public boolean DenyClearPrintOnAllPagesIgnoreList
      ���� ��������������� �� ����� ���������� StiBandsOnAllPages ��� ����, ����� ���������, ������� ��������� �� ������ ��������, �� �������� ���� ������

    • duplicatesLastValues

      public Hashtable<String,String> duplicatesLastValues

    • lastInvokeTextProcessValueEventArgsValue

      public Object lastInvokeTextProcessValueEventArgsValue

    • atLeastOneDatabandRenderedOnPage

      public boolean atLeastOneDatabandRenderedOnPage

    • bandsInProgress

      public ArrayList<StiBand> bandsInProgress

    • AllowEndOfPageProcessing

      public boolean AllowEndOfPageProcessing

    • offsetNewColumnY

      public double offsetNewColumnY

    • anchorsArguments

      public Hashtable<String,String> anchorsArguments

    • firstPassPointer

      public StiBookmark firstPassPointer

  • Constructor Details

    • StiEngine

      public StiEngine(StiReport report)

  • Method Details

    • getDefaultTextQualityMode

      public StiTextQuality getDefaultTextQualityMode()

    • setDockPageFooterToBottom

      public void setDockPageFooterToBottom(boolean dockPageFooterToBottom)

    • isDockPageFooterToBottom

      public boolean isDockPageFooterToBottom()

    • getDefaultPaperSize

      public StiPaperKind getDefaultPaperSize()

    • getIsDynamicBookmarksMode

      public final boolean getIsDynamicBookmarksMode()
      If true then it is allowed to add any Bookmarks. If false then add Bookmarks of components which the IsRendered property = false (in other words it is rendered first time). This property allows adding Bookmarks for static components only once (to avoid duplication).

    • setIsDynamicBookmarksMode

      public final void setIsDynamicBookmarksMode(boolean value)

    • getIsCrossBandsMode

      public final boolean getIsCrossBandsMode()
      This property is set to true for printing CrossBands.

    • setIsCrossBandsMode

      public final void setIsCrossBandsMode(boolean value)

    • getIsFirstDataBandOnPage

      public final boolean getIsFirstDataBandOnPage()
      Returns true if the first DataBand is printed on the current page.

    • setIsFirstDataBandOnPage

      public final void setIsFirstDataBandOnPage(boolean value)

    • getIsLastDataBandOnPage

      public final boolean getIsLastDataBandOnPage()
      Returns true if the last DataBand is printed on the current page.

    • setIsLastDataBandOnPage

      public final void setIsLastDataBandOnPage(boolean value)

    • getLastRenderedDataBand

      public StiDataBand getLastRenderedDataBand()
      The last processed databand during the report rendering.
      Returns:

    • setLastRenderedDataBand

      public void setLastRenderedDataBand(StiDataBand lastRenderedDataBand)
      The last processed databand during the report rendering.
      Parameters:
      lastRenderedDataBand -

    • getPrintOnAllPagesIgnoreList

      public final Hashtable getPrintOnAllPagesIgnoreList()
      Contains the list of bands which should be passed when rendering.

    • getProgressHelper

      public final StiProgressHelper getProgressHelper()
      A class helps to output the progress bar when report rendering.

    • getBandsOnAllPages

      public final StiBandsOnAllPages getBandsOnAllPages()
      Contains a collection of bands which should be output on all pages.

    • getDenyRenderMasterComponentsInContainer

      public final boolean getDenyRenderMasterComponentsInContainer()
      If true then the Render method of a container will not render components of the Master type. This property is used with the RenderSimpleComponents method of a page. It is used to deny master components and render simple ones.

    • setDenyRenderMasterComponentsInContainer

      public final void setDenyRenderMasterComponentsInContainer(boolean value)

    • getPrintAtBottom

      public final StiPrintAtBottom getPrintAtBottom()
      Contains a collection of bands which should be output on the bottom of a page. The list is filled when stream rendering and the list is cleared when rendering of the current stream is finished.

    • getFootersOnAllPages

      public final StiFootersOnAllPages getFootersOnAllPages()
      Cotnains a collection of Footers which should be output on the bottom of a page. The list is filled when stream rendering and the list is cleared when rendering of the current stream is finished.

    • getStaticBands

      public final StiStaticBandsHelper getStaticBands()
      An object helps to output static bands on a page.

    • getThreads

      public final StiThreads getThreads()
      This object helps to print groups of bands from containers which are placed directly on a page.

    • getBreakable

      public final StiBreakableHelper getBreakable()
      An object helps to work with IStiBreakable interface.

    • getDenyChangeThread

      public final boolean getDenyChangeThread()
      If true then it is impossible to change stream of printing.

    • setDenyChangeThread

      public final void setDenyChangeThread(boolean value)

    • getSlaveEngines

      public final Hashtable<String,StiEngine> getSlaveEngines()
      Contains a list of Slave Engines.

    • getMasterEngine

      public final StiEngine getMasterEngine()
      If an engine is slave then this reference indicates the parent report engine.

    • setMasterEngine

      public final void setMasterEngine(StiEngine value)

    • getEmptyBands

      public final StiEmptyBandsV2Helper getEmptyBands()
      Used to output EmptyBands in the current container.

    • getPageNumbers

      public final StiPageNumberHelper getPageNumbers()

    • getColumnsOnDataBand

      public final StiColumnsOnDataBand getColumnsOnDataBand()
      Used to output columns on the DataBand.

    • getColumnsOnPanel

      public final StiColumnsOnPanel getColumnsOnPanel()
      Used to output columns on the Panel.

    • getFreeSpace

      public final double getFreeSpace()
      Contains a freespace in a container in what the printing is done.

    • setFreeSpace

      public final void setFreeSpace(double value)

    • getCrossFreeSpace

      public final double getCrossFreeSpace()
      Contains a freespace in a container in what the printing is done. Used to output Cross bands only.

    • setCrossFreeSpace

      public final void setCrossFreeSpace(double value)

    • getPositionX

      public final double getPositionX()
      Indicates the current position bands output on the X axis.

    • setPositionX

      public final void setPositionX(double value)

    • getPositionY

      public final double getPositionY()
      Indicates the current position bands output on the Y axis.

    • setPositionY

      public final void setPositionY(double value)

    • getPositionBottomY

      public final double getPositionBottomY()
      Indicates the current position bands output on the Y axis on the bottom of a page.

    • setPositionBottomY

      public final void setPositionBottomY(double value)

    • getContainerForRender

      public final StiContainer getContainerForRender()
      Gets or sets a container in what rendering of bands is done.

    • setContainerForRender

      public final void setContainerForRender(StiContainer value)

    • getPage

      public final StiPage getPage()
      Gets or sets a page in what rendering of bands is done.

    • setPage

      public final void setPage(StiPage value)

    • getTemplatePage

      public final StiPage getTemplatePage()
      Gets or sets a page from a template. This page is being rendered in the current moment.

    • setTemplatePage

      public final void setTemplatePage(StiPage value)

    • getTemplateContainer

      public final StiContainer getTemplateContainer()
      Gets or sets a container from a template. This page is being rendered in the current moment. If a page is output then the TemplateContainer property is equal in TemplatePage.

    • setTemplateContainer

      public final void setTemplateContainer(StiContainer value)

    • getReport

      public final StiReport getReport()
      Gets or sets a report that is being rendered in the current moment.

    • setReport

      public final void setReport(StiReport value)

    • getMasterReport

      public final StiReport getMasterReport()
      Gets or sets a master report that is being rendered in the current moment.

    • setMasterReport

      public final void setMasterReport(StiReport value)

    • getIgnoreUnlimitedHeightForNewPage

      public final boolean getIgnoreUnlimitedHeightForNewPage()
      If true then UnlimitedHeight property is ignored when NewPage method is called.

    • setIgnoreUnlimitedHeightForNewPage

      public final void setIgnoreUnlimitedHeightForNewPage(boolean value)

    • getparserConversionStore

      public final Hashtable getparserConversionStore()

    • setparserConversionStore

      public final void setparserConversionStore(Hashtable value)

    • NewList

      public final void NewList()
      A method is called for each new page or column. If the first column is output or thre are no columns then a method outputs statis bands. ����� ����� �� �������� ��������� �� ��������� ���������� DataBand. Also a method prints bands which should be output on all pages.

    • NewList

      public final void NewList(boolean skipStaticBands)
      A method is called for each new page or column. ���� ��������� ������ ������� ��� ������� ��� ������, �� ����� ������� ����������� �����. ����� ����� �� �������� ��������� �� ��������� ���������� DataBand. ����� ����� ������� �� ������ �� �����, ������� ������ ���� �������� �� ���� ���������.
      Parameters:
      skipStaticBands - If true then static bands will not be rendered. It is used to render cross-bands which are placed in static bands.

    • NewColumn

      public final void NewColumn()
      A method forms a new column.

    • NewColumn

      public final void NewColumn(boolean ignoreKeepContainers)
      A method forms a new column.
      Parameters:
      ignoreKeepContainers -

    • NewPage

      public final void NewPage()
      A method forms a new page in a report.

    • NewPage

      public final void NewPage(boolean ignoreKeepContainers)
      A method forms a new page in a report.
      Parameters:
      ignoreKeepContainers - If true, then ��� ������������ ����� ��������, ������� ��������� ����������� ����� ��������������.

    • NewDestination

      public final void NewDestination()
      Forms a new page of a new column (if there are some).

    • NewDestination

      public final void NewDestination(boolean ignoreKeepContainers)
      Forms a new page of a new column (if there are some).
      Parameters:
      ignoreKeepContainers - ���� ����� true, �� ��� ������������ ����� �������� (��� �������), ������� ��������� ����������� ����� ��������������.

    • AddFooterMarker

      public final void AddFooterMarker(StiFooterBand footerMaster)
      Adds a FooterMarker (special container) into the current container of output. A container-marker is used for the engine to know on what place in a container of output FooterBands for PrintOnAllPages should be replaced after their rendering is complete.

    • AddKeepLevelAtLatestDataBand

      public final void AddKeepLevelAtLatestDataBand()
      Adds a container-marker of the beginning of grouping before the last rendered DataBand.

    • AddLevel

      public final void AddLevel()
      Adds a container-marker of the beginning of grouping into the current position of output in the stream.

    • RemoveLevel

      public final void RemoveLevel()
      Adds a container-marker of the end of grouping into the current position of output in the stream.

    • ClearPageBreakSkipFirst

      public final void ClearPageBreakSkipFirst()
      Clears a collection of bands which once passed the generation of a new page or column.

    • CanGenerateNewContainer

      public final boolean CanGenerateNewContainer(IStiPageBreak pageBreak)
      Returns true if the specified container can generate a new page or a column in this time. If the SkipFirst property is false then, in any case true is returned. If true, �� �� ������ ��� ����� ��������� ������������ ����� ������� ��� ����� �������� � ������� ���� � ���������.
      Parameters:
      pageBreak -
      Returns:

    • RemoveBandFromPageBreakSkipList

      public final void RemoveBandFromPageBreakSkipList(IStiPageBreak pageBreak)

    • ProcessPageAfterRendering

      public void ProcessPageAfterRendering(StiPage page, boolean isFinal)

    • ProcessLastPageAfterRendering

      public final void ProcessLastPageAfterRendering()

    • FinalClear

      public final void FinalClear()
      A method is called to finalize operations over the output stream.

    • SetNewPageParameters

      public final void SetNewPageParameters()
      Sets parameters to output a new page.

    • RenderFootersOnAllPages

      public final void RenderFootersOnAllPages(StiContainer outContainer, int startIndex, StiContainer markerContainer)

    • RenderEmptyBands

      public final void RenderEmptyBands(StiContainer containerForRender, StiContainer selectedContainer)
      Render selected EmptyBand in the specified container.

    • RenderPrintAtBottom

      public final void RenderPrintAtBottom(StiContainer container, int startIndex, StiContainer markerContainer)

    • FinishContainer

      public final void FinishContainer(StiContainer containerForRender)
      Find all containers and zero the ParentBand property.
      Parameters:
      containerForRender -

    • FinishResetPageNumberContainer

      public final void FinishResetPageNumberContainer(StiContainer containerForRender, boolean isFinal)

    • FinishColumns

      public final void FinishColumns(StiContainer containerForRender)

    • AddContainerToDestination

      public final void AddContainerToDestination(StiContainer container)
      Adds a specified container into the container for output.

    • InvokePageAfterPrint

      public final void InvokePageAfterPrint()

    • AddPageToRenderedPages

      public final void AddPageToRenderedPages(StiPage page)
      Adds a specified page into the collection of rendered pages.

    • checkForDuplicate

      public boolean checkForDuplicate(String textName, String value, String tag)

    • ResetProcessingDuplicates

      public final void ResetProcessingDuplicates(String componentName)

    • RenderBand

      public final StiComponentsCollection RenderBand(StiBand band)
      Renders a specified band taking Child bands into consideration.
      Parameters:
      band -
      Returns:

    • RenderBand

      public final StiComponentsCollection RenderBand(StiBand band, boolean ignorePageBreaks, boolean allowRenderingEvents)
      Renders a specified band taking Child bands into consideration.
      Parameters:
      band - Tha band that should be rendered.
      ignorePageBreaks - True, if it is necessary to ignore NewPageAfter, NewPageBefore, NewColumnAfter, and NewColumnBefore properties.
      allowRenderingEvents - True, if it isnecessary to call the Rendering event. ��� DataBand � ��� GroupHeaderBand.
      Returns:
      The list of rendered containers for the specified band.

    • RenderContainer

      public final StiContainer RenderContainer(StiContainer container)
      Renders a specified container in the current container for output.
      Parameters:
      container - A container that should be rendered.
      Returns:
      Rendered container.

    • getUniqueShortName

      public String getUniqueShortName(String fullName)

    • setParserConversionStore

      public void setParserConversionStore(Hashtable value)

    • getParserConversionStore

      public Hashtable getParserConversionStore()

    • getKeepFirstDetailTogetherList

      public HashMap<StiDataBand,StiDataBand> getKeepFirstDetailTogetherList()

    • getHashParentStyles

      public Hashtable<StiComponent,StiBaseStyle> getHashParentStyles()
      Returns:
      the hashParentStyles

    • getHashUseParentStyles

      public Hashtable<StiComponent,Boolean> getHashUseParentStyles()
      Returns:
      the hashUseParentStyles

    • setHashUseParentStyles

      public void setHashUseParentStyles(Hashtable<StiComponent,Boolean> hashUseParentStyles)
      Parameters:
      hashUseParentStyles - the hashUseParentStyles to set

    • setHashParentStyles

      public void setHashParentStyles(Hashtable<StiComponent,StiBaseStyle> hashParentStyles)
      Parameters:
      hashParentStyles - the hashParentStyles to set