Package com.stimulsoft.report.components.bands

Class StiDataBand

java.lang.Object
com.stimulsoft.base.serializing.StiSerializedObject
com.stimulsoft.base.services.StiService
com.stimulsoft.report.StiBase
com.stimulsoft.report.components.StiComponent
com.stimulsoft.report.components.complexcomponents.StiContainer
com.stimulsoft.report.components.bands.StiBand
com.stimulsoft.report.components.bands.StiDynamicBand
com.stimulsoft.report.components.bands.StiDataBand
All Implemented Interfaces:
IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiBusinessObject, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiDataRelation, IStiDataSource, IStiFilter, IStiGrowToHeight, IStiInteraction, IStiKeepDetailsTogether, IStiKeepFooterTogether, IStiKeepGroupTogether, IStiKeepHeaderTogether, IStiMasterComponent, IStiOddEvenStyles, IStiPageBreak, IStiPrintAtBottom, IStiPrintIfDetailEmpty, IStiPrintOn, IStiPrintOnAllPages, IStiRenderMaster, IStiResetPageNumber, IStiSelect, IStiShift, IStiSort, IStiStartNewPage, IStiUnitConvert, IStiEnumerator, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable
Direct Known Subclasses:
StiCrossDataBand, StiHierarchicalBand, StiTable, StiTableOfContents
public class StiDataBand extends StiDynamicBand implements IStiDataSource, IStiMasterComponent, IStiDataRelation, IStiOddEvenStyles, IStiSort, IStiFilter, IStiStartNewPage, IStiPrintOnAllPages, IStiPrintIfDetailEmpty, IStiKeepDetailsTogether, IStiKeepFooterTogether, IStiKeepGroupTogether, IStiKeepHeaderTogether, IStiResetPageNumber, IStiRenderMaster, IStiBusinessObject

  • Field Details

    • PropertyEvenStyle

      public static Object PropertyEvenStyle

    • PropertyOddStyle

      public static Object PropertyOddStyle

    • isBofValue

      public boolean isBofValue

    • isEofValue

      public boolean isEofValue

    • lineThrough

      public int lineThrough

    • jsonMasterComponentTemp

      public String jsonMasterComponentTemp

    • handlerRendering

      public StiEventHandler handlerRendering

  • Constructor Details

    • StiDataBand

      public StiDataBand()
      Creates an object of the type StiDataBand.

    • StiDataBand

      public StiDataBand(StiRectangle rect)
      Creates an object of the type StiDataBand.
      Parameters:
      rect - The rectangle decribes size and position of the component.

  • Method Details

    • getLimitRows

      public String getLimitRows()
      Returns:
      the limitRows

    • setLimitRows

      public void setLimitRows(String limitRows)
      Parameters:
      limitRows - the limitRows to set

    • convert

      public void convert(StiUnit oldUnit, StiUnit newUnit)
      Converts a component out of one unit into another.
      Specified by:
      convert in interface IStiUnitConvert
      Overrides:
      convert in class StiContainer
      Parameters:
      oldUnit - Old units.
      newUnit - New units.

    • doBookmark

      public boolean doBookmark()
      Description copied from class: StiComponent
      Invokes the getBookmark event.
      Overrides:
      doBookmark in class StiComponent

    • doPointer

      public void doPointer()
      Overrides:
      doPointer in class StiComponent

    • First

      public void First()
      Sets the position at the beginning.
      Specified by:
      First in interface IStiEnumerator

    • getBeginRenderEvent

      public final StiBeginRenderEvent getBeginRenderEvent()
      Occurs when band begin render.

    • getBusinessObject

      public StiBusinessObject getBusinessObject()
      Get business object that is used for getting data.
      Specified by:
      getBusinessObject in interface IStiBusinessObject

    • getBusinessObjectGuid

      public final String getBusinessObjectGuid()
      Gets or sets guid of the Business Object.
      Specified by:
      getBusinessObjectGuid in interface IStiBusinessObject

    • getCalcInvisible

      public boolean getCalcInvisible()
      Gets or sets value which indicates that, when aggregate functions calculation, it is nesessary to take into consideration invisible data bands.

    • getCollapsed

      public StiCollapsedExpression getCollapsed()
      Gets or sets an expression to fill a collapsed value.

    • getColumnDirection

      public StiColumnDirection getColumnDirection()
      Gets or sets direction of the rendeting columns.

    • getColumnGaps

      public double getColumnGaps()
      Gets or sets distance between two columns.

    • getColumns

      public int getColumns()
      Gets or sets columns count.

    • getColumnWidth

      public double getColumnWidth()
      Gets or sets width of column.

    • GetColumnWidth

      public final double GetColumnWidth()

    • getComponentType

      public StiComponentType getComponentType()
      Gets the type of processing when printing.
      Overrides:
      getComponentType in class StiBand

    • getCount

      public int getCount()
      Gets count of rows.
      Specified by:
      getCount in interface IStiEnumerator

    • getCountData

      public int getCountData()
      Gets or sets the count of rows for virtual data.

    • getDataBandInfoV1

      public final StiDataBandInfoV1 getDataBandInfoV1()

    • getDataBandInfoV2

      public final StiDataBandInfoV2 getDataBandInfoV2()

    • getDataRelation

      public StiDataRelation getDataRelation()
      Get link that is used for master-detail reports rendering.
      Specified by:
      getDataRelation in interface IStiDataRelation

    • existDataRelation

      public boolean existDataRelation()
      Specified by:
      existDataRelation in interface IStiDataRelation

    • getDataRelationName

      public final String getDataRelationName()
      Gets or sets relation name.
      Specified by:
      getDataRelationName in interface IStiDataRelation

    • getDataSource

      public StiDataSource getDataSource()
      Get data source that is used for getting data.
      Specified by:
      getDataSource in interface IStiDataSource

    • getDataSourceName

      public final String getDataSourceName()
      Gets or sets name of the Data Source.
      Specified by:
      getDataSourceName in interface IStiDataSource

    • getEndRenderEvent

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

    • getEvenStyle

      public String getEvenStyle()
      Gets or sets value, indicates style of even lines.
      Specified by:
      getEvenStyle in interface IStiOddEvenStyles

    • getEvents

      public StiEventsCollection getEvents()
      Return events collection of this component.
      Overrides:
      getEvents in class StiComponent

    • getFilterEngine

      public int getFilterEngine()
      Gets or sets how a filter will be applied to data - be means of the report generator or by means of changing the SQL query.

    • getFilterMethodHandler

      public final StiFilterEventHandler getFilterMethodHandler()
      Gets or sets a method for filtration.
      Specified by:
      getFilterMethodHandler in interface IStiFilter

    • getFilterMode

      public StiFilterMode getFilterMode()
      Gets or sets filter mode.
      Specified by:
      getFilterMode in interface IStiFilter

    • getFilterOn

      public boolean getFilterOn()
      Gets or sets value indicates, that filter is turn on.
      Specified by:
      getFilterOn in interface IStiFilter

    • getFilters

      public StiFiltersCollection getFilters()
      Gets or sets the collection of data filters.
      Specified by:
      getFilters in interface IStiFilter

    • getGetCollapsedEvent

      public final StiGetCollapsedEvent getGetCollapsedEvent()
      Occurs when the Collapsed value is calculated.

    • getHeaderEndColor

      public StiColor getHeaderEndColor()
      Gets header end color.
      Specified by:
      getHeaderEndColor in class StiBand

    • getHeaderStartColor

      public StiColor getHeaderStartColor()
      Gets header start color.
      Specified by:
      getHeaderStartColor in class StiBand

    • GetHeaderText

      public String GetHeaderText()
      Returns the band header text.
      Overrides:
      GetHeaderText in class StiBand
      Returns:
      Band header text.

    • getIsBof

      public boolean getIsBof()
      Gets value, indicates that the position indicates to the beginning of data.
      Specified by:
      getIsBof in interface IStiEnumerator

    • getIsBusinessObjectEmpty

      public final boolean getIsBusinessObjectEmpty()
      Description copied from interface: IStiBusinessObject
      Returns true if Business Object property is not assigned.
      Specified by:
      getIsBusinessObjectEmpty in interface IStiBusinessObject

    • getIsEmpty

      public boolean getIsEmpty()
      Gets value indicates that no data.
      Specified by:
      getIsEmpty in interface IStiEnumerator

    • getIsEof

      public boolean getIsEof()
      Gets value indicates that the position indicates to the end of data.
      Specified by:
      getIsEof in interface IStiEnumerator

    • getKeepChildTogether

      public boolean getKeepChildTogether()
      Gets or sets value indicates that childs are to be kept together.

    • getKeepDetailsTogether

      public boolean getKeepDetailsTogether()
      Gets or sets value indicates that details are to be kept together with this DataBand.
      Specified by:
      getKeepDetailsTogether in interface IStiKeepDetailsTogether

    • getKeepFooterTogether

      public boolean getKeepFooterTogether()
      Gets or sets value indicates that the footer is printed with data.
      Specified by:
      getKeepFooterTogether in interface IStiKeepFooterTogether

    • getKeepGroupTogether

      public boolean getKeepGroupTogether()
      Gets or sets value indicates that group is to be kept together.
      Specified by:
      getKeepGroupTogether in interface IStiKeepGroupTogether

    • getKeepHeaderTogether

      public boolean getKeepHeaderTogether()
      Gets or sets value indicates that header is printed with data together.
      Specified by:
      getKeepHeaderTogether in interface IStiKeepHeaderTogether

    • getLine

      public final int getLine()
      Gets the number of line from the beginning of the group formation.

    • getLineThrough

      public final int getLineThrough()
      Gets the number of line from the beginning of the report formation.

    • getLocalizedName

      public String getLocalizedName()
      Gets a localized component name.
      Overrides:
      getLocalizedName in class StiContainer

    • getPageLine

      public String getPageLine()

    • getMasterComponent

      public StiComponent getMasterComponent()
      Gets or sets the master-component.
      Specified by:
      getMasterComponent in interface IStiMasterComponent

    • getMinRowsInColumn

      public int getMinRowsInColumn()
      Gets or sets minimum count of the rows in one column.

    • getOddStyle

      public String getOddStyle()
      Gets or sets value, indicates style of odd lines.
      Specified by:
      getOddStyle in interface IStiOddEvenStyles

    • getPosition

      public int getPosition()
      Gets the current position.
      Specified by:
      getPosition in interface IStiEnumerator

    • getPrintIfDetailEmpty

      public boolean getPrintIfDetailEmpty()
      Gets or sets value indicates that if detail is empty then the master data must be printed anyway.
      Specified by:
      getPrintIfDetailEmpty in interface IStiPrintIfDetailEmpty

    • getPrintOnAllPages

      public boolean getPrintOnAllPages()
      Gets or sets value indicates that the component is printed on all pages.
      Specified by:
      getPrintOnAllPages in interface IStiPrintOnAllPages

    • getPriority

      public int getPriority()
      Gets a component priority.
      Overrides:
      getPriority in class StiContainer

    • getRenderingEvent

      public final StiRenderingEvent getRenderingEvent()
      Occurs when a data row rendering.

    • getResetDataSource

      public boolean getResetDataSource()
      Gets or sets value, indicates to reset Data Source postion to begin when preparation for rendering.

    • getResetPageNumber

      public boolean getResetPageNumber()
      Allows to reset page number on this component.
      Specified by:
      getResetPageNumber in interface IStiResetPageNumber
      Overrides:
      getResetPageNumber in class StiBand

    • getRightToLeft

      public boolean getRightToLeft()
      Gets or sets horizontal column direction.

    • getSort

      public ArrayList<String> getSort()
      Gets or sets the array of strings that describes rules of sorting.
      Specified by:
      getSort in interface IStiSort

    • getStartNewPage

      public boolean getStartNewPage()
      Gets or sets value indicates that it is necessary to print every new string on a new page.
      Specified by:
      getStartNewPage in interface IStiStartNewPage

    • getStartNewPageIfLessThan

      public float getStartNewPageIfLessThan()
      Gets or sets value which indicates how much free space on a page (in percentage terms) should be reserved for formation of a new page. The value should be set in the range from 0 to 100. If the value is 100 then, in any case, a new page will be formed. This property is used together with the StartNewPage property.
      Specified by:
      getStartNewPageIfLessThan in interface IStiStartNewPage

    • getToolboxPosition

      public int getToolboxPosition()
      Gets value to sort a position in the toolbox.
      Overrides:
      getToolboxPosition in class StiContainer

    • InvokeBeginRender

      public final void InvokeBeginRender()
      Raises the BeginRender event for this component.
      Overrides:
      InvokeBeginRender in class StiComponent

    • InvokeGroupRendering

      public final void InvokeGroupRendering()

    • InvokeRendering

      public final void InvokeRendering()
      Raises the Rendering event for this component.

    • InvokeEndRender

      public void InvokeEndRender()
      Overrides:
      InvokeEndRender in class StiComponent

    • isDataSourceEmpty

      public final boolean isDataSourceEmpty()
      Description copied from interface: IStiDataSource
      Returns true if DataSource property is not assigned.
      Specified by:
      isDataSourceEmpty in interface IStiDataSource

    • Last

      public void Last()
      Move on the last row.
      Specified by:
      Last in interface IStiEnumerator

    • Next

      public void Next()
      Move on the next row.
      Specified by:
      Next in interface IStiEnumerator

    • OnBeginRender

      protected void OnBeginRender(EventArgs e)
      Raises the BeginRender event for this component.

    • OnEndRender

      protected void OnEndRender(EventArgs e)
      Raises the EndRender event for this component.

    • OnGetCollapsed

      protected void OnGetCollapsed(StiValueEventArgs e)
      Raises the GetCollapsed event for this component.

    • OnRendering

      protected void OnRendering(EventArgs e)
      Raises the Rendering event for this component.

    • packService

      public void packService()
      Occurs when band rendering is finished.
      Overrides:
      packService in class StiComponent

    • Prior

      public void Prior()
      Move on the previous row.
      Specified by:
      Prior in interface IStiEnumerator

    • renderMaster

      public void renderMaster()
      Specified by:
      renderMaster in interface IStiRenderMaster

    • saveState

      public void saveState(String stateName)
      Saves the current state of an object.
      Specified by:
      saveState in interface IStiStateSaveRestore
      Overrides:
      saveState in class StiContainer
      Parameters:
      stateName - A name of the state being saved.

    • RestoreState

      public void RestoreState(String stateName)
      Restores the earlier saved object state.
      Overrides:
      RestoreState in class StiContainer
      Parameters:
      stateName - A name of the state being restored.

    • setBeginRenderEvent

      public final void setBeginRenderEvent(StiBeginRenderEvent value)
      Raises the GetCollapsed event for this component.

    • setBusinessObjectGuid

      public final void setBusinessObjectGuid(String value)
      Specified by:
      setBusinessObjectGuid in interface IStiBusinessObject

    • setCalcInvisible

      public void setCalcInvisible(boolean value)

    • setCollapsed

      public void setCollapsed(StiCollapsedExpression value)

    • setColumnDirection

      public void setColumnDirection(StiColumnDirection value)

    • setColumnGaps

      public void setColumnGaps(double value)

    • setColumns

      public void setColumns(int value)

    • setColumnWidth

      public void setColumnWidth(double value)

    • setCountData

      public void setCountData(int value)

    • setDataRelationName

      public final void setDataRelationName(String value)
      Specified by:
      setDataRelationName in interface IStiDataRelation

    • setDataSourceName

      public final void setDataSourceName(String value)
      Specified by:
      setDataSourceName in interface IStiDataSource

    • setEndRenderEvent

      public final void setEndRenderEvent(StiEndRenderEvent value)

    • setEvenStyle

      public void setEvenStyle(String value)
      Specified by:
      setEvenStyle in interface IStiOddEvenStyles

    • setFilterEngine

      public void setFilterEngine(int value)

    • setFilterMethodHandler

      public final void setFilterMethodHandler(StiFilterEventHandler value)
      Specified by:
      setFilterMethodHandler in interface IStiFilter

    • setFilterMode

      public void setFilterMode(StiFilterMode value)
      Specified by:
      setFilterMode in interface IStiFilter

    • setFilterOn

      public void setFilterOn(boolean value)
      Specified by:
      setFilterOn in interface IStiFilter

    • setFilters

      public void setFilters(StiFiltersCollection value)
      Specified by:
      setFilters in interface IStiFilter

    • setGetCollapsedEvent

      public final void setGetCollapsedEvent(StiGetCollapsedEvent value)

    • setIsBof

      public void setIsBof(boolean value)
      Specified by:
      setIsBof in interface IStiEnumerator

    • setIsEof

      public void setIsEof(boolean value)
      Specified by:
      setIsEof in interface IStiEnumerator

    • setKeepChildTogether

      public void setKeepChildTogether(boolean value)

    • setKeepDetailsTogether

      public void setKeepDetailsTogether(boolean value)
      Specified by:
      setKeepDetailsTogether in interface IStiKeepDetailsTogether

    • setKeepFooterTogether

      public void setKeepFooterTogether(boolean value)
      Specified by:
      setKeepFooterTogether in interface IStiKeepFooterTogether

    • setKeepGroupTogether

      public void setKeepGroupTogether(boolean value)
      Specified by:
      setKeepGroupTogether in interface IStiKeepGroupTogether

    • setKeepHeaderTogether

      public void setKeepHeaderTogether(boolean value)
      Specified by:
      setKeepHeaderTogether in interface IStiKeepHeaderTogether

    • setLine

      public final void setLine(int value)

    • setLineThrough

      public final void setLineThrough(int value)

    • setMasterComponent

      public void setMasterComponent(StiComponent value)
      Specified by:
      setMasterComponent in interface IStiMasterComponent

    • setMinRowsInColumn

      public void setMinRowsInColumn(int value)

    • setOddStyle

      public void setOddStyle(String value)
      Specified by:
      setOddStyle in interface IStiOddEvenStyles

    • setPosition

      public void setPosition(int value)
      Specified by:
      setPosition in interface IStiEnumerator

    • setPrintIfDetailEmpty

      public void setPrintIfDetailEmpty(boolean value)
      Specified by:
      setPrintIfDetailEmpty in interface IStiPrintIfDetailEmpty

    • setPrintOnAllPages

      public void setPrintOnAllPages(boolean value)
      Specified by:
      setPrintOnAllPages in interface IStiPrintOnAllPages

    • setRenderingEvent

      public final void setRenderingEvent(StiRenderingEvent value)

    • setResetDataSource

      public void setResetDataSource(boolean value)

    • setResetPageNumber

      public void setResetPageNumber(boolean value)
      Specified by:
      setResetPageNumber in interface IStiResetPageNumber
      Overrides:
      setResetPageNumber in class StiBand

    • setRightToLeft

      public void setRightToLeft(boolean value)

    • setSort

      public void setSort(ArrayList<String> value)
      Specified by:
      setSort in interface IStiSort

    • setStartNewPage

      public void setStartNewPage(boolean value)
      Specified by:
      setStartNewPage in interface IStiStartNewPage

    • setStartNewPageIfLessThan

      public void setStartNewPageIfLessThan(float value)
      Specified by:
      setStartNewPageIfLessThan in interface IStiStartNewPage

    • getComponentPlacementForChildren

      public String getComponentPlacementForChildren()
      Overrides:
      getComponentPlacementForChildren in class StiContainer

    • InvokeGetCollapsed

      public void InvokeGetCollapsed(StiValueEventArgs e)

    • getSelectedLine

      public int getSelectedLine()

    • setSelectedLine

      public void setSelectedLine(int selectedLine)

    • setKeepDetails

      public void setKeepDetails(StiKeepDetails keepDetails)

    • getKeepDetails

      public StiKeepDetails getKeepDetails()

    • clone

      public Object clone(boolean cloneProperties, boolean cloneComponents)
      Creates a new object that is a copy of the current instance.
      Overrides:
      clone in class StiBand
      Returns:
      A new object that is a copy of this instance.

    • SaveToJsonObject

      public JSONObject SaveToJsonObject(StiJsonSaveMode mode) throws JSONException
      Specified by:
      SaveToJsonObject in interface IStiJsonReportObject
      Overrides:
      SaveToJsonObject in class StiDynamicBand
      Throws:
      JSONException

    • LoadFromJsonObject

      public void LoadFromJsonObject(JSONObject jObject) throws JSONException
      Specified by:
      LoadFromJsonObject in interface IStiJsonReportObject
      Overrides:
      LoadFromJsonObject in class StiDynamicBand
      Throws:
      JSONException