Pointer to the TOP level additionalFilterArgumentsFunction

Flag to enable dragging multiple rows.

The number of milliseconds to wait before issuing an autorefresh call. Defaults to 30000 (30 seconds)

Timer instance to work with the auto refresh mechanism

The main scrollable area of the grid. This is an instance of the FlexDataGridBodyContainer class, which derives from FlexDataGridContainerBase. The Body container manages renderer recycling, scrolling, expand collapse, editing, etc. The bodyContainer contains a rows collection, which is a visual representation of the current ViewPort, that is, it shows the currently visible cells based on the vertical and horizontal scroll postions. You can iterate through the currently visible cells via looping through the rows property and going through the cells collection of each RowInfo. Please note, this will only get you the currently visible cells. If you wish to access each cell as it is being initialized (or revived from a recyclable state) please wire up the rendererInitialized event on the grid.

A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns.

A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns.

Comma delimited string of the following words: edit,delete,moveTo,moveUp,moveDown,addRow,filter

Returns true of this is a nested grid, and we have not expanded to the lowest level

This property can be used as the source for data binding.

Returns true of this is a nested grid, and we have expanded to a level below 1.

This property can be used as the source for data binding.

A function that can be used to control the background color of each cell in this column. If this function is null or returns null, the cell will use the alternatingItemColors style property. This function should take a IFlexDataGridDataCell object, which has a pointer to the row data (data) as well as other related information found in the documentation of the FlexDataGridDataCell class. This function should return an array of colors for a gradient fill, or a single color hex code (uint) for a single color fill.

Pointer to the TOP level cellBorderFunction

Pointer to the TOP level cellCustomBackgroundDrawFunction

If this is defined, in addition to checking if the column is editable, this call back is called for each cell in this column to ensure that the cell is editable. This allows you to conditionally define editable flag on a cell basis.

A function that can be used to control the Text color of each cell in this column. If this function is null or returns null, the cell Text will use the alternatingTextColors style property. This function should take a IFlexDataGridDataCell object, which has a pointer to the row data (data) as well as other related information found in the documentation of the FlexDataGridDataCell class. This function should return a single color hex code (uint).

An array of ChangeInfo objects that contains all the changes made to the data provider using the grid editing mechanism.

This property can be used as the source for data binding.

Pointer to the TOP level childrenCountField

Pointer to the TOP level childrenField

Flag that controls whether or not to clear out changes when the data provider changes Defaults to true, so if you are refreshing the grid prior to savign it, set this to false.

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

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

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

Flag that controls whether or not to clear out selectedObjects and selectedKeys when the filter changes Defaults to false

Tooltip to display when user hovers over collapse icon

A function that takes in a data object, and a column, and returns a number. -1 indicates that the row should span the entire width of the grid. Please note, rowspans and col spans are only supported for data rows. Since this function is defined on the grid, it will get a IFlexDataGridCell object that you should use to return a rowSpan or colSpan.

Returns the top level columnCount

Returns the list of columns groups at the root level. The grid always has at least one column level. This is also referred to as the top level, or the root level. In flat grids (non hierarchical), this is the only level. But in nested grids, you could have any number of nested levels. The column groups collection actually belongs to the columnLevel, and since there is one root level, the column groups collection of the grid basically points to the column groups collection of this root level.

The Root Column Level. This is a property of type "FlexDataGridColumnLevel". This grid always has at least one column level. This is also referred to as the top level, or the root level. In flat grids (non hierarchical), this is the only level. But in nested grids, you could have any number of nested levels. The columns collection actually belongs to the columnLevel, and since there is one root level, the columns collection of the grid basically points to the columns collection of this root level. The FlexDataGridColumnLevel class has a "nextLevel" property, which is a pointer to another instance of the same class, or a "nextLevelRenderer" property, which is a reference to a ClassFactory the next level. Please note, currently, if you specify nextLevelRenderer, the nextLevel is ignored. This means, at the same level, you cannot have both a nested subgrid as well as a level renderer.

