Package com.stimulsoft.report.dialogs

Class StiGridControl

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.dialogs.StiReportControl
com.stimulsoft.report.dialogs.StiGridControl
All Implemented Interfaces:
IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiDataSource, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportControl, IStiEnumerator, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable
public class StiGridControl extends StiReportControl implements IStiDataSource, IStiEnumerator
Displays datasource in a scrollable grid.

  • Field Details

    • isEofValue

      public boolean isEofValue

    • isBofValue

      public boolean isBofValue

  • Constructor Details

    • StiGridControl

      public StiGridControl()
      Creates a new StiGridControl.

    • StiGridControl

      public StiGridControl(StiRectangle rect)
      Creates a new StiGridControl.
      Parameters:
      rect - The rectangle describes sizes and position of the control.

  • Method Details

    • getToolboxPosition

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

    • getLocalizedName

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

    • getForeColor

      public StiColor getForeColor()
      Gets or sets the foreground color (typically the color of the text) property.
      Overrides:
      getForeColor in class StiReportControl

    • setForeColor

      public void setForeColor(StiColor value)
      Overrides:
      setForeColor in class StiReportControl

    • getBackColor

      public StiColor getBackColor()
      Gets or sets the background color of the grid.
      Overrides:
      getBackColor in class StiReportControl

    • setBackColor

      public void setBackColor(StiColor value)
      Overrides:
      setBackColor in class StiReportControl

    • getAlternatingBackColor

      public StiColor getAlternatingBackColor()
      Gets or sets the background color of alternating rows for a ledger appearance.

    • setAlternatingBackColor

      public void setAlternatingBackColor(StiColor value)

    • getBackgroundColor

      public StiColor getBackgroundColor()
      Gets or sets the color of the non-row area of the grid.

    • setBackgroundColor

      public void setBackgroundColor(StiColor value)

    • getGridLineColor

      public StiColor getGridLineColor()
      Gets or sets the color of the grid lines.

    • setGridLineColor

      public void setGridLineColor(StiColor value)

    • getHeaderBackColor

      public StiColor getHeaderBackColor()
      Gets or sets the background color of all row and column headers.

    • setHeaderBackColor

      public void setHeaderBackColor(StiColor value)

    • getHeaderForeColor

      public StiColor getHeaderForeColor()
      Gets or sets the foreground color of headers.

    • setHeaderForeColor

      public void setHeaderForeColor(StiColor value)

    • getSelectionBackColor

      public StiColor getSelectionBackColor()
      Gets or sets the background color of selected rows.

    • setSelectionBackColor

      public void setSelectionBackColor(StiColor value)

    • getSelectionForeColor

      public StiColor getSelectionForeColor()
      Gets or set the foreground color of selected rows.

    • setSelectionForeColor

      public void setSelectionForeColor(StiColor value)

    • getFilter

      public String getFilter()
      Gets or sets filter string.

    • setFilter

      public void setFilter(String value)

    • getHeaderFont

      public StiFont getHeaderFont()
      Gets or sets the font used for column headers.

    • setHeaderFont

      public void setHeaderFont(StiFont value)

    • getColumnHeadersVisible

      public boolean getColumnHeadersVisible()
      Gets or sets a value indicating whether the column headers a table are visible.

    • setColumnHeadersVisible

      public void setColumnHeadersVisible(boolean value)

    • getRowHeadersVisible

      public boolean getRowHeadersVisible()
      Gets or sets a value that specifies whether row headers are visible.

    • setRowHeadersVisible

      public void setRowHeadersVisible(boolean value)

    • getGridLineStyle

      public StiDataGridLineStyle getGridLineStyle()
      Gets or sets the line style of the grid.

    • setGridLineStyle

      public void setGridLineStyle(StiDataGridLineStyle value)

    • getPreferredColumnWidth

      public int getPreferredColumnWidth()
      Gets or sets the default width of the grid columns in pixels.

    • setPreferredColumnWidth

      public void setPreferredColumnWidth(int value)

    • getPreferredRowHeight

      public int getPreferredRowHeight()
      Gets or sets the preferred row height.

    • setPreferredRowHeight

      public void setPreferredRowHeight(int value)

    • getRowHeaderWidth

      public int getRowHeaderWidth()
      Gets or sets the width of row headers.

    • setRowHeaderWidth

      public void setRowHeaderWidth(int value)

    • getColumns

      public StiGridColumnsCollection getColumns()
      Gets or sets the column collection.

    • setColumns

      public void setColumns(StiGridColumnsCollection value)

    • MoveNext

      public void MoveNext()
      Moves to the next row.

    • First

      public void First()
      Moves to first row.
      Specified by:
      First in interface IStiEnumerator

    • Prior

      public void Prior()
      Moves to prior row.
      Specified by:
      Prior in interface IStiEnumerator

    • Next

      public void Next()
      Moves to next row.
      Specified by:
      Next in interface IStiEnumerator

    • Last

      public void Last()
      Moves to last row.
      Specified by:
      Last in interface IStiEnumerator

    • getIsEof

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

    • setIsEof

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

    • getIsBof

      public boolean getIsBof()
      Gets value indicates that position points to begin data.
      Specified by:
      getIsBof in interface IStiEnumerator

    • setIsBof

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

    • getIsEmpty

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

    • getDataSource

      public StiDataSource getDataSource()
      Gets data source.
      Specified by:
      getDataSource in interface IStiDataSource

    • getDataSourceName

      public final String getDataSourceName()
      Gets or sets name of 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()

    • getPositionChangedEvent

      public StiPositionChangedEvent getPositionChangedEvent()
      Gets or sets a script of the event PositionChanged.

    • setPositionChangedEvent

      public void setPositionChangedEvent(StiPositionChangedEvent value)

    • getDefaultClientRectangle

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

    • getPosition

      public int getPosition()
      Description copied from interface: IStiEnumerator
      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()
      Description copied from interface: IStiEnumerator
      Gets count of elements.
      Specified by:
      getCount in interface IStiEnumerator

    • isDataSourceEmpty

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

    • SaveToJsonObject

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

    • LoadFromJsonObject

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