Package com.stimulsoft.report.crossTab

Class StiCrossTab

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.crossTab.StiCrossTab
All Implemented Interfaces:
IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiBusinessObject, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiCrossTab, IStiDataRelation, IStiDataSource, IStiFilter, IStiGrowToHeight, IStiInteraction, IStiPrintIfEmpty, IStiPrintOn, IStiSelect, IStiShift, IStiSort, IStiUnitConvert, IStiEnumerator, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable
public class StiCrossTab extends StiContainer implements IStiDataSource, IStiFilter, IStiCrossTab, IStiSort, IStiDataRelation, IStiPrintIfEmpty, IStiBusinessObject
Describes the class that realizes a StiCrossTab.

  • Field Details

    • crossTabInfo

      public final StiCrossTabInfo crossTabInfo

    • keepCrossTabTogether

      public boolean keepCrossTabTogether

  • Constructor Details

    • StiCrossTab

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

    • StiCrossTab

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

  • Method Details

    • isDataSourceEmpty

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

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

    • getPrintIfEmpty

      public boolean getPrintIfEmpty()
      Gets or sets value indicates that the cross-tab is printed if data is not present.
      Specified by:
      getPrintIfEmpty in interface IStiPrintIfEmpty

    • setPrintIfEmpty

      public void setPrintIfEmpty(boolean value)
      Specified by:
      setPrintIfEmpty in interface IStiPrintIfEmpty

    • getCanGrow

      public boolean getCanGrow()
      Gets or sets value indicates that this object can grow.
      Specified by:
      getCanGrow in interface IStiCanGrow
      Overrides:
      getCanGrow in class StiComponent

    • setCanGrow

      public void setCanGrow(boolean value)
      Specified by:
      setCanGrow in interface IStiCanGrow
      Overrides:
      setCanGrow in class StiComponent

    • 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

    • setDataRelationName

      public final void setDataRelationName(String value)
      Specified by:
      setDataRelationName 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

    • setDataSourceName

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

    • getIsDataSourceEmpty

      public final boolean getIsDataSourceEmpty()

    • 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

    • 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

    • setBusinessObjectGuid

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

    • getSort

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

    • setSort

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

    • First

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

    • Prior

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

    • Next

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

    • Last

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

    • getIsEof

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

    • setIsEof

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

    • getIsBof

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

    • setIsBof

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

    • getIsEmpty

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

    • getPosition

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

    • setPosition

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

    • getCount

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

    • clone

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

    • packService

      public void packService()
      Description copied from class: StiComponent
      Packs a service.
      Overrides:
      packService in class StiComponent

    • getCrossTabInfo

      public final StiCrossTabInfo getCrossTabInfo()

    • getCrossTabInfoV1

      public final StiCrossTabInfoV1 getCrossTabInfoV1()

    • getFilterEngine

      public final StiFilterEngine 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.

    • setFilterEngine

      public final void setFilterEngine(StiFilterEngine value)

    • getFilterMode

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

    • setFilterMode

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

    • getFilterMethodHandler

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

    • setFilterMethodHandler

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

    • getFilters

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

    • setFilters

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

    • getFilterOn

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

    • setFilterOn

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

    • canContainIn

      public boolean canContainIn(StiComponent component)
      May this container be located in the specified component.
      Overrides:
      canContainIn in class StiComponent
      Parameters:
      component - Component for checking.
      Returns:
      true, if this container may is located in the specified component.

    • getLocalizedCategory

      public String getLocalizedCategory()
      Description copied from class: StiContainer
      Gets a localized name of the component category.
      Overrides:
      getLocalizedCategory in class StiContainer

    • getToolboxPosition

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

    • getPriority

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

    • getDefaultClientRectangle

      public StiRectangle getDefaultClientRectangle()
      Gets or sets the default client area of a component.
      Overrides:
      getDefaultClientRectangle in class StiContainer

    • getComponentType

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

    • getLocalizedName

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

    • getCrossTabStyleIndex

      public final int getCrossTabStyleIndex()

    • setCrossTabStyleIndex

      public final void setCrossTabStyleIndex(int value)

    • getCrossTabStyleColor

      public final Object getCrossTabStyleColor()

    • setCrossTabStyleColor

      public final void setCrossTabStyleColor(Object value)

    • getCrossTabStyle

      public final String getCrossTabStyle()

    • setCrossTabStyle

      public final void setCrossTabStyle(String value)

    • getComponentStyle

      public String getComponentStyle()
      Description copied from class: StiComponent
      gets or sets a style of a component.
      Overrides:
      getComponentStyle in class StiContainer

    • setComponentStyle

      public void setComponentStyle(String value)
      Overrides:
      setComponentStyle in class StiComponent

    • UpdateStyles

      public final void UpdateStyles()

    • GetCellColor

      public final StiColor GetCellColor()

    • ApplyFieldStyle

      public final void ApplyFieldStyle(StiCrossField field)

    • getHorAlignment

      public final StiCrossHorAlignment getHorAlignment()
      Gets or sets the horizontal alignment of an Cross-Tab.

    • setHorAlignment

      public final void setHorAlignment(StiCrossHorAlignment value)

    • getPrintTitleOnAllPages

      public final boolean getPrintTitleOnAllPages()

    • setPrintTitleOnAllPages

      public final void setPrintTitleOnAllPages(boolean value)

    • getSummaryDirection

      public final StiSummaryDirection getSummaryDirection()

    • setSummaryDirection

      public final void setSummaryDirection(StiSummaryDirection value)

    • getKeepCrossTabTogether

      public boolean getKeepCrossTabTogether()
      Gets or sets value which indicates that the CrossTab must to be kept together with DataBand on what it is placed.

    • setKeepCrossTabTogether

      public void setKeepCrossTabTogether(boolean value)

    • getEmptyValue

      public final String getEmptyValue()
      Gets or sets string value which is used to show the cross-tab in empty cells.

    • setEmptyValue

      public final void setEmptyValue(String value)

    • getWrap

      public final boolean getWrap()
      Gets or sets value which indicates that the cross-tab is to be output in one column. At the same time, everything that do not fit by the width is output below. For using this property it is necessary to enable the CanBreak property of the band on which the cross-tab is placed (if it is placed on the band).

    • setWrap

      public final void setWrap(boolean value)

    • getWrapGap

      public final double getWrapGap()
      Gets or sets space between two parts of a wrapped cross-tab. The property is used jointly with the property Wrap.

    • setWrapGap

      public final void setWrapGap(double value)

    • getRightToLeft

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

    • setRightToLeft

      public void setRightToLeft(boolean value)

    • SaveToJsonObject

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

    • LoadFromJsonObject

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