Returns the top level column names

Returns the list of columns at the root level. The grid always has at least one column level. This is also referred to as the top level, or the root level. In flat grids (non hierarchical), this is the only level. But in nested grids, you could have any number of nested levels. The columns collection actually belongs to the columnLevel, and since there is one root level, the columns collection of the grid basically points to the columns collection of this root level. Note : If you set the columns or the grouped columns dynamically, ensure you call grid.columnLevel.initializeLevel(grid);

This property can be used as the source for data binding.

Set to true when the context menu is shown.

A function that takes a IFlexDataGridDataCell object and returns a Number.

The cell that is the current mouse over. This could be any type of a cell, including header, footer, filter, pager or data cell. If enableActiveCellHighlight is set to true, this cell will be highlighted using the activeCellColor style property.

Return the FilterSort objects at the top level

The current tooltip object.

The current tooltip object trigger.

The data provider for the grid. Needs to be a ListCollectionView. (ArrayCollection or XMLListCollection) or a HierarchicalCollectionView.

Please note, for hierarchical data, hierarchy is setup in the Grid itself, so it is not necessary to provide a HierarchicalCollectionView in order to display Hierarchical Nested Data. Flexicious Ultimate was designed with multi Level Heterogeneous and Homogeneous Hierarchical Data in mind, so we do not have the need to implement a customized data structure to morph object graphs into nested data. We are able to consume flat ArrayCollections, and display a hierarchical UI. We provide numerous examples of this concept in our sample project.

The Grid provides the concept of "columnLevels". In fact, a non-hierarchical Flexicious Ultimate Grid is simply a grid with just one column level. Please refer to the documentation of the FlexDataGridColumnLevel class.

When you have multiple levels of data (i.e. multiple Column Levels), you can just assign a flat collection to the top level, and within the flat collection specify which property contains the next level of data, via the childrenField property.

If you specify a HierarchicalCollectionView, the grid will probe call its getChildren() method until it reaches the depth of the inner most FlexDataGridColumnLevel. If you specify an ArrayCollection, the grid uses the childrenField property to get the next level of data. If you specify an XMLListCollection, the grid calls children() method on the XML object to get the next level of data.

This property can be used as the source for data binding.

Returns the TOP level data without any filters.

This property can be used as the source for data binding.

Returns the TOP level data without any paging, but with filters.

This property can be used as the source for data binding.

A property on the object that identifies whether the object is disabled.

Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.CELL_CREATED event

Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.CELL_RENDERED event

Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.RENDERER_INITIALIZED event

A comma seperated list of the following strings: filter,header,body,footer,pager. Changes the order in which the grid displays the filter,header,body,footer,pager The order in which the various sections of the grid are laid out. Defaults to pager,filter,body,footer

The column that initiated the drag

Function to determine if the given object has children. Defaults to the defaultDynamicLevelHasChildrenFunction method of the grid. For grouped nested datagrids where the Nest Hierarchy is not known at the outset, set enableDynamicLevels to true. When the grid hits the last "predefined" level, the grid calls the dynamicLevelHasChildrenFunction function on the grid to see if there are more children. If this function returns true, a FlexDataGridColumnLevel object will automatically be created.

		 private function hasChildren(target:Object):Boolean{
		 		//your code here
		 }
		 

This property can be used as the source for data binding.

Takes an object that has a rowIndex and a columnIndex property. Finds the cell at that position, and emulates a click event on that cell. This event, in turn will begin an edit session for editable cells.

Flag to hightlight the active cell. If set to true (default) the cell under the mouse or if navigating via keyboard, the current reference cell will be highlighted with the activeCellColor style.

If flag is set to true, grid will dispatch an AUTO_REFRESH event every autoRefreshInterval milliseconds.

This property can be used as the source for data binding.

Flag to enable column header operations.

Added in 2.9 to force columns to take the widths that the user specified. Once the user resizes the column, the column widths basically are set to "fixed".

