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. The function must take a column level as the only parameter, and return an array collection of the filter expressions.

A function that lets you control the border drawing mechanism for each cell. By default, each cell will draw a 1px wide line to its right and bottom ends. This function offers you the opportunity to hook into this mechanism, and draw your own border using the graphics property of the FlexDataGridCell object, that is passed in as a parameter to this function. If this function returns false, the default border is not drawn.

A function that lets you control the background drawing mechanism for each cell. By default, each cell will draw a background on basis of the XXXXColors style property and XXXXRollOverColors style property, where XXXX= header,filter,pager,footer,renderer or blank. This function offers you the opportunity to hook into this mechanism, and draw your own background using the graphics property of the FlexDataGridCell object, that is passed in as a parameter to this function. If this function returns false, the default background is not drawn.

A property on the object that identifies if the object has children. Only needed in filterPageSortMode=server In lazy loaded (filterPageSortMode=server) hierarchical grids levels, the child level items are loaded when the user actually expands this level for the first time. In scenarios where it is known initially that there are children, set this property to the value of the object that identifies whether there are children. If this property is set, the expand collapse icon will be drawn only when the value of this property on the object returns an integer greater than zero. Otherwise, the level will always draw the expand collapse icon.

The property of the parent level object, that identifies the children that should be displayed on the next level. This is only required if the collection is not a hierarchical view. Please note, in server mode, this property is also the "storage" for the lazy loaded children. See the Partially and Lazy Loaded Server Grid examples for more details

Childs groups, if any.

Gets the level that is the ultimate column owner.

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);

The number of records to inspect to identify the max size of the data in the column when columnWidthMode=fitToContent. When you have very large datasets, it will be very slow if you inspect every row to identify the largest string to come up with the column width. So we inspect only the first columnWidthModeFitToContentSampleSize rows.

The default value is 100.

A List of FilterSort objects, for multi column sort support.

Gets nestindent recursively

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

A comma separated 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

Flag that indicates whether or not to show the filter

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

Flag that indicates whether or not to show the footer

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

Returns true if the nest depth is 1 and grid as the enableMultiColumnSort field enabled.

Flag to indicate whether or not to enable paging functionality

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

Flag to embed a column that shows row numbers.

Container for the expand collapse cell. Needs to inherit from FlexDataGridExpandCollapseCell. Defaults to FlexDataGridExpandCollapseCell

Container for the expand collapse cell. Needs to inherit from FlexDataGridExpandCollapseHeaderCell. Defaults to FlexDataGridExpandCollapseHeaderCell

In addition to the filter row, if you wish to apply external filters, or to apply filters at inner nested levels, you may use this property. Works just like ListCollectionView.filterFunction

Same as filterRowHeight, except no built in logic to handle enableFilters and filterVisible.

The Filter/Page/Sort Mode. Can be either "server" or "client". In client mode, the grid will take care of paging, sorting and filtering once the dataprovider is set. In server mode, the grid will fire a com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent named filterPageSortChange that should be used to construct an appropriate query to be sent to the backend.

The default value is "client".

See also

Height of the filter for this level. Defaults to 25

If you have enableFilters set to true but want the filter row to not appear, you can set this value.

Columns where wordWrap=true || variableRowHeightUseRendererForCalculation and itemRenderer not null

ColumnGroups where wordWrap=true || variableRowHeightUseRendererForCalculation and columnGroupRenderer is not null

Columns where wordWrap=true || variableRowHeightUseRendererForCalculation and headerRenderer is not null

Height of the footer for this level. Defaults to 25

If you have enableFooters set to true but want the footer row to not appear, you can set this value.

Use this flag to show the pager control even if the enablePaging is set to false. This is used in a scenario where you wish to show buttons other than the paging buttons in the pager bar.

The owner grid.

Grouped columns - only supported at the top level.

Flag to set if column groups exist

Height of the header for this level. Defaults to 25

Width to show the resize indicator between columns. Defaults to 4

Whether or not to show the header row

If true, initial sort direction for this level is ascending. Defaults to true.

The property of the object on this level that should be used in the default sort.

Returns true if filterPageSortMode==client.

Returns true if itemLoadMode==client.

