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, java.lang.Cloneable

public class StiGridControl
extends StiReportControl
implements IStiDataSource, IStiEnumerator

Displays datasource in a scrollable grid.

Field Summary

boolean	isBofValue
boolean	isEofValue

Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

border, brush, collapsingIndex, components, ParentComponentIsBand, ParentComponentIsCrossBand

Fields inherited from class com.stimulsoft.report.components.StiComponent

canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

StiGridControl()
Creates a new StiGridControl.

StiGridControl(StiRectangle rect)
Creates a new StiGridControl.

Method Summary

void	First() Moves to first row.
StiColor	getAlternatingBackColor() Gets or sets the background color of alternating rows for a ledger appearance.
StiColor	getBackColor() Gets or sets the background color of the grid.
StiColor	getBackgroundColor() Gets or sets the color of the non-row area of the grid.
boolean	getColumnHeadersVisible() Gets or sets a value indicating whether the column headers a table are visible.
StiGridColumnsCollection	getColumns() Gets or sets the column collection.
int	getCount() Gets count of elements.
StiDataSource	getDataSource() Gets data source.
java.lang.String	getDataSourceName() Gets or sets name of data source.
StiRectangle	getDefaultClientRectangle() Gets or sets the default client area of a component.
java.lang.String	getFilter() Gets or sets filter string.
StiColor	getForeColor() Gets or sets the foreground color (typically the color of the text) property.
StiColor	getGridLineColor() Gets or sets the color of the grid lines.
StiDataGridLineStyle	getGridLineStyle() Gets or sets the line style of the grid.
StiColor	getHeaderBackColor() Gets or sets the background color of all row and column headers.
StiFont	getHeaderFont() Gets or sets the font used for column headers.
StiColor	getHeaderForeColor() Gets or sets the foreground color of headers.
boolean	getIsBof() Gets value indicates that position points to begin data.
boolean	getIsDataSourceEmpty()
boolean	getIsEmpty() Gets value indicates that no data.
boolean	getIsEof() Gets value indicates that position points to end data.
java.lang.String	getLocalizedName() Gets a localized component name.
int	getPosition() Gets the current position.
StiPositionChangedEvent	getPositionChangedEvent() Gets or sets a script of the event PositionChanged.
int	getPreferredColumnWidth() Gets or sets the default width of the grid columns in pixels.
int	getPreferredRowHeight() Gets or sets the preferred row height.
boolean	getRowHeadersVisible() Gets or sets a value that specifies whether row headers are visible.
int	getRowHeaderWidth() Gets or sets the width of row headers.
StiColor	getSelectionBackColor() Gets or sets the background color of selected rows.
StiColor	getSelectionForeColor() Gets or set the foreground color of selected rows.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
boolean	isDataSourceEmpty() Returns true if DataSource property is not assigned.
void	Last() Moves to last row.
void	LoadFromJsonObject(JSONObject jObject)
void	MoveNext() Moves to the next row.
void	Next() Moves to next row.
void	Prior() Moves to prior row.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAlternatingBackColor(StiColor value)
void	setBackColor(StiColor value)
void	setBackgroundColor(StiColor value)
void	setColumnHeadersVisible(boolean value)
void	setColumns(StiGridColumnsCollection value)
void	setDataSourceName(java.lang.String value)
void	setFilter(java.lang.String value)
void	setForeColor(StiColor value)
void	setGridLineColor(StiColor value)
void	setGridLineStyle(StiDataGridLineStyle value)
void	setHeaderBackColor(StiColor value)
void	setHeaderFont(StiFont value)
void	setHeaderForeColor(StiColor value)
void	setIsBof(boolean value)
void	setIsEof(boolean value)
void	setPosition(int value)
void	setPositionChangedEvent(StiPositionChangedEvent value)
void	setPreferredColumnWidth(int value)
void	setPreferredRowHeight(int value)
void	setRowHeadersVisible(boolean value)
void	setRowHeaderWidth(int value)
void	setSelectionBackColor(StiColor value)
void	setSelectionForeColor(StiColor value)

Methods inherited from class com.stimulsoft.report.dialogs.StiReportControl

