import ReactDataGrid from 'flexicious-react-datagrid/js/table/ReactDataGrid.js'

public class | source

ReactDataGrid

Extends:

react~React.Component → EventDispatcher → UIComponent → NdgBase → FlexDataGrid → ReactDataGrid

The ReactDataGrid class is the main component intended to be consumed by application developers to embed the Flexicious React DataGrid component in their React Apps. It ultimately inherits from React.Component base class. The immediate super class of this class is the FlexDataGrid class, which contains most of the grid API.

In order to make the Flexicious React DataGrid (base class of this class) build purely from JSX markup, This class provides a hook into JSX parsing (making its children not visual DOM children, but actually just configuration)

This class will also be the actual DOM node that renders the REACT datagrid - it will contain all the scrolling containers (pager, header, filter, body and footer) - which in turn will contain instances of ReactDataGridCellContainer classes which will in turn contain the actual renderers (div's)

The children of this class in markup will be ReactDataGridColumn or ReactDataGridColumnGroup or ReactDataGridColumnLevel classes. They are config classes, and are ignored for rendering purposes - their only use is to pass the configuration of the grid into the base class for this class (FlexDataGrid)

For a complete list of properties and methods, please refer to the following classes: FlexDataGrid (base class of this class, which eventually inherits from React.Component) FlexDataGridColumnLevel (Please read the Introduction section of the user guide to understand what a level means) FlexDataGridColumnGroup (For grouped columns) FlexDataGridColumn (The actual column object within the grid) .

For a list of examples, review http://reactdatagrid.com/demo/ - Each example has a "Source Code" section where you can review sample configurations. Typical markup looks like:

See:

Example:

<ReactDataGrid dataProvider={this.state.dataProvider} width={"100%"} height={300} ... [See {FlexDataGrid} class for full list of properties]>
     <ReactDataGridColumnLevel [See { FlexDataGridColumnLevel} for full list of properties - note that this is not required, you can directly 
                                     list { ReactDataGridColumn} nodes here, a level is only needed for hierarchical grids where each level
                                     of hierarchy may potentially have different sets of columns.]> 
           <ReactDataGridColumnGroup ... [See { FlexDataGridColumnGroup} class for full list of properties]>
                <ReactDataGridColumn  ... [See { FlexDataGridColumn} class for full list of properties]/>
                <ReactDataGridColumn  ... [See { FlexDataGridColumn} class for full list of properties]/>
                <ReactDataGridColumn  ... [See { FlexDataGridColumn} class for full list of properties]/>
                <ReactDataGridColumn  ... [See { FlexDataGridColumn} class for full list of properties]/>
           </ReactDataGridColumnGroup>
     </ReactDataGridColumnLevel>
</ReactDataGrid>

Complete Example:

     <ReactDataGrid  width={"100%"} ref={(grid) => { this.grid = grid; }} enablePrint enablePreferencePersistence enableExport enableCopy enableFilters enableFooters initialSortField="title" preferencePersistenceKey="variableRowHeight" initialSortAscending forcePagerRow variableRowHeight
         horizontalScrollPolicy="off">
           <ReactDataGridColumn dataField="id" headerText="ID" filterControl="TextInput" filterOperation="Contains" columnWidthMode="fitToContent" />
           <ReactDataGridColumn dataField="title" headerText="Title" filterControl="TextInput" columnWidthMode="fitToContent" footerLabel="Count:" footerOperation="count" footerAlign="center" filterOperation="Contains" />
           <ReactDataGridColumn dataField="description" headerText="Description" wordWrap />
           <ReactDataGridColumn dataField="genre" headerText="Genre" filterControl="MultiSelectComboBox" filterComboBoxBuildFromGrid columnWidthMode="fitToContent" />
           <ReactDataGridColumn dataField="price" headerText="Price" filterControl="NumericRangeBox" columnWidthMode="fixed" width="100" footerLabel="Avg:" footerOperation="average" footerAlign="center" footerOperationPrecision={2} footerFormatter={flexiciousNmsp.CurrencyFormatter} labelFunction={UIUtils.dataGridFormatCurrencyLabelFunction} />
             <ReactDataGridColumn dataField="publish_date" headerText="Publish Date" filterControl="DateComboBox" columnWidthMode="fitToContent" filterConverterFunction={this.convertDate} labelFunction={this.dataGridFormatDateLabelFunction} />
     </ReactDataGrid>
Here is a video that demonstrates how to quickly get up and running with the React DataGrid:

Constructor Summary

Public Constructor
public	constructor(props: , arg1: , arg2: *)

Method Summary

Public Methods
public	getAllChildren(): *
public	getClassNames(): string[]

Inherited Summary

From class EventDispatcher
public	[prop]: *
public	dead: boolean
public	eventListeners: Array A list of event listeners for this event dispatcher object.
public	typeCache: {}
public	addEventListener(context: , type: , listener: *) Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
public	constructed()
public	dispatchEvent(event: *): boolean Dispatches an event into the event flow.
public	getClassNames(): string[]
public	getStyle(prop: ): Gets the value of the prop property on this object
public	hasEventListener(type: *): Boolean Returns true if an event listener exists
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.
public	kill() Removes all event listeners
public	killArray(arr: *) Given an array of event dispatchers, calls the kill method on each of them.
public	removeEventListener(type: , listener: ) Removes a listener from the EventDispatcher object.
public	setStyle(prop: , val: ) Sets the value of the prop property on this object

From class UIComponent
public static	clearPendingUpdates()
public static	flushPendingUpdates()
public	childIndex: number
public	children: *[]
public	childrenWithProps: *[]
public	data: * This is a getter/setter for the data property.
public	domElement: HTMLElement The dom element associated with this UIComponent.
public	domListeners: Array A list of event listeners that are added to the domElement (these create html dom event listeners as opposed to js only event listeners)
public	enabled: boolean Whether or not this control is enabled.
public	errorString: *
public	handCursor: *
public	height: number
public	horizontalScrollPolicy: *
public	includeInLayout: boolean
public	initialized: boolean
public	innerHTML: string
public	invalid: Boolean A flag to store if this object has been marked for invalidation.
public	oldDisplay: *
public	parent: *
public	propertyBag: {}
public	props: *
public	reactElement: ReactElement The react element associated with this UIComponent.
public	state: *
public	tagName: *
public	toolTip: *
public	verticalScrollPolicy: *
public	visible: boolean Whether or not this control is enabled.
public	width: number
public	x: *
public	y: *
public	addChild(child: *) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addChildAt(child: , idx: ) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addDomEventListener(evt: , f: ) When you call addEventListener on a UIComponent, certain events, defined by the domEvents array are also associated with the corresponding domElement.
public	addEventListener(context: , type: , listener: *) Calls super.addEventListener, and for dom based events, also adds a HTML Event listener
public	attachClass(newClass: *)
public	componentDidMount()
public	componentWillMount()
public	componentWillReceiveProps(nextProps: *)
public	componentWillUnmount()
public	componentWillUpdate()
public	detachClass(newClass: *)
public	domEventFired(event: *) The event handler that gets triggered from the HTML DOM.
public	focus()
public	getAllChildren(): *
public	getAttribute(attr: ):
public	getAutomationName(): *
public	getChildAt(idx: ): Returns the child of the domElement at the specified index.
public	getClassNames(): string[]
public	getComponentStyleAttribute(attr: ):
public	getData(): * This is a getter/setter for the data property.
public	getElementByTagName(tag: ):
public	getEnabled(): * Sets the enabled flag
public	getErrorString(val: ):
public	getHandCursor(): *
public	getHandCursor(): *
public	getHeight(): *
public	getHorizontalScrollPolicy(): *
public	getHorizontalScrollPosition(): *
public	getIncludeInLayout(val: ):
public	getInnerHTML(): * Getter for the innerHTML property
public	getPixelHeight(): *
public	getStyleAttribute(attr: ):
public	getText(): * Getter for the text property
public	getVerticalScrollPolicy(): *
public	getVerticalScrollPosition(): *
public	getVisible(val: ): Sets the visible flag
public	getWidth(): *
public	getX(): * Gets the X co ordinate
public	getY(): * Gets the Y co ordinate
public	globalToLocal(ptIn: *): flexiciousNmsp.Point Converts the given global Point to local co-ordinates.
public	initFromProps(props: *)
public	initialize() Any initialization code is supposed to go in this method.
public	invalidateDisplayList() This method will queue the component so the display list will render it once the current frame of execution is over.
public	kill() First, calls super.kill(), which takes out all event listeners.
public	localToGlobal(ptIn: *): flexiciousNmsp.Point Converts the given local Point to global co-ordinates.
public	measureText(textToMeasure: ): {"width": } Returns the width of the given text.
public	mergeObjects(obj1: , obj2: ): *
public	move(x: , y: ) Sets the X and Y co ordinates of the current dom element
public	numChildren(): * Gets the number of children of the dom element associated with this UIComponent.
public	owns(elem: *): Boolean Recursively iterates through the parent hierarchy of the given element to check to see if the current node is in its parent hierarchy.
public	ownsPoint(pt: *): boolean
public	removeAllChildren(child: *)
public	removeChild(child: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeChildAt(idx: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeComponentAttribute(attr: *)
public	removeDomEventListener(evt: , f: ) Removes a previously attached DOM event listener.
public	removeEventListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	removeEventListenerKeepDomListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	render(): *
public	setActualSize(w: , h: )
public	setActualSizeFromDomElement()
public	setAttribute(attr: , val: )
public	setAutomationName(val: *)
public	setChildIndex(child: , index: ) Sets the visible flag
public	setComponentStyleAttribute(attr: , val: )
public	setData(val: *) This is important, because the grid looks for a "setData" method on the renderer.
public	setDomElement(elem: *) Sets the domElement of this UIComponent to the specified element, and creates a property on the dom element called component to this.
public	setEnabled(val: *) Sets the enabled flag
public	setErrorString(val: *)
public	setHandCursor(val: *)
public	setHeight(val: ):
public	setHorizontalScrollPolicy(policy: *)
public	setHorizontalScrollPosition(val: ):
public	setIncludeInLayout(val: *)
public	setInnerHTML(val: *) Setter for the innerHTML property
public	setState(newState: *)
public	setStateIfDomPresent(state: , db: )
public	setStateInternal(newState: *)
public	setStyleAttribute(attr: , val: )
public	setText(val: *) Setter for the text property
public	setToolTip(val: *)
public	setVerticalScrollPolicy(policy: *)
public	setVerticalScrollPosition(val: ):
public	setVisible(val: *) Sets the visible flag
public	setWidth(val: ):
public	setX(val: ): Sets the X co ordinate
public	setY(val: ): Sets the Y co ordinate
public	updateDisplayList(w: , h: ) Called as a part of render phase.
public	validateNow()
public	validateNowIfValid()

From class NdgBase
public	allowInteractivity: boolean
public	copyAllRowsMenuText: String Text for the Copy All Rows
public	copyCellMenuText: String Text for the Copy Cell Menu
public	copySelectedRowMenuText: String Text for the Copy Selected Row
public	defaultRowCount: number The default number of rows to display.
public	dragAvailableFunction: Function A function that determines whether drag should be initiated.
public	dragDropCompleteFunction: Function A function that gets executed when the drag drop operation is complete.
public	dropAcceptRejectFunction: Function A function that determines whether drop should be shown.
public	dropIndicator: *
public	enableDrag: boolean Flag that indicates whether or not to setup drag support.
public	enableDrillDown: boolean
public	enableDrop: *
public	enableLockedSectionSeparators: boolean
public	enableMultiColumnSort: boolean
public	enableToolbarActions: boolean
public	itemFilters: {}
public	keyboardListenersPaused: boolean For some operations, like shift tab and tab key up, purposely pause the Container keyboard listenters, so we do not overwrite the work of one keyboard handler by triggering another.
public	lockDisclosureCell: boolean
public	lockedSectionSeparatorDrawFunction: *
public	predefinedFilters: Array A collection of toolbar actions.
public	showSpinnerOnFilterPageSort: boolean
public	spinnerFactory: *
public	spinnerLabel: String
public	toolbarActionExecutedFunction: Function
public	toolbarActionValidFunction: Function
public	toolbarActions: Array A collection of toolbar actions.
public	traceValue: *
public	clearSelection()
public	createListData(text: , dataField: , i: ):
public	doInvalidate() Calls invalidateDisplayList()
public	dragDrop(event: *)
public	dragEnter(event: *)
public	drawDefaultSeparators()
public	getClassNames(): string[]
public	getDragEnabled(): boolean Flag that indicates whether or not to setup drag support.
public	getDragRowData(): * The row data that is currently being dragged
public	getDropEnabled(): * Flag that indicates whether or not to setup drop support.
public	getDropIndicator(): * The dropIndicator separator Sprite.
public	getEnableDrop(): boolean Flag that indicates whether or not to setup drop support.
public	getForceColumnsToFitVisibleArea(): boolean
public	getIsCellSelectionMode(): Boolean Returns true if selectionMode=MULTIPLE_ROWS or SINGLE_ROW
public	getIsRowSelectionMode(): Boolean Returns true if selectionMode=MULTIPLE_ROWS or SINGLE_ROW
public	getLeftLockedVerticalSeparator(): * The left locked vertical separator Sprite.
public	getRightLockedVerticalSeparator(): * The right locked vertical separator Sprite.
public	getSelectedCells(): * A list of `CellInfo` objects.
public	getSelectionMode(): * Selection mode for the grid.
public	getUIComponentBitmapData(target: ): Drag and Drop support, create a image representation of the row.
public	hasBorderSide(side: *): boolean Returns true if the grid defines the border style specified
public	invalidateCellWidths() Invalidates the cell widths, so in the next commit properties, we snap to the new column widths.
public	invalidateHeight() Invalidates the height, which in turn adjusts the various section based on the updated numbers, and recycles the renderers, so if there is more stuff on the viewport than is currently visible, it is drawn.
public	invalidateWidth() Invalidates the width, which in turn adjusts the various section based on the updated numbers, and recycles the renderers, so if there is more stuff on the viewport than is currently visible, it is drawn.
public	onCollectionChange(event: *)
public	onCreationComplete(event: *)
public	onGridMouseClick(event: *)
public	onGridResized(event: *) On grid resized, we reposition the cells.
public	reDraw() Redraws the grid, assuming the data provider is the same, we're just changing column widths or ordinals. There are four functions that you can use to redraw the grid, on basis of what your needs are. S rebuild : Most expensive. Rebuilds the entire grid. This is also the most expensive function reDraw : Removes the cells in view, and redraws them. Should be used when there are no additions/removals to the data provider refreshCells : Resets the text,enabled, styles and border/background etc. of the currently visible cells. See the refreshCells() function for details. invalidateCells : Least expensive. Only resets the border/background of the currently visible cells. rebuildBody : A light weight replacement for rebuild that only rebuids the body, not the header,footer,filter, and pager (which are generally more expensive to rebuild).
public	rebuild() Rebuild the entire grid.
public	refreshLayout() Calls rebuild internally.
public	resumeKeyboardListeners()
public	setActualSize(w: number, h: number)
public	setDragEnabled(enabled: boolean)
public	setDropEnabled(enabled: boolean)
public	setEnableDrop(enabled: boolean)
public	setHeight(val: number)
public	setSelectionMode(value: boolean)
public	setWidth(val: number)
public	showToaster(message: , toasterPosition: , toasterRenderer: , animationDuration: , visibleDuration: , moveAnimate: , fadeAnimate: *)
public	traceEvent(msg: String)
public	updateDisplayList(unscaledWidth: number, unscaledHeight: number)

From class FlexDataGrid
public	activeCellColor: uint [Style(name="activeCellColor", type="uint", format="Color", inherit="yes")] The color of the cell directly under the mouse or if using keyboard navigation, current keyboard seed.
public	allowMultipleRowDrag: Boolean Flag to enable dragging multiple rows.
public	alternatingItemColors: Number [Style(name="alternatingItemColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the backgrounds of the items in the grid.
public	alternatingTextColors: Array [Style(name="alternatingTextColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the text of the items in the grid.
public	autoLoadPreferences: Boolean By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference. This works well in most cases, but in some cases, where the data needed to build selection comboboxes (for filters) is built from the dataprovider, it makes sense to wait until the dataprovider is loaded to parse and set the preferences, otherwise the grid will end up ignoring saved preferences for filters that have dropdown based UI. In this case set autoLoadPreferences to true, and manually call loadPreferences when the data is received from the server and the dataprovider is set. grid:FlexDataGrid autoLoadPreferences=”false” And then, when you set the dataprovider: dgReport.dataProvider=dp; if(!dgReport.getPreferencesLoaded()){ dgReport.loadPreferences(); }
public	autoRefreshInterval: Number The number of milliseconds to wait before issuing an autorefresh call.
public	autoRefreshTimer: Timer Timer instance to work with the auto refresh mechanism
public	backgroundColor: Array Backgrond color, the color of the fill area.
public	borderColor: uint Color of the border.
public	borderSides: String Bounding box sides.
public	borderThickness: Number Bounding box thickness.
public	bottomBarLeft: flexiciousNmsp.UIComponent A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns.
public	bottomBarRight: flexiciousNmsp.UIComponent A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns.
public	builtInActions: String
public	cellBackgroundColorFunction: Function A function that can be used to control the background color of each cell in this column.
public	cellPlacementFunction: Function This is a fimctopm that gets called when the cell is placed.
public	cellTextColorFunction: null
public	checkIconClass: * [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the checkbox that appears when you drag and drop a header cell to reposition the column, and you drop it on a header cell where you can actually complete the re-order operation The default value for the Halo theme is `mx.skins.halo.DataGridSortArrow`.
public	clearErrorsOnDataProviderChange: Boolean Flag that controls whether or not to clear out errors when the data provider changes Defaults to true, so if you are using server paging, set this false
public	clearOpenItemsOnDataProviderChange: Boolean Flag that controls whether or not to clear out openItems when the data provider changes Defaults to true, so if you are using server paging, set this false
public	clearSelectionOnDataProviderChange: Boolean Flag that controls whether or not to clear out selectedObjects and selectedKeys when the data provider changes Defaults to true, so if you are using server paging, set this false
public	clearSelectionOnFilter: Boolean Flag that controls whether or not to clear out selectedObjects and selectedKeys when the filter changes Defaults to false
public	colSpanFunction: null A function that takes in a data object, and a column, and returns a number.
public	collapseTooltip: String Tooltip to display when user hovers over collapse icon
public	columnGroupClosedIcon: Class [Style(name="columnGroupClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed column group.
public	columnGroupColors: Array [Style(name="columnGroupColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the Column Groups background gradient.
public	columnGroupDrawTopBorder: Boolean [Style(name="columnGroupDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border
public	columnGroupHorizontalGridLineColor: uint [Style(name="columnGroupHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	columnGroupHorizontalGridLineThickness: Number [Style(name="columnGroupHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the header horizontal grid lines.
public	columnGroupHorizontalGridLines: Boolean [Style(name="columnGroupHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	columnGroupOpenIcon: Class [Style(name="columnGroupOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open column group.
public	columnGroupPaddingBottom: Number [Style(name="columnGroupPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	columnGroupPaddingLeft: Number [Style(name="columnGroupPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	columnGroupPaddingRight: Number [Style(name="columnGroupPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	columnGroupPaddingTop: Number [Style(name="columnGroupPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	columnGroupRollOverColors: Array [Style(name="columnGroupRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the Column Groups.
public	columnGroupStyleName: String The name of a CSS style declaration for controlling other aspects of the appearance of the column groups.
public	columnGroupVerticalGridLineColor: uint [Style(name="columnGroupVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	columnGroupVerticalGridLineThickness: Number [Style(name="columnGroupVerticalGridLineThickness", type="Number", format="Length")] Thickness of the header vertical grid lines.
public	columnGroupVerticalGridLines: Boolean [Style(name="columnGroupVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	columnMoveAlpha: null this member was deprecated. Starting in 2.9 we no longer draw a glyph, we simply draw a line. This is to add support for dropping column on both sides of the target cell. [Style(name="columnMoveAlpha")] The alpha to apply to the glyph when moving the column.
public	columnMoveResizeSeparatorColor: null [Style(name="columnMoveResizeSeparatorColor", format="Color")] The color of the line to draw when the user is moving or resizing the column
public	configuration: *
public	contextMenuShown: Boolean Set to true when the context menu is shown.
public	crossIconClass: * [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the checkbox that appears when you drag and drop a header cell to reposition the column, and you drop it on a header cell where you can NOT complete the re-order operation
public	currentDataFld: string
public	currentExportLevel: null
public	currentPoint: flexiciousNmsp.InsertionLocationInfo
public	delegate: * When used in conjunction with any third party library (like angular js) YOu may want to point this variable to the controller.
public	disclosureClosedIcon: Class [Style(name="disclosureClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed branch node of the navigation tree.
public	disclosureOpenIcon: Class [Style(name="disclosureOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open branch node of the navigation tree.
public	dispatchCellCreated: Boolean Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.CELL_CREATED event
public	dispatchCellRenderered: Boolean Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.CELL_RENDERED event
public	dispatchRendererInitialized: Boolean Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.RENDERER_INITIALIZED event
public	doubleClickEnabled: Boolean
public	dragAlpha: Number [Style(name="dragAlpha", type="Number")] Alpha for the drag operation.
public	dragDropCompleteFunction: *
public	dragDropGlyph: *
public	dragRowBorderStyle: String [Style(name="dragRowBorderStyle", type="String")] Border for the drag row for the drag operation.
public	dynamicLevelHasChildrenFunction: Function Function to determine if the given object has children.
public	editItemColor: Array [Style(name="editItemColor", type="Array", arrayType="uint", format="Color")] The colors to use for the backgrounds of the items in the grid in the editable mode.
public	editTextColor: null [Style(name="editTextColor", format="Color")] The colors to use for the text of the items in the editable grid.
public	editable: Boolean
public	enableActiveCellHighlight: Boolean Flag to hightlight the active cell.
public	enableAutoRefresh: null If flag is set to true, grid will dispatch an AUTO_REFRESH event every autoRefreshInterval milliseconds.
public	enableColumnWidthUserOverride: Boolean Added in 2.9 to force columns to take the widths that the user specified.
public	enableCopy: Boolean Flag to enable the context menu copy items.
public	enableDefaultDisclosureIcon: Boolean By default, the grid draws a set of expand collapse icons on the left locked section.
public	enableDelayChange: Boolean Added in 2.9 to avoid multiple change events from firing.
public	enableDoubleClickEdit: Boolean Flag to enable edit on doubleclick as opposed to single click.
public	enableDrawAsYouScroll: Boolean When enableVirtualScroll=true, setting this to true will cause each scroll event to issue a server request..
public	enableDynamicLevels: Boolean Flag to enable creation of the next level dynamically as the hierarchy is set.
public	enableEagerDraw: Boolean By default, the grid renders when the dataprovider is set.
public	enableEditRowHighlight: Boolean Flag to hightlight the edit row.
public	enableExport: Boolean Flag to enable export to word and excel.
public	enableFillerRows: Boolean Not supported.
public	enableHeightAutoAdjust: Boolean Flag to size the grid on basis of the number of rows displayed.
public	enableHideIfNoChildren: Boolean Flag to control whether or not an item that has no children is filtered out or not.
public	enableKeyboardNavigation: Boolean
public	enableLocalStyles: Boolean Added in 2.9 to avoid flicker.
public	enableMaintainSelectionOnSelectAll: * In server mode, if this flag is set to true and the user hits select all on a particular page, the grid will maintain the selections made on previous pages.
public	enableMultiplePreferences: Boolean
public	enablePdf: Boolean Enables the print pdf operation.
public	enablePreferencePersistence: Boolean When set to true, causes the grid to look for settings stored previously in the local shared object store if preferencePersistenceMode='client' or dispatch an event requesting settings from the server in preferencePersistenceMode='server'
public	enablePrint: Boolean Enables the print operation.
public	enableResizeTimer: Boolean Flag To watch if our size changed and react accordingly
public	enableSelectAllOnPageChange: * In server mode, if the user selects all and hits page change, this flag will control if the next page of newly loaded records is automatically selected.
public	enableSelectionBasedOnSelectedField: null Flag to enable dataprovider based preselection of data.
public	enableSelectionBubble: Boolean A flag to bubble up selection from children to parents.
public	enableSelectionCascade: Boolean Flag to cascade checkbox or row selection down from the selection level.
public	enableSelectionExclusion: Boolean Support for selection based on exclusion.
public	enableStickyControlKeySelection: Boolean Only applicable when selectionMode=multipleRows or multipleCells By default, when you click on a row (or cell), the grid will add it to the selection.
public	enableTrackChanges: Boolean Flag to enable change tracking If set to true, each addition, update(via the grid) or deletion to the data provider will be tracked.
public	enableTriStateCheckbox: Boolean Flag to enable tristate behavior for selection checkboxes.
public	enableVirtualScroll: null Flag to enable virtual scroll.
public	errorBackgroundColor: uint [Style(name="errorBackgroundColor", type="uint", format="Color", inherit="yes")] The background color of the row that has the error .
public	errorBorderColor: uint [Style(name="errorBorderColor", type="uint", format="Color", inherit="yes")] The border color of the cell that has the error .
public	errorMap: Object
public	excelOptions: ExportOptions The Export options object that is used to configure the excel export behavior - currently only supported in Ultimate
public	expandCollapseTooltipFunction: Function Default function will return the value of expandTooltip or collapseTooltip.
public	expandTooltip: String Tooltip to display when user hovers over expand icon
public	filterColors: Array [Style(name="filterColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background for the filter.
public	filterDrawTopBorder: Boolean [Style(name="filterDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	filterExcludeObjectsWithoutMatchField: Boolean By default, for hierarchical datagrids, when there is a object that does not have the property being searched for, these objects are included in the filter match.
public	filterHorizontalGridLineColor: uint The color of the horizontal grid lines.
public	filterHorizontalGridLineThickness: Number [Style(name="filterHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the filter horizontal grid lines.
public	filterHorizontalGridLines: Boolean [Style(name="filterHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	filterPaddingBottom: Number [Style(name="filterPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	filterPaddingLeft: Number [Style(name="filterPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	filterPaddingRight: Number [Style(name="filterPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	filterPaddingTop: Number [Style(name="filterPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	filterRollOverColors: Array [Style(name="filterRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the filter.
public	filterVerticalGridLineColor: uint [Style(name="filterVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	filterVerticalGridLineThickness: Number [Style(name="filterVerticalGridLineThickness", type="Number", format="Length")] Thickness of the filter vertical grid lines.
public	filterVerticalGridLines: Boolean [Style(name="filterVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	fixedColumnFillColors: Array [Style(name="fixedColumnFillColors", type="Array", arrayType="uint", format="Color", inherit="yes")] A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns
public	footerColors: Array [Style(name="footerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the footer background gradient.
public	footerDrawTopBorder: Boolean [Style(name="footerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	footerHorizontalGridLineColor: uint [Style(name="footerHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	footerHorizontalGridLineThickness: Number [Style(name="footerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the footer horizontal grid lines.
public	footerHorizontalGridLines: Boolean [Style(name="footerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	footerPaddingBottom: Number [Style(name="footerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	footerPaddingLeft: Number [Style(name="footerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	footerPaddingRight: Number [Style(name="footerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	footerPaddingTop: Number [Style(name="footerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	footerRollOverColors: Array [Style(name="footerRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the footer.
public	footerStyleName: String The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
public	footerVerticalGridLineColor: uint [Style(name="footerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	footerVerticalGridLineThickness: Number [Style(name="footerVerticalGridLineThickness", type="Number", format="Length")] Thickness of the footer vertical grid lines.
public	footerVerticalGridLines: Boolean [Style(name="footerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	generateColumns: Boolean Flag to automatically generate columns.
public	getChildrenFunction: Function This function basically gives you the opportunity to tie in to the grids hierarchy lookup mechanism.
public	getRowHeightFunction: null When variableRowHeight =true, atleast one column needs to have the wordWrap flag set to true.
public	globalFilterMatchFunction: null Function to control all the filtering at all levels.
public	hasChildrenFunction: Function This is a property that gets called to determine if a expand/collapse icon needs to be drawn.
public	hasErrors: Boolean A Flag that indicates if there are any errors
public	hasFilter: Boolean By default, there is no filter applied.
public	headerColors: Array [Style(name="headerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the header background gradient.
public	headerDrawTopBorder: Boolen Flag that indicates whether to force the top border [Style(name="headerDrawTopBorder", type="Boolean", inherit="no")]
public	headerHorizontalGridLineColor: uint The color of the horizontal grid lines.
public	headerHorizontalGridLineThickness: Number Thickness of the header horizontal grid lines.
public	headerHorizontalGridLines: Boolean Flag that indicates whether to show horizontal grid lines between the rows.
public	headerPaddingBottom: Number [Style(name="headerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	headerPaddingLeft: Number [Style(name="headerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	headerPaddingRight: Number [Style(name="headerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	headerPaddingTop: Number [Style(name="headerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	headerRollOverColors: Array [Style(name="headerRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the header.
public	headerSortSeparatorColor: null [Style(name="headerSortSeparatorColor", format="Color")] The color of the line between header and the sort section for multi column sort
public	headerSortSeparatorRight: null [Style(name="headerSortSeparatorRight", format="int")] The distance between the sort line and the right edge of the header cell
public	headerStyleName: String The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
public	headerVerticalGridLineColor: uint The color of the vertical grid lines.
public	headerVerticalGridLineThickness: Number Thickness of the header vertical grid lines.
public	headerVerticalGridLines: Boolean Flag that indicates whether to show vertical grid lines between the columns.
public	height: number
public	highlightedCellInfo: *
public	horizontalGridLineColor: uint The color of the horizontal grid lines.
public	horizontalGridLineThickness: Number Thickness of the horizontal grid lines.
public	horizontalGridLines: Boolean Flag that indicates whether to show horizontal grid lines between the rows.
public	htmlOptions: ExportOptions The Export options object that is used to configure the html export behavior - currently only supported in Ultimate
public	imagesRoot: String The root path to all images used by the grid
public	inExport: boolean
public	inRebuildBody: Boolean
public	inUpdate: Boolean
public	isHScrollBarVisible: Number
public	isVScrollBarVisible: Number
public	itemFilters: Dictionary
public	keyboardListenersPaused: boolean
public	lastAutoRefresh: Date Last time the auto refresh timer was triggered
public	lastHScroll: number
public	lastVScroll: number
public	lockedSeperatorColor: uint [Style(name="lockedSeperatorColor", type="uint", format="Color", inherit="yes")] The color of the vertical seperators for the locked content.
public	lockedSeperatorThickness: Number [Style(name="lockedSeperatorThickness", type="Number", inherit="yes")] The width of the vertical seperators for the locked content.
public	matchedObjects: *[]
public	maxAutoAdjustHeight: Number The maximum height to adjust the grid when enableHeightAutoAdjust is set to true.
public	measuredHeight: *
public	measuredMinHeight: *
public	measuredMinWidth: *
public	measuredWidth: *
public	measurer: *
public	multiColumnSortNumberFields: Number The number of field dropdowns to display in the multi column sort popup.
public	multiColumnSortNumberHeight: Number The height of the numeric value representing the order of the column sort.
public	multiColumnSortNumberStyleName: String The name of a CSS style declaration for controlling other aspects of the appearance of the numeric value representing the order of the column sort.
public	multiColumnSortNumberWidth: Number The width of the numeric value representing the order of the column sort.
public	noDataMessage: String If enabled (set to a string with length>0), when a dataprovider with zero items is set, or when filter criteria returns no records, a message is shown with this data.
public	paddingBottom: Number [Style(name="paddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	paddingLeft: Number [Style(name="paddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	paddingRight: Number [Style(name="paddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	paddingTop: Number [Style(name="paddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	pagerColors: Array [Style(name="pagerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the pager background gradient.
public	pagerDrawTopBorder: Boolean [Style(name="pagerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	pagerHorizontalGridLineColor: uint [Style(name="pagerHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	pagerHorizontalGridLineThickness: Number [Style(name="pagerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the pager horizontal grid lines.
public	pagerHorizontalGridLines: Boolean [Style(name="pagerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	pagerPaddingBottom: Number [Style(name="pagerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	pagerPaddingLeft: Number [Style(name="pagerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	pagerPaddingRight: Number [Style(name="pagerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	pagerPaddingTop: Number [Style(name="pagerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	pagerRollOverColors: Array [Style(name="pagerRollOverColors",type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the pager.
public	pagerStyleName: String The name of a CSS style declaration for controlling other aspects of the appearance of the pager bar(toolbar).
public	pagerVerticalGridLineColor: uint [Style(name="pagerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	pagerVerticalGridLineThickness: Number [Style(name="pagerVerticalGridLineThickness", type="Number", format="Length")] Thickness of the pager vertical grid lines.
public	pagerVerticalGridLines: Boolean [Style(name="pagerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	pdfOptions: PrintOptions The Print options object that is used to configure the pdf behavior - currently only supported in Ultimate
public	pdfOptionsBasic: ExportOptions The Export options object that is used to configure the html export behavior - currently only supported in Ultimate
public	pdfPrinter: null
public	placed: boolean
public	placedHeight: *
public	placedWidth: *
public	popupFactoryExportOptions: flexiciousNmsp.ClassFactory
public	popupFactoryOpenSettingsPopup: flexiciousNmsp.ClassFactory
public	popupFactoryPrintOptions: flexiciousNmsp.ClassFactory
public	popupFactorySaveSettingsPopup: flexiciousNmsp.ClassFactory
public	popupFactorySettingsPopup: flexiciousNmsp.ClassFactory
public	preferencePersistenceMode: String String value "server" or "client".
public	preferencesSet: Boolean
public	preferencesToPersist: *
public	printComponentFactory: flexiciousNmsp.ClassFactory
public	printOptions: PrintOptions The Print options object that is used to configure the print behavior - currently only supported in Ultimate
public	rebuildGridOnDataProviderChange: Boolean Flag that controls whether or not to rebuild the entire grid on dataprovider change.
public	recalculateSeedOnEachScroll: Boolean Flag should be set to true when you have large variable height based rows that are potentially taller than the grid itself.
public	recordBeingExported: *
public	rendererCache: RendererCache
public	rendererColors: Array [Style(name="rendererColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the renderer background gradient.
public	rendererDrawTopBorder: Boolean [Style(name="rendererDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public	rendererHorizontalGridLineColor: uint [Style(name="rendererHorizontalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the horizontal grid lines.
public	rendererHorizontalGridLineThickness: Number [Style(name="rendererHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the renderer horizontal grid lines.
public	rendererHorizontalGridLines: Boolean [Style(name="rendererHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public	rendererPaddingBottom: Number [Style(name="rendererPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	rendererPaddingLeft: Number [Style(name="rendererPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	rendererPaddingRight: Number [Style(name="rendererPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public	rendererPaddingTop: Number [Style(name="rendererPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public	rendererRollOverColors: uint [Style(name="rendererRollOverColors", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over a level renderer.
public	rendererVerticalGridLineColor: uint [Style(name="rendererVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.
public	rendererVerticalGridLineThickness: Number [Style(name="rendererVerticalGridLineThickness", type="Number", format="Length")] Thickness of the renderer vertical grid lines.
public	rendererVerticalGridLines: Boolean [Style(name="rendererVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public	resizeListenerPaused: boolean
public	resizeTimer: flexiciousNmsp.Timer To watch if our size changed and react accordingly
public	responsiveBehavior: flexiciousNmsp.ResponsiveBehavior The behavior responsible for adding responsiveness to the grid
public	rollOverColor: uint [Style(name="rollOverColor", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the row.
public	rowSpanFunction: null A function that takes in a data object, and a column, and returns a number.
public	scrollEnabledFunction: Function Function to intercept the body scrolling.
public	scrollTimer: *
public	selectionChain: Object
public	selectionColor: * [Style(name="selectionColor", type="uint", format="Color", inherit="yes")] The color of the background for the row when the user selects an item renderer in the row.
public	selectionDisabledColor: uint [Style(name="selectionDisabledColor", type="uint", format="Color", inherit="yes")] The color of the background of a renderer when the component is disabled.
public	showSpinnerOnFilterPageSort: Boolean
public	sortArrowSkin: * [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the arrow that indicates the column sort direction.
public	spinner: null
public	spinnerBehavior: flexiciousNmsp.SpinnerBehavior
public	spinnerColors: Array Colors for the spinners as an array.
public	spinnerGridAlpha: Number Background color of the grid when the spinner is active [Style(name="spinnerGridAlpha", type="Number", format="Length", minValue="0.0")]
public	spinnerRadius: null Spinner radius , default value is 10
public	spinnerThickness: Number Spinner thickness , default value is 5 [Style(name="spinnerThickness", type="Number", format="Length", minValue="0.0")]
public	textAlign: String Alignment of text within a container.
public	textDisabledColor: uint [Style(name="textDisabledColor", type="uint", format="Color", inherit="yes")] The color of the text of a renderer when the component is disabled.
public	textRollOverColor: uint [Style(name="textRollOverColor", type="uint", format="Color", inherit="yes")] Color of the text when the user rolls over a row.
public	textSelectedColor: uint [Style(name="textSelectedColor", type="uint", format="Color", inherit="yes")] Color of the text when the user selects a row.
public	themeID: String
public	toolbarActions: *[]
public	toolbarExcelHandlerFunction: Function Function that actually runs the export to excel.
public	toolbarPdfHandlerFunction: Function Function that actually runs the pdf.
public	toolbarPrintHandlerFunction: Function Function that actually runs the print.
public	toolbarWordHandlerFunction: Function Function that actually runs the export to word.
public	tooltipBehavior: flexiciousNmsp.TooltipBehavior TooltipBehavior
public	updateTotalRecords: Boolean
public	useCompactPreferences: Boolean If set to true, uses the newer preference persistence scheme introduced in Flexicious 2.0, which stores the preferences as custom string as opposed to XML, making it a lot less verbose.
public	useEnhancedPdf: Boolean HTMLTreeGrid v3.0 introduced an enhanced printing feature, for those of you who want the old feature, just set this flag to false.
public	useEnhancedPrint: Boolean HTMLTreeGrid v3.0 introduced an enhanced printing feature, for those of you who want the old feature, just set this flag to false.
public	useRollOver: Boolean
public	userSettingsOptionsFunction: Function
public	variableHeaderHeight: Boolean When you enable headerWordWrap=true, then we need to set this to true, because we will dyamically adjust the height of the header row.
public	variableHeaderHeightOffset: Number In case the calculations of the row height with text measurements is not accurate browser style issue you can use this variable to adjust the calculation based on your scenario
public	variableRowHeight: Boolean A flag that indicates whether the individual rows can have different height.
public	variableRowHeightOffset: Number In case the calculations of the row height with text measurements is not accurate (Flash player bug) you can use this variable to adjust the calculation based on your scenario
public	variableRowHeightUseRendererForCalculation: Boolean By default, the flexicious Ultimate Grid does not instantiate and measure each cell renderer when you set variable row heights.
public	verticalGridLineColor: uint The color of the vertical grid lines.
public	verticalGridLineThickness: Number Thickness of the vertical grid lines.
public	verticalGridLines: Boolean Flag that indicates whether to show vertical grid lines between the columns.
public	width: number
public	wordOptions: ExportOptions The Export options object that is used to configure the word export behavior - currently only supported in Ultimate
public	addColumn(col: *) Adds the column to the collection of columns at the root level.
public	addComponent(component: *)
public	addEventListener(type: , listener: , useCapture: , priority: , useWeakReference: *)
public	addPopup(component: *)
public	addRemoveFromOpenItems(item: , open: , level: *)
public	addSelectedItem(val: *) Adds the provided item to the selection of the top (root) level.
public	addToolbarAction(action: , itemIndex: )
public	alignColumnGroups() If you modify one or more column groups, calling this method is required so that inter related column groups can update themselves.
public	applyAttribute(target: , attr: , node: , direct: ) Applies the given attribute to the target.
public	applyTheme(themeID: *) Rebuilds the grid based on the current theme
public	buildFromXml(strXml: *) The main method that parses the configuration XML and builds the FlexDataGrid
public	calculateRowHeight(item: , level: , rowType: ): If variableRowHeight returns the minimum height required to display text of each column without clipping.
public	cascadeColumnGroups(cg: *)
public	checkGetterAndRetrieve(target: , attrName: ): * Checks to see if there is a getter with the specified name, and if so, return the value of that getter other wise return the value of the field with this name,
public	checkNoDataMessage(force: *) If a noDataMessage value is specified, and a dataprovider with zero records is set, calls the showMessage function passing in the noDataMessage, which in turn shows the value of the noDataMessage using the Spinner component with its spinner hidden.
public	checkResize(): boolean Check for changes to the div that holds us.
public	checkScrollEnabled(evt: *)
public	checkSetterAndApply(target: , attrName: , val: *) Checks to see if there is a setter by the name provided, and if so use that, else apply as a property
public	clearAllCollections() Clears out the following collections All Open Items All Errors Selection (only if clearSelectionOnDataProviderChange==true) Some internal housekeeping collections
public	clearAllErrors() Clears out all the errors
public	clearAllFilters() Clears filters at all levels and rebuilds the grid.
public	clearAllHighlight()
public	clearChanges() Sets changes to an empty array.
public	clearColumns(rebuild: *) Clears out all the columns of the grid If the parameter to rebuild is true, the grid will be rebuilt.
public	clearCurrentHighlight(currentMatchedObject: *)
public	clearErrorByKey(key: , fld: ) Clears the errors for the specified key
public	clearErrorByObject(item: , fld: ) Similar to clearErrorByKey, except takes the actual object that the key represents.
public	clearFilter() Clears the filters at all levels
public	clearFlattenedCache() When the dataprovider changes or when new data comes in from the server for lazy loaded grids, you can call this to clear out the flattened cache.
public	clearPreferences()
public	clearSelection() Clears the selected rows and cells.
public	collapseAll() For nested datagrids, expands all items one level down
public	collapseAllColumnGroups(lvl: *) For grids with column groups, expands them all.
public	commitProperties()
public	componentDidMount()
public	componentWillReceiveProps(nextProps: *)
public	componentWillUnmount()
public	concatenatePersistenceValues(): *
public	createBodyContainer(): * Method to create an instance of the FlexDataGridBodyContainer class.
public	createBuiltinAction(lbl: , code: , requiresSelection: , requiresSingleSelection: ): * Creates a Toolbar Action
public	createChromeContainer(): * Method to create an instance of the FlexDataGridHeaderContainer class.
public	createColumn(isCheckBox: ):
public	createColumnGroup(): flexiciousNmsp.FlexDataGridColumnGroup
public	createColumnLevel(): flexiciousNmsp.FlexDataGridColumnLevel
public	createComponents(currentScroll: *)
public	createElasticContainer(): * Method to create an instance of the ElasticContainer class.
public	createFilter(): * Returns the top level filter.
public	createLockedContent(): * Method to create an instance of the LockedContent class.
public	createPrintComponentFactory(): * Gets the class responsible for handling the PrintUI should be a IPrintDataGrid
public	defaultDynamicLevelHasChildrenFunction(item: ): Returns true if the getLength method on the result of the getChildren method returns more than 0
public	defaultExcelHandlerFunction() Default handler for the Word Export Button.
public	defaultExpandCollapseTooltipFunction(cell: ): If grid.getOpenItems().contains(getItemKey(cell.rowInfo.data)), return the value of expandTooltip else collapseTooltip
public	defaultPdfHandlerFunction() Default handler for the Print Button.
public	defaultPrintHandlerFunction() Default handler for the Print Button.
public	defaultUseSettingsOptionsFunction(): * returns UserSettingsOptions.create(this);
public	defaultWordHandlerFunction() Default handler for the Word Export Button.
public	dispatchAutoRefreshEvent(event: *) Handle for the auto refresh.
public	dispatchEvent(e: ):
public	distributeColumnWidthsEqually() Modifies the columns so the width is distributed equally.
public	dragAcceptReject(cell: *) Called when the drag enters over a cell.
public	dragBegin(event: *) Triggered when drag is starting.
public	dragComplete(event: *) Triggered when the drag is complete.
public	dragDrop(event: *) Called when the DragDrop event is dispatched over any of the cells.
public	dragDropInternal(event: *)
public	dragEnter(event: *) Called when the DragEnter event is dispatched over any of the cells.
public	dragEnterInternal(event: *)
public	drawDefaultSeperators()
public	drawFiller() When enableFillerRows=true, wipes out and recreates the filler rows.
public	drawFillerCell(section: , color: , pointer: , currx: , colWidth: , verticalGridLines: , verticalGridLineThickness: , verticalGridLineColor: , horizontalGridLines: , horizontalGridLineThickness: , horizontalGridLineColor: , rowHt: , draw: , colIsInView: , sectionHorizontalScrollPosition: ):
public	dumpConfig() Dumps the configuration information
public	enableDisableToolbarAction(code: , enable: ) In addition to initial enable/disable of toolbar actions, this function can be used to enable or disable toolbar actions at run time.
public	ensureLevelsCreated(item: , level: ) When enableDynamicLevels=true and there is only one level, we iterate through the data provider and ensure that the maximum depth has been accounted for.
public	executeFunctionByName(functionName: , context: ): *
public	expandAll() For nested datagrids, expands all items one level down
public	expandAllColumnGroups(lvl: *) For grids with column groups, expands them all.
public	expandChildrenOf(item: , open: , level: *) Opens or closes all the nodes of the navigation tree below the specified item.
public	expandDown() For nested datagrids, expands all items one level down
public	expandToLevel(level: , maxItems: ) For nested datagrids, expands all items to the level specified.
public	expandUp() For nested datagrids, expands all items one level up
public	extractAction(item: ):
public	extractAction(actionNode: , action: ): *
public	extractActionFromObject(item: ): Method to extract action.
public	extractActions(actionsNode: , grid: )
public	extractCol(colNode: ):
public	extractColGroup(cgNode: ):
public	extractColumns(levelNodeChild: , lvl: ): {"cols": , "hasColumnGroups": , "j": , "colNode": } Method to extact column information from XML
public	extractFilters(filtersNode: , grid: ) Code to extract filters.
public	extractLevel(levelNode: , lvl: ) Method to extract level information from xml
public	flatten(depthRequested: , inclusive: , filter: , page: , sort: , max: ): Array For hierarchical data grids, returns the data provider as a flat list that matches the specified criteria.
public	flattenRecursive(depthRequested: , result: , parent: , level: , inclusive: , filter: , page: , sort: )
public	generateImageForDrag(cell: *) Generates a snapshot of the row for the drag visual indicator
public	getActionByCode(code: ): Given a code, loops through the toolbarActions, and gets the toolbar action with the given code.
public	getAdditionalFilterArgumentsFunction(): * Pointer to the TOP level additionalFilterArgumentsFunction In scenarios where there are detached filters, this function may be used to add on to the list of arguments before the filter is run.
public	getAllErrorString(): * Returns an object that has the error information for the passed in object.
public	getAutoLoadPreferences(): * By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference. This works well in most cases, but in some cases, where the data needed to build selection comboboxes (for filters) is built from the dataprovider, it makes sense to wait until the dataprovider is loaded to parse and set the preferences, otherwise the grid will end up ignoring saved preferences for filters that have dropdown based UI. In this case set autoLoadPreferences to true, and manually call loadPreferences when the data is received from the server and the dataprovider is set. grid:FlexDataGrid autoLoadPreferences=”false” And then, when you set the dataprovider: dgReport.dataProvider=dp; if(!dgReport.getPreferencesLoaded()){ dgReport.loadPreferences(); }
public	getBodyContainer(): * The main scrollable area of the grid.
public	getCanExpandDown(): * Returns true of this is a nested grid, and we have not expanded to the lowest level
public	getCanExpandUp(): * Returns true of this is a nested grid, and we have expanded to a level below 1.
public	getCellBorderFunction(): * Pointer to the TOP level cellBorderFunction A function that lets you control the border drawing mechanism for each cell.
public	getCellCustomBackgroundDrawFunction(): * Pointer to the TOP level cellCustomBackgroundDrawFunction A function that lets you control the background drawing mechanism for each cell.
public	getCellForRowColumn(data: , column: ): * Given a data object and a colum, return the IFlexDataGridDataCell object for the combination
public	getCellInDirection(cell: , direction: ): * Gets the cell in the specified direction of the provided cell
public	getChanges(): * An array of ChangeInfo objects that contains all the changes made to the data provider using the grid editing mechanism.
public	getChildren(object: , level: , filter: , page: , sort: ): If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object.
public	getChildrenCountField(): * Pointer to the TOP level childrenCountField A property on the object that identifies if the object has children.
public	getChildrenField(): * The property of the parent level object, that identifies the children that should be displayed on the next level.
public	getChildrenLength(object: , level: , filter: , page: , sort: ): Calls getChildren, and if result is XML or XMLList, returns length() else returns length;
public	getClassNames(): string[]
public	getColSpanFunction(): * A function that takes in a data object, and a column, and returns a number.
public	getColumnByDataField(fld: ): Returns the column with the specified datafield, only at the root level
public	getColumnByUniqueIdentifier(fld: ): Returns the column with the specified UniqueIdentifier, only at the root level
public	getColumnCount(): * Returns the top level columnCount
public	getColumnGroups(): * Returns the list of columns groups at the root level.
public	getColumnLevel(): * The Root Column Level.
public	getColumnNames(): * Returns the top level column names
public	getColumns(): * Returns the list of columns at the root level.
public	getContainerForCell(cell: ): Given a IFlexDataGridCell, returns a container that holds that cell.
public	getContainerInDirection(container: , up: ): * Returns the section above or below the provided section.
public	getContainerName(container: *): string Given a container, returns its displayOrder string equivalent.
public	getCornerY(comp: ): Corner areas are special containers that exist to hold filter and header on the top and Pager and Footer on the bottom If I am filter cell, return 0 if filter is above header (true always) IF I am header cell, return filterHeight + (headerHeight * header Depth) If I am footer cell, return 0 If I am pager cell, return pager footer height
public	getCurrentEditCell(): * Gets the cell that is currently being edited.
public	getCurrentEditor(): * Gets the editor that is currently being edited.
public	getCurrentMatch(): Number The index of the currently matched object
public	getCurrentPreferenceInfo(): * When enableMultiplePreferences = true, this represents the currently applied preference
public	getCurrentSorts(): * Return the FilterSort objects at the top level
public	getCurrentTooltip(): * The current tooltip object.
public	getCurrentTooltipTrigger(): * The current tooltip object trigger.
public	getDataForPrintExport(printOptions: PrintOptions): * Called by PrintController and ExportController to get the data on basis of PrintOptions and ExportOptions
public	getDataProvider(): * The data provider for the grid.
public	getDataProviderNoFilters(): * Returns the TOP level data without any filters.
public	getDataProviderNoPaging(): * Returns the TOP level data without any paging, but with filters.
public	getDisabledField(): * A property on the object that identifies whether the object is disabled.
public	getDisplayOrder(): * A comma seperated list of the following strings: filter,header,body,footer,pager.
public	getDragColumn(): * The column that initiated the drag
public	getElementToCenter(): * The element of the owner that should be used to center the spinner.
public	getElementsToBlur(): undefined[] All elements of the spinner owner that should be blurred when the spinner is active.
public	getEnableFilters(): * Flag that indicates whether or not to show the filter
public	getEnableFooters(): * Flag that indicates whether or not to show the footer
public	getEnablePaging(): * Flag to indicate whether or not to enable paging functionality
public	getEnableRowNumbers(): * Flag to embed a column that shows row numbers
public	getEnableSplitHeader(): Boolean When enableMultiColumnSort=true, setting this flag to on will enable AdvancedDataGrid like Split headers to enable multi column sort.
public	getError(item: ): Returns an object that has the error information for the passed in object.
public	getExpandCollapseCellRenderer(): * Pointer to the TOP level expandCollapseCellRenderer
public	getExpandCollapseHeaderCellRenderer(): * Pointer to the TOP level expandCollapseHeaderCellRenderer
public	getExportController(): * Returns the export controller instance
public	getExportableColumns(exportOptions: ): Returns all columns at all levels.
public	getExportableColumns(): * Returns the columns where excludeFromExport=false
public	getExportableColumnsAtAllLevel(exportOptions: ): Returns all columns at all levels.
public	getFilterArguments(): * Returns the filter at the top level.
public	getFilterColumn(searchField: ): Gets the column with the specified search field
public	getFilterContainer(): * The container for the filter cells.
public	getFilterFunction(): * Pointer to the TOP level filterFunction
public	getFilterPageSortMode(): * The Filter/Page/Sort Mode.
public	getFilterRowHeight(): * Sets the filter row height at the top level.
public	getFilterRows(): * Returns an array of RowInfo objects in the filter row.
public	getFilterValue(col: ): Used to set the initial value of the filter at the top level for the specified field.
public	getFilterVisible(): * Returns true if the filter row is visible at the top level.
public	getFilterX(renderer: ): Used by filter to identify where relative position for each control for tabbing
public	getFilteredPagedSortedData(dictionary: , applyFilter: , applyPaging: , applySort: , pages: ): Returns the data provider, with filter, paging and sorting applied on basis of the boolean flags specified.
public	getFooterContainer(): * The container for the footer cells.
public	getFooterRowHeight(): * Returns the sum of: If enableFooters, then footerRowHeight else 0
public	getFooterRows(): * Returns an array of RowInfo objects in the footer row.
public	getFooterVisible(): * Returns true if the footer row is visible at the top level.
public	getForcePagerRow(): * Flag to force appearance of the pager row even with enablePaging=false.
public	getGlobalFilterColumns(): Array A list of columns that the global search uses to search.
public	getGlobalFilterString(): String
public	getGlobalHighlightColumns(): Array Array to search for when highlighting a term in specific columns
public	getGlobalHightlightAll(): Array A Boolean variable that tells us whether to highlight just the first occurence or all occurences
public	getGlobalHightlightString(): String A String to highlight in the grid.
public	getGridPreferencesInfo(): * When enableMultiplePreferences = true, this represents a list of all preferences saved for this grid.
public	getGroupedColumns(): * Returns the list of groupedColumns at the root level.
public	getHasFilterFunction(): * returns true if any of the levels have a filter function
public	getHasGroupedColumns(): * Added for Persistence support
public	getHasRowSpanOrColSpan(): * If rowSpanFunction!=null or colSpanFunction!=null
public	getHeaderContainer(): * The container for the header cells.
public	getHeaderRowHeight(): * Pointer to the TOP level headerHeight Height of the header for this level.
public	getHeaderSectionHeight(): * Returns the sum of: If enableFilters, then filterRowHeight else 0 plus headerHeight
public	getHeaderSeperatorWidth(): * Pointer to the TOP level headerSeparatorWidth Width to show the resize indicator between columns.
public	getHeaderSortSeparatorRight(): * Gets the value of the headerSortSeparatorRight property
public	getHeaderVisible(): * Returns true if the header row is visible at the top level.
public	getHeight(): Number Gets the height of this component
public	getHorizontalScrollBar(): * The horizontal scrollbar associated with the this.getBodyContainer().
public	getHorizontalScrollPolicy(): * Whether or not to show the horizontal scroll bar.
public	getHorizontalScrollPosition(): * The horizontal scroll position of the body container.
public	getInitialSortAscending(): * If true, initial sort direction for this level is ascending.
public	getInitialSortField(): * The property of the object on this level that should be used in the default sort at the root level.
public	getIsClientFilterPageSortMode(): * Returns true if the top column level filterPageSortMode is client.
public	getIsScrolling(): *
public	getItemAtPosition(position: ): Returns the RowPosition Info object for the item at the given vertical scroll position
public	getItemFilter(level: , item: ): *
public	getItemLoadMode(): * Pointer to the TOP level itemLoadMode
public	getLeftLockedContent(): * The container for the left locked data cells.
public	getLeftLockedFooter(): * The container for the left locked footer cells.
public	getLeftLockedHeader(): * The container for the left locked filter and header cells.
public	getLength(arr: ): If arr is XML or XMLList, returns length() else returns length;
public	getLevel(levelDepth: ): Returns FlexDataGridColumnLevel object at the specified depth
public	getLevelAtNestDepth(depth: ):
public	getLevelForItem(itemToFind: , flat: , level: ): Provided an item, loops through the data provider, and finds the level associated with the provided item.
public	getLevelRendererHeight(): * Pointer to the TOP level levelRendererHeight Height to assign to the renderer for each level.
public	getLocalName(node: ): \| String \| * IE does not know localName, it knows baseName.
public	getLockedColumnCount(): * Unused/Not Applicable.
public	getLockedColumnWidth(): * Unused/Not Applicable.
public	getMatchedObjects(): Array
public	getMaxDepth(): * Returns the max depth possible for nested datagrids
public	getMaxHorizontalScrollPosition(): * The max horizontal scroll position of the bodyContainer
public	getMultiSortRenderer(): * A Class that is responsible for the multi column sort view.
public	getNamedContainer(name: ): Given a displayOrder string , returns its container equivalent.
public	getNestIndent(): * Pointer to the TOP level nestIndent The indentation to apply to each progressive nest level.
public	getNestIndentPaddingCellRenderer(): * Pointer to the TOP level nestIndentPaddingCellRenderer Container for the nest indent padding cell.
public	getNewIndex(lcw: , item: , direction: ):
public	getNextLevelRenderer(): * Pointer to the TOP level nextLevelRenderer
public	getOpenItemCount(cell: ): Given a cell if it is a datarow, and it is associated with a column and the column is at the nest level of the cell, and the column is left locked and the data item bound to the cell is open, then will return the recursive count of all open items under this cell.
public	getOpenItems(): * this method was deprecated. Please use the getOpenKeys and getOpenItems instead. A list of items that the user has opened.
public	getOpenKeys(): * A list of ID values, based on the selectedKeyField property.
public	getOpenObjects(): * Returns a copy of the open items array.
public	getPageIndex(): * Page index at the top level.
public	getPageSize(): * The page size of the top(root) level.
public	getPager(): * Returns the top level pager
public	getPagerCellRenderer(): * Pointer to the TOP level pagerCellRenderer Container for the footer renderer.
public	getPagerContainer(): * The container for the pager cells.
public	getPagerControl(): * Returns the pager control at the root level.
public	getPagerRenderer(): * A Class that implements com.flexicious.controls.interfaces.IPager.
public	getPagerRowHeight(): * Gets the pager row height at the top level.
public	getPagerVisible(): * Returns true if the pager row is visible at the top level.
public	getParent(object: , level: ): * Returns the parent object for the passed in object.
public	getParentContainer(cell: ): Returns the container for the given cell
public	getPeristenceKey(): * String value that uniquely identifies this grid across the application.
public	getPreferencePersistenceKey(): * String value that uniquely identifies this grid across the application.
public	getPreferences(): * Returns an XML representation of the preferences specified in the preferencesToPersist property and values being the actual values.
public	getPreferencesLoaded(): * Returns true if the load preferences has been called.
public	getPreservePager(): * If you set this to true, the next call to rebuild will not rebuild the pager control Needed in cases where there is user interaction in the pager control that we do not want to loose, but we want to rebuild the rest of the grid.
public	getPrintController(): * Returns the print controller instance
public	getPrintableColumns(options: ):
public	getRecursiveOpenItemCount(children: , nextLevel: ): *
public	getRightLockedContent(): * The container for the right locked data cells.
public	getRightLockedFooter(): * The container for the right locked footer cells.
public	getRightLockedHeader(): * The container for the right locked filter and header cells.
public	getRightLockedWidth(): * Returns the maximum width of right locked columns.
public	getRootFilter(): * Gets the filter at the root level
public	getRootFlat(): * Returns a iterable representation of the dataprovider.
public	getRowCount(): * Returns the number of rows currently visible.
public	getRowDisabledFunction(): * A property on the object that identifies whether the object is disabled.
public	getRowHeight(): * Height of the row for this level.
public	getRowSelectableFunction(): * A function that can be used to control whether clicking on any cell in this level will select it.
public	getRowSpanBasedOnOpenItemCount(cell: ): Given a cell, returns it row span based upon how many children are open Recursively inspects the children to see if any of them are open as well.
public	getRowSpanFunction(): * A function that takes in a data object, and a column, and returns a number.
public	getRowText(item: Object, cols: Array): String Iterates through the passed in cols, calls itemToLabel on each of them passing in the item, and return the resulting string in tab delimited format.
public	getSelectAllState(): * If all items from the top level are selected, returns TriStateCheckBox.STATE_CHECKED.
public	getSelectableField(): * This is a boolean flag on the dataprovider that notifies the grid whether or not the grid should allow interactive selection on the corresponding record.
public	getSelectedField(): * A field on the dataprovider that indicates that this item should be selected
public	getSelectedIndex(): * Only applicable for flat grids.
public	getSelectedIndices(): * Returns dataProvider.indexOf(selectedObjects(0))
public	getSelectedItem(): * Returns (selectedObjects(0)).
public	getSelectedItems(): * Returns the top level selectedObjects
public	getSelectedKeyField(): * The concept of selection in Flexicious Ultimate is much more powerful as compared to the basic SDK datagrids in the following ways: First, It supports selection independant of dataprovider, so when a row is selected in the grid, we store the the selected object in the selectedObects array collection.
public	getSelectedKeys(): * A list of ID values, based on the selectedKeyField property.
public	getSelectedKeys(): * For nested datagrids, used to get all records at all levels.
public	getSelectedObjects(getKey: , unSelected: ): * A list of selected objects from the data provider.
public	getSelectedObjectsTopLevel(): * A list of selected objects from the data provider.
public	getSelectionInfo(): * Support for selection based on exclusion.
public	getSettingsColumns(): * Returns the columns where excludeFromSettings=false
public	getSortableColumns(): * Returns the columns where excludeFromExport=false
public	getSpinnerParent(): * The parent to add the spinner to.
public	getThemeToolbarIconFolder(): * Based upon the current theme id, returns the theme icons folder.
public	getToolbarActionAddRow(): * Returns the built in Add Row Action
public	getToolbarActionButton(code: ): Gets the actual button object for the provided toolbar action.
public	getToolbarActionDelete(): * Returns the built in Delete Action
public	getToolbarActionEdit(): * Returns the built in Edit Action
public	getToolbarActionFilter(): * Returns the built in Filter Action
public	getToolbarActionMoveDown(): * Returns the built in moveDown Action
public	getToolbarActionMoveTo(): * Returns the built in Move to Action
public	getToolbarActionMoveUp(): * Returns the built in moveUp Action
public	getToolbarActionSeparator(): * Returns the built in moveUp Action
public	getToolbarActionSort(): * Returns the built in Edit Action
public	getTotalRecords(): * The total number of records at the root level (needs to be set only in server mode, because there is no way for the grid to know how many records on the server match the filter criteria) In client mode, the count of the data provider is used instead.
public	getTraceRows(): *
public	getUnSelectedKeys(): * When enableSelectionExclusion, returns a list of items that the user explicitly unselected.
public	getUseElements(): boolean Whether to use addElement or addChild;
public	getUserSettingsController(): *
public	getVerticalScrollBar(): * The vertical scrollbar associated with the this.getBodyContainer().
public	getVerticalScrollBarOffset(): * Not used.
public	getVerticalScrollPosition(): * The vertical scroll position of the body container.
public	getVerticalSpill(): *
public	getVirtualBodyContainer(): * The main scrollable area of the grid.
public	getVirtualScrollDelay(): * Delay in milliseconds before "virtualScroll" event is dispatched.
public	getVisibleColumns(): * Returns the columns where visible=true
public	getWidth(): Number Gets the height of this component
public	getprintExportData(): * This is not used.
public	globalFilterFunction(item: ): A global filter function that matches against gloalSearchString
public	gotoHorizontalPosition(vsp: *) Goes to the specified horizontal position.
public	gotoItem(item: , highlight: , level: *) Given a data item, scrolls to that item in the datagrid
public	gotoKey(key: , highlight: , level: *) Given a key, scrolls to the item that has the provided value for the selectedKeyField at that level
public	gotoNextHighlight(backwards: *) Handler for the next highlight
public	gotoRow(rowIndex: *) Given a row index (less than the total number of rows, goes to the row in question).
public	gotoVerticalPosition(vsp: *) Goes to the specified vertical position.
public	hideSpinner()
public	hideTooltip() Hides the current tooltip.
public	highlightRow(cell: , row: , highLight: , highLightColor: ) On basis of the highLight flag, removes or adds highlight to the row in question.
public	initialize() Initializes the auto complete and watermark plugins
public	invalidateCells() Invalidates the display (Calls invalidateDisplayList of all the cells).
public	invalidateDisplayList()
public	invalidateFiller() Queues a call to drawFiller in the next validation cycle
public	invalidateHorizontalScroll() Called when you scroll and expand collapse.
public	invalidateList() Calls the rebuild function, which basically rebuild the entire grid.
public	invalidateSelection()
public	isCtrlKeyDownOrSticky(event: ): Return true if enableStickyControlKeySelection Or (Control Key is down AND (selectionMode is MultipleRows or MultipleCells))
public	isInVisibleHorizontalRange(x: , wwidth: ): Boolean Returns true if the passed in cordinates are in the visible ViewPort
public	isToolbarActionValid(action: , currentTarget: , extendedPager: *): boolean Evaluates whether the given toolbar action is valid or not.
public	itemsQuickFind(whatToFind: String, flat: Object, level: FlexDataGridColumnLevel, result: Array, searchCols: Array, breakAfterFind: Boolean, captureCols: Boolean, flatIndex: Number): *
public	keyDownHandler(event: *) Support for key board interaction.
public	keyUpOrDown(keyCode: *) Not used, because it is handled by the grid itself.
public	kill() Cleanup method
public	loadPreferences() Loads preference values from the Shared object, called automatically in preferencePersistenceMode=client.
public	measure() Measures the DataGrid based on its contents, summing the total of the visible column widths.
public	measureCellHeight(col: , paddingLeft: , paddingRight: , paddingTop: , paddingBottom: , itemRenderer: , ht: , txt: , item: , styl: , isHeader: ): Given a column and padding values, calculate the height required to fully render the text
public	multiColumnSortGetTooltip(cell: ): Gets the text of the tooltip to show to the user to prompt for the multi column sort.
public	multiColumnSortShowPopup() Creates an instance of the multiSortRenderer and pushes it into view
public	onCellContextMenuItemClick(event: *) Method to handle the click for the copy cell menu item Copies the current cell in tab delimited format into the clipboard
public	onContainerScroll(evt: *)
public	onContextMenuSelect(event: *)
public	onCreationComplete(event: *)
public	onDoubleClick(event: *) In this method, we trap all double click events, walk up the target tree until we hit a IFlexDataGridDataCell object, and if we indeed double clicked a data cell, we dispatch and ITEM_DOUBLE_CLICK event.
public	onDragEnd(event: *)
public	onDragMove(evt: *)
public	onGridMouseOut(event: *)
public	onGridResized(event: *)
public	onMouseWheel(event: *) Transfers mouse wheel events over the locked left and right sections to scroll events on the body container, so we scroll when the user mouse wheels over the left or right locked containers.
public	onRootFilterChange(event: *)
public	onRootPageChange(event: *)
public	onRowContextMenuItemClick(event: *) Method to handle the click for the copy row menu item Copies the current row in tab delimited format into the clipboard
public	onScrollTimerComplete(event: *)
public	onTableContextMenuItemClick(event: *)
public	parse(strXml: , grid: ) used by the buildFromXml method to parse the XML to build the grid
public	pauseKeyboardListeners(filterRenderer: *) For some operations, like shift tab and tab key up, purposely pause the Container keyboard listenters, so we do not overwrite the work of one keyboard handler by triggering another.
public	persistPreferences(name: , isDefault: ) Persists the preferences as Shared Objects when preferencePersistenceMode=client or dispatches an event with the preference information when preferencePersistenceMode=server
public	placeBottomBar() When you have left or right locked sections, the scroll bar only covers the area occupied by the body container, or the unlocked columns section.
public	placeChildComponents(components: *)
public	placeComponent(comp: *)
public	placeComponents(row: *)
public	placeSections() The grid is composed of the following sections:
public	processFilter() Processes filters at the root level.
public	processRootFilter(triggerEvent: *)
public	processSort(sorts: *) Used by state persistence to load sort settings that were persisted previously.
public	quickFind(whatToFind: ): Iterates through the data provider to get a list of row positions that match the text provided.
public	rebuildBody(vupdateTotalRecords: *) A method that simply rebuilds the body as opposed to rebuilding the entire grid.
public	rebuildFilter() A method that simply rebuilds the footer as opposed to rebuilding the entire grid.
public	rebuildFooter() A method that simply rebuilds the footer as opposed to rebuilding the entire grid.
public	rebuildHeader() A method that simply rebuilds the header as opposed to rebuilding the entire grid.
public	rebuildPager() A method that simply rebuilds the pager as opposed to rebuilding the entire grid.
public	recycleH(right: *)
public	redrawBody() A method that simply redraws the body as opposed to rebuilding the entire grid.
public	refreshCells() Calls the refresh cell method on all visible cells in the bodyContainer section.
public	refreshCheckBoxes() Updates the visible state of all row selection checkboxes and header checkboxes.
public	removeAllSorts() Removes all the sorts and calls doInvalidate.
public	removeColumn(col: *) Removes the column from the collection of columns at this level.
public	removePopup(component: *)
public	removeToolbarAction(code: *)
public	runToolbarAction(action: , currentTarget: , extendedPager: *) Runs the given toolbar action.
public	scrollToExistingRow(vsp: , scrollDown: ) Scrolls to the row that appears at the specified vertical position
public	selectText(txt: *) Selects the provided text in the currently visible cells that have the default item renderer, or if the item renderer has the selection property
public	setAdditionalFilterArgumentsFunction(value: *)
public	setCellBorderFunction(value: *)
public	setCellCustomBackgroundDrawFunction(value: *)
public	setChildData(item: , children: , level: , totalRecords: , useSelectedKeyField: *) In lazy loaded grid levels, (filterPageSortMode=server), when the user expands a level for the first time, since the data is not loaded, the level dispatches the filterPageSortChange, or itemLoad.
public	setChildrenCountField(value: *)
public	setChildrenField(value: *)
public	setColSpanFunction(value: *) A function that takes in a data object, and a column, and returns a number.
public	setColumnLevel(value: *)
public	setColumns(val: *)
public	setContextMenuShownFalse()
public	setCurrentPreferenceInfo(val: , applyPreferences: ) When enableMultiplePreferences = true, applies the given preference as the current preference.
public	setDataProvider(value: *)
public	setDisabledField(val: *)
public	setDisplayOrder(value: *)
public	setDragDropCompleteFunction(val: *)
public	setEditedItemPosition(rowIndex: , colIndex: ) Takes an object that has a rowIndex and a columnIndex property.
public	setEnableFilters(enabled: *)
public	setEnableFooters(enabled: *)
public	setEnablePaging(enabled: *)
public	setEnablePdf(enabled: *)
public	setEnablePrint(enabled: *)
public	setEnableRowNumbers(value: *)
public	setEnableSplitHeader(value: *)
public	setEnabled(value: *)
public	setErrorByKey(key: , fld: , errorMsg: *) On grids that allow for tracking errors, call this method to highlight the error using the errorRowStyle, errorContainerRowStyle, and errorMessageStyle.
public	setErrorByObject(item: , fld: , errorMsg: *) Similar to setErrorByKey, except takes the actual object that the key represents.
public	setExpandCollapseCellRenderer(val: *)
public	setExpandCollapseHeaderCellRenderer(val: *)
public	setFilterFocus(fld: ): Sets the filter at the top level.
public	setFilterFunction(value: *)
public	setFilterPageSortMode(val: *)
public	setFilterRowHeight(val: *) Sets the filter row height at the top level.
public	setFilterValue(col: , val: , triggerEvent: *) Used to set the initial value of the filter at the top level for the specified field.
public	setFilterVisible(val: *) Sets the filter row to visible at the top level.
public	setFooterRowHeight(val: *) Sets the footer row height at the top level.
public	setFooterVisible(val: *) Sets the footer row to visible at the top level.
public	setForcePagerRow(val: *)
public	setGridPreferencesInfo(val: , applyPreferences: ) Sets the multiple preferences array.
public	setGroupedColumns(val: *)
public	setHeaderRowHeight(val: *)
public	setHeaderSeperatorWidth(val: *)
public	setHeaderVisible(val: *) Sets the filter row to visible at the top level.
public	setHeight(val: Number): * Sets the height of this component
public	setHorizontalScrollPolicy(value: *)
public	setHorizontalScrollPosition(val: *)
public	setInitialSortAscending(value: *)
public	setInitialSortField(value: *)
public	setItemLoadMode(val: *)
public	setLevelRendererHeight(val: *)
public	setNestIndent(val: *)
public	setNestIndentPaddingCellRenderer(val: *)
public	setNextLevelRenderer(val: *)
public	setOpenItems(valCollection: *)
public	setOpenKeys(keys: *) For nested/grouped hierarchical datagrids, used to select records.
public	setPageIndex(val: *) Page index at the top level.
public	setPageSize(val: *)
public	setPagerCellRenderer(val: *)
public	setPagerRenderer(val: *)
public	setPagerRowHeight(val: *) Sets the pager row height at the top level.
public	setPagerVisible(val: *) Sets the pager row to visible at the top level.
public	setPredefinedFilters(filters: *) Adds to built in filters and refreshes the toolbar.
public	setPreferencePersistenceKey(val: ): String value that uniquely identifies this grid across the application.
public	setPreferences(val: *)
public	setPreferencesFromSettings(arrayCollection: *) Takes an array collection of preferences and applies them to the grid.
public	setPreservePager(value: *)
public	setResponsiveBehaviorMode(mode: *): string Responsive mode for this grid.
public	setRowDisabledFunction(value: *)
public	setRowHeight(o: *)
public	setRowSelectableFunction(value: *)
public	setRowSpanFunction(value: *) A function that takes in a data object, and a column, and returns a number.
public	setSelectAllState(val: *) Sets the selected keys for the top level.
public	setSelectableField(val: *)
public	setSelectedField(val: *)
public	setSelectedIndex(val: *)
public	setSelectedItem(val: *)
public	setSelectedItemsBasedOnSelectedField(rebuild: , openItems: ) Sets the open items on basis of the selectedField.
public	setSelectedKeyField(val: *)
public	setSelectedKeys(objects: , openItems: ) For nested/grouped hierarchical datagrids, used to select records.
public	setSelectedObjects(objects: , openItems: ) For nested/grouped hierarchical datagrids, used to select records.
public	setToolbarActionButtonProperty(toolbarActionCode: , property: , value: *) Sets a property or a style of the button object associated with the toolbar action that has the given code.
public	setToolbarActions(actions: *) Adds to toolbar actions, and refreshes the toolbar.
public	setVerticalScrollPolicy(value: *)
public	setVerticalScrollPosition(val: *)
public	setVirtualScrollDelay(value: *)
public	setWidth(val: ): Sets the width of this component
public	setupScrollTimer()
public	shiftColumns(columnToInsert: , insertBefore: , level: , movingCg: ) Inserts the column specified column before the specified column
public	showColumns(colsToShow: *) Sets the visible flag on all columns except the ones speicified in the list to false.
public	showDropIndicator(cell: *) Called to show the drop indicator below the passed in cells row.
public	showMessage(msg: *) Displays a message without the spinner label.
public	showPrintableColumns() Sets the visible flag on all columns except the ones where excludeFromPrint=true.
public	showSpinner(msg: *)
public	showToaster(message: , toasterPosition: , toasterRenderer: , animationDuration: , visibleDuration: , moveAnimate: , fadeAnimate: ): Shows the given toaster message
public	showTooltip(relativeTo: , tooltip: , dataContext: , point: , leftOffset: , topOffset: , offScreenMath: , where: , container: *) Displays a tooltip for the control in question.
public	snapToColumnWidths() Goes through all the sections and resizes the cells to match the current column widths.
public	synchronizeHorizontalScroll() Synchronizes the vertical scroll positions of the three locked sections
public	synchronizeLockedVerticalScroll() Synchronizes the vertical scroll positions of the three locked sections
public	trackChange(changedItem: , changeType: , changeLevel: , changedProperty: , previousValue: , newValue: ) Method to track a change, called by track change API to keep track of additions, deletions and modifications to the data provider.
public	updateDisplayList(unscaledWidth: , unscaledHeight: )

Public Constructors

public constructor(props: , arg1: , arg2: *) source

The constructor is responsible for instantiating the body container, header,footer,filter,pager containers, as well as the left/right Locked header/footer containers.

Override:

FlexDataGrid#constructor

Params:

Name	Type	Attribute	Description
props	*
arg1	*
arg2	*

ReactDataGrid

Extends:

See:

Example:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(props: , arg1: , arg2: *) source

Override:

Params:

Public Methods

public getAllChildren(): * source

Override:

Return:

public getClassNames(): string[] source

Override:

Return:

ReactDataGrid

Extends:

See:

Example:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(props: *, arg1: *, arg2: *) source

Override:

Params:

Public Methods

public getAllChildren(): * source

Override:

Return:

public getClassNames(): string[] source

Override:

Return:

public constructor(props: , arg1: , arg2: *) source