The Item Load Mode. Can be either "server" or "client". In client mode, the grid will assume that the children of items at this level are prefreched. In server mode, the grid will dispatch a ITEM_LOAD event (itemLoad) that should be used to construct an appropriate query to be sent to the backend, to retrieve the child objects at this level. Once the results are retrieved, please call the "setChildData" method on the grid to set the results at this level. Please note, the "childrenField" is still required at this level, because that is where the setChildData method persists the loaded children. Future itemOpen events do not result in itemLoads because the data for this particular entity has already been loaded and persisted.

The default value is "client".

Gets all left locked columns

Gets the sum of left lock column widths

Friendly name for the level. Not a required field

Height to assign to the renderer for each level. If not specified, a new instance of the level renderer is created, and the height is defaulted to the height of that one instance. The same height is then reused for subsequent renderers of the same type.

Gets the max disclosure cell width.

Gets the width of the padding cell.

minimu header height

How deep in the nesting hierarchy is this item. Starts at 1 for the columnLevel that belongs to the grid.

he indentation to apply to each progressive nest level.

The default value is 15.

Container for the nest indent padding cell. Needs to inherit from FlexDataGridExpandCollapseHeaderCell. Defaults to FlexDataGridExpandCollapseCell

The inner content of the padding cell. Defaults to a plain old UI component

Declaration of the next level of columns

A renderer that displays this level. If you specify a value for this, the columns are ignored, and instead of drawing a nested data grid at this level, an instance of the levelRenderer is displayed. All paging, footers, headers and other properties related to hierarchical display are also ignored. A level that has a levelRenderer cannot have subsequent levels. So, this is usually the innermost level. Please ensure that you explictly specify a levelRendererHeight so the vertical height of the grid can be correctly calculated.

Container for the footer renderer. Needs to inherit from FlexDataGridPagerCell. Defaults to FlexDataGridPagerCell

Same as pagerRowHeight, except no built in logic to handle enableFilters and filterVisible.

See also

A Class that implements com.flexicious.controls.interfaces.IPager. Defaults to a built in implementation

See also

The height of the pager row. If not set, defaults to the value of the rowHeight property

If you have enablePaging set to true but want the pager row to not appear, you can set this value.

The number of records to display per page

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

A property that points to the parent object Used in conjunction with enableSelectionBubble property on the grid.

The parent level for this level. For the root level, this is null.

Setting this flag to true will resuse the columns from the previous level. Set this flag to true if you want the grid to behave like the advanced datagrid, where there is one set of columns for hierarchical data.

Gets all right locked columns

A function that can be used to control the background color of each cell in this level. If this function is null or returns null, the cell background 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.

A function that can be used to control the enabled flag of each cell in this level. If this function is null or returns null, the cell will be enabled, selectable, and rollovers will work. If this function returns false, the cell will not be selectable, the item renderers will be disabled and it will have no rollovers. This function has two parameters: 1) IFlexDataGridDataCell : Cell 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 parameter can be null, when the function is called as a response to a higher level checkbox select. For example, when the user hits select all. In this case, we do not always have a cell, and it will be passed in as null 2) The actual data object bound to the row. This function should true or false. For example: private function rowDisabledFunction(cell:FlexDataGridCell,data:Object):Boolean{ return data.enabledl }

Height of the row for this level. Defaults to 25

A function that can be used to control whether clicking on any cell in this level will select it. If this function is null or returns false, clicking on the cell will not result in the row being selected. If this function returns true, clicking on the cell will result in the row being selected in row selection modes only. This function has two parameters: 1) IFlexDataGridDataCell : Cell object which has a pointer to the row data (data) as well as other related information found in the documentation of the IFlexDataGridDataCell class. This parameter can be null, when the function is called as a response to a higher level checkbox select. For example, when the user hits select all. In this case, we do not always have a cell, and it will be passed in as null 2) The actual data object bound to the row. This function should true or false. For example: private function rowSelectableFunction(cell:FlexDataGridCell,data:Object):Boolean{ return data.enabled; }

A function that can be used to control the text color of each cell in this level. 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. This function should return a single color hex code (uint).

The inner content of the scroll bar pad cell. Defaults to a plain old UI component

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