canContainIn, clone, convert, getAfterPrintEvent, getBeforePrintEvent, getBookmark, getBorder, getBrush, getCanGrow, getCanShrink, getClickEvent, getComponentStyle, getConditions, getControlWpf, GetDefaultEvent, getDockStyle, getDoubleClickEvent, getEnabled, getEnterEvent, getEvents, getFont, getgetBookmarkEvent, getgetDrillDownReportEvent, getgetHyperlinkEvent, getgetTagEvent, getgetToolTipEvent, getGrowToHeight, getHeight, getHyperlink, getInteraction, getIsReportContainer, getLeaveEvent, getLeft, getLocalizedCategory, getLocation, getMaxSize, getMinSize, getMouseDownEvent, getMouseEnterEvent, getMouseLeaveEvent, getMouseMoveEvent, getMouseUpEvent, getPrintable, getPrintOn, getServiceCategory, getShiftMode, getSize, getTag, getTagValueBinding, getToolTip, getTop, getUseParentStyles, getVisible, getWidth, InvokeEnter, InvokeLeave, InvokeMouseDown, InvokeMouseMove, InvokeMouseUp, packService, setAfterPrintEvent, setBeforePrintEvent, setBookmark, setBorder, setBrush, setCanGrow, setCanShrink, setClickEvent, setComponentStyle, setConditions, setControlWpf, setDockStyle, setDoubleClickEvent, setEnabled, setEnterEvent, setFont, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGrowToHeight, setHeight, setHyperlink, setInteraction, setLeaveEvent, setLeft, setLocation, setMaxSize, setMinSize, setMouseDownEvent, setMouseEnterEvent, setMouseLeaveEvent, setMouseMoveEvent, setMouseUpEvent, setPrintable, setPrintOn, setShiftMode, setSize, setTag, setTagValueBinding, setToolTip, setTop, setUseParentStyles, setVisible, setWidth

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkLargeHeight, ClearAllStates, clone, clone, ContainerToPage, ContainerToPage, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, GetBorder, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponentPlacementForChildren, getComponents, GetComponents, GetComponentsCount, GetComponentsList, getComponentsSelectedRectangle, getComponentType, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getGuid, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, GetMaxSize, getName, getPriority, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, getTagValue, GetTextBrush, GetTextFormat, GetTextHorAlignment, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, PageToContainer, PageToContainer, RemoveAllSelected, ResetSelection, RestoreState, saveState, SelectAll, SelectComponent, SelectInRectangle, SelectInRectangleCheckBands, SendToBack, setBlocked, SetBorder, SetBrush, setCanBreak, SetCenterHorizontally, SetCenterVertically, setCollapsedValue, setCollapsingIndex, setCollapsingTreePath, setComponents, setComponentsFont, setComponentsFont, setComponentsWithSetParent, setComponentsWordWrap, SetConditions, setContainerInfoV2, SetDockStyle, setForceSerializeToReport, SetHorAlign, SetLink, setParentComponentIsBand, setParentComponentIsCrossBand, SetParentStylesToChilds, SetParentStylesToChilds, SetTextBrush, SetTextFormat, SetTextHorAlign, SetVertAlign, ShrinkFont, SortByPriority

Methods inherited from class com.stimulsoft.report.components.StiComponent

addSize, applyConditions, CheckForParentComponent, clearAllStates, ClearContents, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, fillComponentPlacement, getAlias, getAllowDelete, getAnchor, getBookmarkValue, getBottom, getComponentPlacement, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDrillDownParameters, getExpressions, getForceRedrawAll, getGroupHeaderBand, GetGroupHeaderBand, getHighlightState, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getLinked, getLocked, getMeasureGraphics, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceType, getShift, getShowQuickButtons, getTagStrValue, getToolTipValue, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, isExportAsImage, IsParentSelect, NewGuid, OnRemoveComponent, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAlias, setAnchor, setBookmarkValue, setClientRectangle, setComponentPlacement, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDrillDownParameters, setExpressions, setGuid, setHeightProp, setHighlightState, setHyperlinkValue, setIgnoreNamingRule, setInherited, setIsRendered, setIsSelected, setLeftProp, setLinked, setLocked, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTagValue, setToolTipValue, setTopProp, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Field Detail

isEofValue

public boolean isEofValue

isBofValue

public boolean isBofValue

Constructor Detail

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 Detail

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiReportControl

getLocalizedName

public java.lang.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 java.lang.String getFilter()

Gets or sets filter string.

setFilter

public void setFilter(java.lang.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 java.lang.String getDataSourceName()

Gets or sets name of data source.

Specified by:

getDataSourceName in interface IStiDataSource

setDataSourceName

public final void setDataSourceName(java.lang.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