Flag to enable the context menu copy items. If set to true, three custom context menu items will be added. 1) The copy Cell context menu item, text controlled via the copyCellMenuText property. Will call itemToLabel on the column associated with the current cell under the mouse passing in the rowData object of the rowInfo. 2) The copy Row context menu item, text controlled via the copyRowMenuText property. Will call itemToLabel on all the visible columns associated with the level of the current cell under the mouse passing in the rowData object of the rowInfo. 3) The copy All Rows context menu item, text controlled via the copyAllRowsMenuText property. Will basically perform a inbuilt export to TXT The result of the copy operation is pasted to the clipboard

Flag to turn on the highly optimized FlexDataGridDataCell3. FlexDataGridDataCell3 is a light weight class introduced in Flexicious 2.7, that renders 30% faster than its predecessor, FlexDataGridDataCell2. Since it is very lightweight, it only supports the basics of text rendering, like fontFamily, fontSize, fontWeight, fontStyle ,color, background, textAlign, and textDecoration. In most cases, this covers the range of things that a typical application developer needs. But incase you need advanced text capabilities, like TLF fonts, RTL, etc, you may need to turn off this flag either on the grid, or on specific columns that you need advanced features on. Once FDG3 is fully settled in the field, this flag will be removed and we will retire FDGC2. As of right now, the FDGC3 cannot handle wordwrap, doubleclick, truncateToFit, handCursor. The grid automatically swaps out the FDG3 with FDG when you set any of these flags. If you notice any inconsistency when you enable this flag, you can turn this same flag off for the column that you notice the inconsistency on, and the grid will fall back to the older mechanism to display that column. Please send a message to support

By default, the grid draws a set of expand collapse icons on the left locked section. In case when you have a column with enableExpandCollapseIcon=true, you may choose to set this flag to false.

Added in 2.9 to avoid multiple change events from firing.

Flag to enable edit on doubleclick as opposed to single click. Editable columns begin edit when the user clicks on their cells. In cases where you have a cell based selection mode, this conflicts with the user gesture of selecting a cell. In scenarios like this, you may wish to set enableDoubleClickEdit=true

The default value is false.

A flag to disable the double click timer mechanism. When the user double clicks on a row, it typically has the net effect of 2 clicks, which selects and then unselects that row. To combat this, we have a timer that discards the second click. However, in scenarios where this is not the desired behavior, you can set this flag to false, and the timer will no longer execute.

When enableVirtualScroll=true, setting this to true will cause each scroll event to issue a server request.. When this is set to false, the grid will only dispatch a virtualScroll event when the uses pauses scroll, as opposed to continuously as they scroll.

The default value is false.

Flag to enable creation of the next level dynamically as the hierarchy is set. For grouped nested datagrids where the Nest Hierarchy is not known at the outset, set this to true. When the grid hits the last "predefined" level, it calls the dynamicLevelHasChildrenFunction function on the grid to see if there are more children. If this function returns true, a FlexDataGridColumnLevel object will automatically be created. This level will be a clone of the base level.

The default value is false.

By default, the grid renders when the dataprovider is set. This might lead to a blank area being shown while the data is being fetched. If you set this flag to true, the grid will draw the columns, filter, pager, etc and then re-render when the data is fetched. This might add to the overall render time, but would be a better user experience if there is a slower backed with a significant lag in data load time. For faster backends, it is recommended that this flag remain false, for slower backends, it should be set to true. It is also recommended that you set the showSpinnerOnFilterPageSort flag to true, so a spinning animation will be shown while the data is being fetched.

Flag to hightlight the edit row. If set to true (default) the edit row will be highlighted with the editItemColors style.

Flag to enable export to word and excel.

By default, for performance reasons, the grid will only draw one large row to fill up the bottom in case that the grid is taller than the sum of the row heights. However, for consistency with the MX grids, setting this property to true will cause the grid to draw blank rows similar to the other data rows.