A list of CellInfo objects. When grid.selectionMode=SINGLE_CELL, this collection contains only one item

A field on the dataprovider that indicates that this item should be selected

Returns the first item from the selectedObjects collection, if one exists at this level. If there is none, then returns the selectedItem collection of the next level.

A property on the object that identifies the object uniquely. Similar to a surrogate key, or a business key, as long as it uniquely identifies the object. When this property is set, the selected keys returns the ID values of the objects that were selected. When a row is selected in the grid, we store the selectedKeyField property of the selected object in this array collection. This allows for multiple pages of data that comes down from the server and not maintained in memory to still keep track of the ids that were selected on other pages.

A list of ID values, based on the selectedKeyField property. When a row is selected in the grid, we store the selectedKeyField property of the selected object in this array collection. This allows for multiple pages of data that comes down from the server and not maintained in memory to still keep track of the ids that were selected on other pages.

This array is a list of all items that are have been selected by the user or programmatically, at this level. Please note, for hierarchical grids, each level has its own collection of selected keys. The grid.selectedObjects returns the selectedKeys at the top level. To access the selected keys at a lower level, you may navigate to that level using grid.columnLevel.nextLevel...nextLevel.selectedKeys You can also call grid.getSelectedObjects to get selected objects at all levels.

For 3.5 Compatibility

Gets all unlocked columns

Gets the sum of left lock column widths

When grid.enableSelectionExclusion is set to true, a list of items that the user explicitly unselected is stored here.

Adds the column to the collection of columns at this level. Deprecated. Use columns setter instead. var cols:Array=level.columns; //manipulate cols level.columns=cols;

Parameters

Parameters

For multi column sort support.

Parameters

Parameters

Once we have the widest width, since we dont want the grid to appear jagged in multi levels Adjust all columns where the widths are same so it looks like a contiguous rectangle. If the equally parameter is set to true, it will sum up the total column widths, and resize them all equally.

Parameters

Given a column and a dataprovider, measures the width required to render the text in the column, and if such width is greater than the minwidth of the column, applies that width to the column

Parameters

For header checkbox state, returns if all items in the grid are selected.

Parameters

Returns true if there is atleast one item in the selected keys collection for this level, or if the next level uses this levels columns, then the selected keys collection for the next level.

Parameters

Parameters

For columns with headerWordWrap, calculates the height required to display text in full.

Applies the passed in value to the provided property and cascades that value down to the next level, if one exists.

Parameters

Checks disabled flag.

Parameters

IF rowSelectableFunction is specified, returns result of that. If selectableField is specified, returns value of that on the obj object Else returns true

Parameters

Clears out all the columns of the grid If the parameter to rebuild is true, the grid will be rebuilt. Otherwise, just the columns will be cleared, and the consumer code should rebuild the grid.

Parameters

Removes the filter at this level, and all of this child levels, if specified.

Parameters

Clears the selected rows and cells.

Parameters

Creates a new instance of this level, transfers all its primitive and factory properties to the new instance, creates a clone collection of all its columns, transfers the non primitive and factory properties of the columns to the cloned columns and returns the new instance.

Parameters

Parameters

Returns the filter for this level

Parameters

Parameters

Whenever a tree datagrid event is dispatched at any level, we also dispatch it from the top level grid so if someone wants to listen for an event at all levels...

Parameters

Modifies the columns so the width is distributed equally. Columns that are fixedWidth are not updated.

If the grid's horizontal scroll policy is off, then returns the width of the unlocked section minus the width of the scroll bar else returns the sum of all column widths.

Parameters

If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object. Else returns the value of the level.childrenField property on the object being passed in

Parameters

Calls getChildren, and if result is XML or XMLList, returns length() else returns length;

Parameters

eturns the column with the specified datafield

Parameters

eturns the column with the specified UniqueIdentifier

Parameters

Returns the column groups specified at the level cgLevel.

Parameters

List of visible columns of the specified lock modes.

Parameters

Parameters

All visible columns where excludeFromExport=false

Parameters

Gets the list of filter arguments at this level.

Provided an item key, loops through the data provider, and finds the item with the provided key.

Parameters

If there is a selected key field (usually a field that uniquely identifies an object) returns the value of the selectedKeyField property of the item else returns the item itself. If saveLevel is set to true, returns a string in the format key|levelNestDepth. Use this in cases where you wish to refresh the grid with new data from the server and open items should only refer to the keys so the open state can be persisted across server roundtrips.

Parameters

Get the maximum depth of column groups.

Get the maximum depth or height of column groups.

Parameters

Parameters

A list of ID values, based on the selectedKeyField property. For hierarchical datagrids, used to get all open(expanded) records at all levels. Please NOTE - this is a read only collection. Adding to this does nothing. If you want to programatically modify the collapse expand, use the setOpenKeys instead, or add directly to the open items.

Parameters

All visible columns where excludeFromPrint=false

Parameters

Gets the height of the header, footer, pager if visible.

Parameters

If all items are selected, returns TriStateCheckBox.STATE_CHECKED. If none are selected, returns TriStateCheckBox.STATE_UNCHECKED else returns TriStateCheckBox.STATE_MIDDLE

Parameters

For nested datagrids, used to get all records at all levels

Parameters

ll columns that can be "hidden"

Parameters

All visible columns where sortable=true

Gets the index at which the given column appears in the sort list.

Parameters

If a value exists for a style property at the level return it, else return the value of the property at the grid level.

Parameters

Gets the sum of all column widths.

Parameters

If value is primitive, does a tostring, if XMLList, returns the text.

Parameters

All columns where visible=true and lock modes match the specified lock modes.

Parameters

Parameters

Returns the widest right locked width.

Parameters

At each level, get the sum of column widths, and return the width at the level with the widest width. Only includes locked columns by default.

Parameters

Returns true if the given column is already in the sort

Parameters

Returns true if the CellInfo for the specified item and column exists in the selectedCells collection.

Parameters

Provided an item or a key, and a flag that indicates what it is, returns true if the item matches the respective comparison.

Parameters

Returns true if the getItemKey for the specified item exists in the selectedKeys collection.

Parameters

Returns true if the getItemKey for the specified item exists in the selectedKeys collection.

Parameters

Returns true if the getItemKey for the specified item exists in the selectedKeys collection.

Parameters

Parameters

Removes all the sorts and calls doInvalidate.

Removes the column from the collection of columns at this level.

Parameters

Selects or unselects everything

Parameters

elects or unselects a cell

Parameters

Parameters

Selects or unselects a row - please note that the level that you call this method on should correspond to the item that you are selecting, in other words, if you are selecting an item at level 2 (child of the top level records) then you should call it on the second level, i.e. grid.columnLevel.nextLevel.selctRow(...

Parameters

Goes through the unlocked columns, figures out the widest width needed by each of the columns by going through the data provider, and sets the width accordingly. If the equally parameter is set to true, all column settings are ignored, and the grid's width is distributed equally across all columns Below is a description of the logic used:

Parameters

Clears out the current sort collection and sets it to the passed in values

Parameters

Sets the open keys at this level.

Parameters

Iterates through items, checks to see if the selected bit is on, and if so, adds it to the open list.

Parameters

For nested/grouped hierarchical datagrids, used to select records. Iterates through the data provider, matching each object, and if matches, adds the object to the selectedObjects for the level

Parameters

Sets the selected state at this level. If you specify checked, adds all rows to the selected keys collection.

Parameters

For nested/grouped hierarchical datagrids, used to select records. Iterates through the data provider, matching each object, and if matches, adds the object to the selectedObjects for the level

Parameters

Inserts the column specified column before the specified column

Parameters

Sets the visible flag on all columns except the ones specified in the list to false.

Parameters

Sets the visible flag on all columns except the ones where excludeFromPrint=true.

Parameters

Parameters

Dispatched when row selection or cell selection changes.

ispatched when the columns at this level are resized

Dispatched when the grid's page, sort or filter state changes. Also Dispatched when an item, that was not previously opened is opened. Used in lazy loaded (filterPageSortMode=server) grids, to load a specific page of data from the backend.

Dispatched when any header cell is clicked

Dispatched when user clicks on a row in row selection mode or cell in cell selection mode

Dispatched when an item opens, both in server and client mode

Dispatched when user double clicks on a row in row selection mode or cell in cell selection mode

Dispatched when the editor is instantiated.