flexiciousNmsp.FlexDataGrid Class

Extends NdgBase

FlexDataGrid is the class name for HTMLTreeGrid, a DataGrid component built from the ground up to cater to the needs of UI developers who create complex Line of Business applications.

Flexicious Ultimate attempts to bring to you a Single Grid, that incorporates all these features in one.

Ability to organize information as rows and columns, with locked headers
Ability to Customize the appearance Rows and Columns
Inline Editing, Customizable Editors, with validation hooks
User Interactive, Draggable, Resizable, Sortable and Editable Columns
Fully Configurable Drag and Drop
Keyboard Navigation
Multi Column Sort
Multi Level, Expand Collapse enabled Grouped Column Headers
Single Cell, Single Row, Multiple Cell, Multiple Row selection modes.
Support for UI skinning via styles, factories, as well as programmatic control
Display of Homogenous Hierarchical Data (Single Set Of Columns)
Inline Filtering, with numerous built in Filter Controls, and extensible architecture to define your own.
Server and Client based Paging, with a fully Customizable Pager UI.
Summary Footers, with fine tuned control over Formula, Precision, Formatting, Placement and Rendering of Footers.
Print
Ability to Export to Excel, Word, Text, XML and other formats. Ability to plug in your own Exporters
Preference Persistence (Ability for your end users to save viewing preferences)
CheckBox based selection of data, with Tri State CheckBox Header
Customizable loading Animation
Smooth Scrolling
Display of Heterogonous Hierarchical Data (Multiple Sets Of Columns)
Ability to define paging, filtering and summary footers at each hierarchical level
Ability to define Fully Lazy Loaded, Partially Lazy Loaded and Initial Loaded Flat as well as Hierarchical Data Grids.
Left and Right Locked columns
A vast number of Business Scenarios supported out of the box:

Cascading of row selection for hierarchical data
Ability to control whether or not rows with no children are shown (For grouped entries)
Drill Down/Drill Up/Drill To of Hierarchical data
Toolbar action icons, with ability to define custom actions
Ability to define initial sort values at any level
Ability to programmatically navigate to a row
Ability to show custom tooltip on hover over
Ability to fully customize sizes, borders, backgrounds, and styles for any cell programmatically as well as via CSS
Ability to define custom logic that control row selection, enabled, background, border.
Auto adjustment of the height on basis of the number of rows displayed
Read write nested properties of complex objects
Automatic column width adjustment on basis of data
Context menu based copying of data rows
Ability to define various column width modes, like fitToContent, Percentage and Fixed

Constructor

`flexiciousNmsp.FlexDataGrid`

()

Index
Methods
Properties
Events

Item Index

Methods

`addColumn`

()

Adds the column to the collection of columns at the root level.

`addComponent`

()

`addEventListener`

()

`addRemoveFromOpenItems`

()

`addSelectedItem`

(

val

)

Adds the provided item to the selection of the top (root) level.

Parameters:

val Object

`buildFromXml`

()

The main method that parses the configuration XML and builds the FlexDataGrid

`calculateRowHeight`

(

item
level
rowType

)

If variableRowHeight returns the minimum height required to display text of each column without clipping. Please note, atleast one column needs to have the wordWrap flag set to true. If you use custom item rendereres, these are not accounted for in the height measurement for performance reasons. In this case, you should override the getRowHeight method and provide your own implementation which is optimized for your situation.

Parameters:

item Object

The item being displayed
level Object

The FlexDataGridColumnLevel object that the item belongs to
rowType Object

The type of the row, one of the RowPositionInfo.ROW_TYPE_XXXX constants

Returns:

Height of the row

`cascadeColumnGroups`

()

`checkGetterAndRetrieve`

()

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,

`checkNoDataMessage`

()

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.

`checkResize`

()

Check for changes to the div that holds us. HTML does not have a resize event, so we have to periodically inspect the dom element to see if there were any changes to the container size.

`checkSetterAndApply`

()

Checks to see if there is a setter by the name provided, and if so use that, else apply as a property

`clearAllCollections`

()

Clears out the following collections

All Open Items
All Errors
Selection (only if clearSelectionOnDataProviderChange==true)
Some internal housekeeping collections

`clearPreferences`

()

`clearSelection`

()

Clears the selected rows and cells.

`collapseAll`

()

()

Returns the top level filter.

`createLockedContent`

()

Method to create an instance of the LockedContent class. In case you need to implement custom logic by extending the LockedContent you will need to override this method. The Left Locked Header, Left Locked Footer,Right Locked Header, and Right Locked Footer are all instance of LockedContent

`createPrintComponentFactory`

()

Gets the class responsible for handling the PrintUI should be a IPrintDataGrid

Returns:

`defaultDynamicLevelHasChildrenFunction`

(

item

)

Returns true if the getLength method on the result of the getChildren method returns more than 0

Parameters:

item Object

Default handler for the Word Export Button. Calls ExtendedExportController.instance().doexport(this.grid,ExportOptions.create(ExportOptions.DOC_EXPORT))

`dispatchAutoRefreshEvent`

(

event

)

Handle for the auto refresh.

Parameters:

event Object

`dispatchEvent`

()

`distributeColumnWidthsEqually`

()

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

`dragAcceptReject`

()

Called when the drag enters over a cell. Use the dropAcceptRejectFunction to control behavior

`dragBegin`

(

event

)

Triggered when drag is starting. Use the dragAvailableFunction to control whether drag proceeds

Parameters:

event Object

`dragComplete`

()

Triggered when the drag is complete. Does nothing. Use the dragDropCompleteFunction to wire up custom logic.

`dragDrop`

(

event

)

Called when the DragDrop event is dispatched over any of the cells. The event is passes in as is.

Parameters:

event Object

`dragDropInternal`

()

`dragEnter`

(

event

)

Called when the DragEnter event is dispatched over any of the cells. The event is passes in as is.

Parameters:

event Object

`dragEnterInternal`

()

`drawDefaultSeperators`

()

`drawFiller`

()

When enableFillerRows=true, wipes out and recreates the filler rows. The grid automatically calls this method when any column widths change, dataprovider changes, size changes, or when expand/collapse happen.

`drawFillerCell`

()

`enableDisableToolbarAction`

()

In addition to initial enable/disable of toolbar actions, this function can be used to enable or disable toolbar actions at run time.

`ensureLevelsCreated`

()

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.

`expandAll`

()

For nested datagrids, expands all items one level down

`expandAllColumnGroups`

()

For grids with column groups, expands them all.

`expandChildrenOf`

(

item
open
level

)

Opens or closes all the nodes of the navigation tree below the specified item.

Parameters:

item Object

An Object defining the branch node. This Object contains the data provider element for the branch node.
open Object

Specify true to open the items, and false to close them.
level Object

Level at which the item exists. If null is specified, defaults to the top level

`expandDown`

()

For nested datagrids, expands all items one level down

`expandToLevel`

()

For nested datagrids, expands all items to the level specified.

`expandUp`

()

For nested datagrids, expands all items one level up

`extractAction`

()

`extractAction`

()

`extractActionFromObject`

()

Method to extract action. Unused

`extractActions`

()

`extractCol`

()

`extractColGroup`

()

`extractColumns`

()

Method to extact column information from XML

`extractFilters`

()

Code to extract filters. Has logic to extract date ranges, etc

`extractLevel`

()

Method to extract level information from xml

`flatten`

(

depthRequested
inclusive
filter
page
sort
max
dic

)

For hierarchical data grids, returns the data provider as a flat list that matches the specified criteria.

Parameters:

depthRequested Object

The depth until which to recurse.
inclusive Object

Whether to add the parent object to the resulting
filter Object

Whether to run filter while getting children of parent objects
page Object

Whether to page while getting children of parent objects
sort Object

Whether to sort while getting children of parent objects
max Object

The maximum number of records to return
dic Object

Returns:

`flattenRecursive`

()

`generateImageForDrag`

(

cell

)

Generates a snapshot of the row for the drag visual indicator

Parameters:

cell Object

Returns:

`getActionByCode`

(

code

)

Given a code, loops through the toolbarActions, and gets the toolbar action with the given code.

Parameters:

code Object

Returns:

`getAdditionalFilterArgumentsFunction`

()

Pointer to the TOP level additionalFilterArgumentsFunction

`getAllErrorString`

()

Returns an object that has the error information for the passed in object.

(

data
column

)

Given a data object and a colum, return the IFlexDataGridDataCell object for the combination

Parameters:

data Object

The row data
column Object

The FlexDataGridColumn

`getCellInDirection`

(

cell
direction

)

Gets the cell in the specified direction of the provided cell

Parameters:

cell Object

The cell to start searching at.
direction Object

The direction to search. Should be one of FlexDataGrid.CELL_POSITION_XXXX constants

Returns:

The cell, if one matches the provided criteria, or null

`getChanges`

()

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

`getChildren`

()

If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object. If object is XMLList or XML, returns the result of its "children" method. Else returns the value of the level.childrenField property on the object being passed in

Prior to returning, applies filter, page or sort as specified by the parameters. You can intercept calls to this function by defining a custom getChildrenFunction

`getChildrenCountField`

()

Pointer to the TOP level childrenCountField

`getChildrenField`

()

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

`getChildrenLength`

()

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

`getColSpanFunction`

()

`getColumnNames`

()

Returns the top level column names

`getColumns`

()

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.getColumnLevel().initializeLevel(grid);

`getContainerForCell`

(

cell

)

Given a IFlexDataGridCell, returns a container that holds that cell.

Parameters:

cell Object

The IFlexDataGridCell object to get the container for.

Returns:

The container that holds the provided cell. Can be either one of the below:

headerContainer
filterContainer
footerContainer
pagerContainer
bodyContainer

`getContainerInDirection`

(

container
up

)

Returns the section above or below the provided section. Based on the displayOrder property, the grid will stack the various sections in order specified by the user. This method uses the displayOrder property to figure out which container exists above or below the specified section.

Parameters:

container Object

Name of the section. Must be one of the displayOrder strings (filter,header,body,footer,pager).
up Object

Whether to return the section above or below

Returns:

A FlexDataGridContainerBase object

`getContainerName`

(

container

)

Given a container, returns its displayOrder string equivalent. Based on the displayOrder property, the grid will stack the various sections in order specified by the user. This method uses the takes a container and returns the associated displayOrder property. Container Should be one of the following:

headerContainer
filterContainer
footerContainer
pagerContainer
bodyContainer

Will return one of the following:

header
filter
footer
pager
body

Parameters:

container Object

The container to look for.

)

Called by PrintController and ExportController to get the data on basis of PrintOptions and ExportOptions

Parameters:

[printOptions] PrintOptions optional

`getDataProvider`

()

The data provider for the grid. Needs to be an Array. We provide examples in the sample project to convert XML to Json. See flexiciousNmsp.xml2json

Please note, for hierarchical data, hierarchy is setup in the Grid itself, so HTMLTreeGrid 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 Array, 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.

`getDataProviderNoFilters`

()

Returns the TOP level data without any filters.

`getDataProviderNoPaging`

`getEnablePaging`

()

`getFilterValue`

()

`getFilterVisible`

()

Returns true if the filter row is visible at the top level.

`getFilterX`

()

Used by filter to identify where relative position for each control for tabbing

`getFooterContainer`

()

The container for the footer cells. This is an instance of the FlexDataGridHeaderContainer class. This class manages cell initialization, recycling, mouse events on each cell, etc. The rows collection of this object will aways contain a single RowInfo object, which has a cells collection. This will be a series of ComponentInfo objects, which has a component property that will be an instance of FlexDataGridFooterCell Although the parent property of each of the cells could be either the leftLockedFooter, rightLockedFooteror the footerContainer, the rowInfo is the same, so the cells will include left, right, and unlocked cells.

`getFooterRowHeight`

()

Returns the sum of:
If enableFooters, then footerRowHeight else 0

Returns:

`getFooterRows`

()

Returns an array of RowInfo objects in the footer row.

()

Returns the list of groupedColumns 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 groupedColumns collection actually belongs to the columnLevel, and since there is one root level, the groupedColumns collection of the grid basically points to the groupedColumns collection of this root level. Note : If you set the columns or the grouped columns dynamically, ensure you call grid.getColumnLevel().initializeLevel(grid);

()

The container for the header cells. This is an instance of the FlexDataGridHeaderContainer class. This class manages cell initialization, recycling, mouse events on each cell, etc. The rows collection of this object will aways contain a single RowInfo object, which has a cells collection. This will be a series of ComponentInfo objects, which has a component property that will be an instance of FlexDataGridHeaderCell Although the parent property of each of the cells could be either the leftLockedHeader, rightLockedHeader or the headerContainer, the rowInfo is the same, so the cells will include left, right, and unlocked cells.

`getHeaderRowHeight`

()

Pointer to the TOP level headerHeight

`getHeaderSectionHeight`

()

()

Whether or not to show the horizontal scroll bar.

()

Returns the RowPosition Info object for the item at the given vertical scroll position

`getItemFilter`

()

()

If arr is XML or XMLList, returns length() else returns length;

`getLevel`

()

Returns FlexDataGridColumnLevel object at the specified depth

`getLevelForItem`

()

Provided an item, loops through the data provider, and finds the level associated with the provided item. Let the level and flat be null.

`getLevelRendererHeight`

()

Pointer to the TOP level levelRendererHeight

`getLocalName`

(

node

)

| String |

IE does not know localName, it knows baseName.

Parameters:

node Object

Returns:

| String | :

`getLockedColumnCount`

()

Unused/Not Applicable. For legacy purposes only

`getLockedColumnWidth`

()

Unused/Not Applicable. For legacy purposes only. For flexicious Ultimate, the columnLockMode is set on the FlexDataGridColumn object itself.

`getMaxDepth`

()

Returns the max depth possible for nested datagrids

`getMaxHorizontalScrollPosition`

()

The max horizontal scroll position of the bodyContainer

Returns:

`getMultiSortRenderer`

()

A Class that is responsible for the multi column sort view. Defaults to MultiColumnSortRenderer. You can provide your own implementation by specifying a custom MultiColumnSortRenderer.

`getNamedContainer`

()

Given a displayOrder string , returns its container equivalent. Based on the displayOrder property, the grid will stack the various sections in order specified by the user. This method uses the takes a displayOrder string and returns the associated container. Display Order String Should be one of the following:

header
filter
footer
pager
body

Will return one of the following:

headerContainer
filterContainer
footerContainer
pagerContainer
bodyContainer

`getNestIndent`

()

cell Object

The cell to check

Returns:

integer

`getOpenItems`

()

A list of items that the user has opened. Only applicable grids with nested column levels. If you programatically modify this collection, call the rebuild method. Please see the documentation of setOpenKeys for instructions on maintaining grid expand/collapse state post a data provider refresh.

`getOpenKeys`

()

()

Returns the pager control at the root level.

()

()

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.

`getPrintableColumns`

()

`getPrintableColumns`

()

Returns the columns where excludeFromPrint=false

`getprintExportData`

()

This is not used.

Returns:

`getRecursiveOpenItemCount`

()

()

Returns the maximum width of right locked columns. If there are multiple levels, goes through each of the levels and gets the maximum

`getRootFilter`

()

Gets the filter at the root level

`getRootFlat`

()

Returns a iterable representation of the dataprovider. If it is a hierarchical collection view, returns the source property of the underlying Hierarchical Data object else returns dataprovider as is.

`getRowCount`

()

Returns the number of rows currently visible.

`getRowDisabledFunction`

()

`getRowHeight`

()

Height of the row for this level. Defaults to 25

`getRowSelectableFunction`

()

`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.

Parameters:

cell Object

Returns:

`getRowSpanFunction`

()

A function that takes in a data object, and a column, and returns a number. -1 indicates that the row should span the entire height of the grid. Please note, rowspans and col spans are only supported for data rows.

`getRowText`

(

event

)

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. Converts an objects properties into tab delimited format

Parameters:

event Object

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. This allows for multiple pages of data that comes down from the server and not maintained in memory to still keep track of the objects that were selected on other pages.
Second, Flexicious Ultimate supports ID based selection (by using selectedKeyField). The selectedKeyField is used for object equality. So for example, if the user selects a record with ID 1, and the grid's data provider is later refreshed with new data from the backend, the grid will maintain the selection if you specify a selectedKeyField which points to the ID (usually the surrogate key) in the database. This is also used to maintain collapse/expand state in hierarchical grids.
Third, Flexicious Ultimate supports bubbling and cascading selection information. So in hierarchical datagrids, if you set enableSelectionCascade=true, the grid will automatically select all children when a parent is selected. If you set enableSelectionBubble, the grid will select the parent if all its children are selected.
Fourth, Flexicious Ultimate supports selection based on exclusion. This is applicable for virtual scroll, where there are large amounts of data, (potentially millions of rows), and the user navigates through these large numbers of records. In this scenario where you have lazy loaded grids, selection cascade and select all will simply set flags on the selectionInfo object. The selectedObjects and selectedKeys no longer contain references to data that is selected Instead, they contain the items that the user explicitly selected. unSelectedObjects will contain items that the user explicitly unselected. This helps maintain selection across very large lazy loaded datasets. When you set the enableSelectionExclusion flag to true, use the selectionInfo object to access the selection (or build a query on the server) to identify the objects user selected.

There are a number of properties and methods that help with manipulation and interaction with selection.

grid.selectedObjects and level.selectedObjects: A list of selected objects from the data provider. This is the sdk equivalent of selectedItems. We do not have selectedItems, but selectedObjects will almost always be the same as selectedItems. The only exception is when you use server side paging. In this case, selectedObjects will contain all the items selected, on all pages. grid.selectedObjects implicity returns selectedObjects at the top level. level.selectedObjects will return all the selected objects (regardless of parent) at the corresponding level.
grid.selectedKeys and level.selectedKeys: A list of ID values, based on the selectedKeyField property. Returns the selected keys for the top column level. Please NOTE - this is a read only collection. Adding to this does nothing. If you want to programatically modify the selection, use the selectedObjects instead. grid.selectedKeys implicity returns selectedKeys at the top level. level.selectedKeys will return all the selected objects (regardless of parent) at the corresponding level.
grid.getSelectedObjects: This method is similar to grid.selectedObjects, except it recursively iterates through all levels gathering the selected objects at each level. This is used for nested datagrids, and used to get all items selected at all levels. If you specify getKey=true, the method will reutrn an array containning the value of the selectedKeyField at each level.
grid.getSelectedKeys: This method is similar to grid.selectedKeys, except it recursively iterates through all levels gathering the selected keys at each level. This is used for nested datagrids, and used to get all keys selected at all levels. This method will reutrn an array containning the value of the selectedKeyField at each level, assuming you have specified a selectedKeyField.
grid.setSelectedObjects: This method used to select records programmatically. It takes an array and goes through the dataprovider trying to match each item in this array to the dataprovider, recursively trying to add the matching items to the selectedObjects collection at the corresponding level. A boolean flag for this method will optionally open the selected items parents in hierarchical datagrids, so any selection you set using this method is automatically expanded so the user can visually see the selected rows.
grid.setSelectedKeys: This method is similar to grid.setSelectedObjects, except it takes an array of keys. Another consideration for this method is that the array of keys need to be globally unique across the entire dataprovider, so parents and children cannot have the same keys. Also, it depends on the selectedKeyField property being set.
grid.selectableField : 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.

`getSelectedKeys`

()

A list of ID values, based on the selectedKeyField property. Returns the selected keys for the top column level. Please NOTE - this is a read only collection. Adding to this does nothing. If you want to programatically modify the selection, use the selectedObjects instead.

Please note, for hierarchical grids, each level has its own collection of selected keys. The grid.selectedKeys returns the selectedKeys at the top level. To access the selected keys at a lower level, you may navigate to that level using grid.getColumnLevel().nextLevel...nextLevel.selectedKeys

`getSelectedKeys`

()

()

Returns the columns where excludeFromExport=false

`getSpinnerParent`

()

`getThemeToolbarIconFolder`

()

Based upon the current theme id, returns the theme icons folder.

`getToolbarActionAddRow`

()

Returns the built in Add Row Action

Returns:

`getToolbarActionButton`

(

code

)

Gets the actual button object for the provided toolbar action.

Parameters:

code Object

()

When enableSelectionExclusion, returns a list of items that the user explicitly unselected.

`getUseElements`

()

Whether to use addElement or addChild;

`getUserSettingsController`

()

`getVerticalScrollBar`

()

The vertical scrollbar associated with the this.getBodyContainer(). The body container is the only section to have a scroll bar. The left and right locked containers scroll along with it.

`getVerticalScrollBarOffset`

()

Not used.

`getVerticalScrollPosition`

()

The vertical scroll position of the body container. The body container is the only section to have a scroll bar. The left and right locked containers scroll along with it.

()

Given a data item, scrolls to that item in the datagrid

Flexicious by default will only build RowPositionInfo objects for open items that the user can visually scroll to. So items that are closed, or are on a different page, will not be built, and cannot be scrolled to. This function will will inspect the data provider to find the item in question, and build the RowPositionInfo for it if its not found in the currently built RowPositionInfo objects.

`gotoKey`

()

Given a key, scrolls to the item that has the provided value for the selectedKeyField at that level

`gotoRow`

()

Given a row index (less than the total number of rows, goes to the row in question). Row index becomes the first visible row. Please note this is a 1 based index.

`gotoVerticalPosition`

()

Goes to the specified vertical position. Going to a specified horizontal scroll position requires the renderers to recycle if the set of visible rows changes.

`hideSpinner`

()

`hideTooltip`

()

Hides the current tooltip.

`highlightRow`

(

cell
row
highLight
highLightColor

)

On basis of the highLight flag, removes or adds highlight to the row in question. Triggered in response to a rollover event.

Sets the currentBackgroundColors property is a result of the following logic. When highLight=true

If enableActiveCellHighlight=true uses the value of the activeCellColor style.
Else, uses the value of the rollOverColor style property.

When highLight=false, sets it to null.
Sets the currentTextColors property is a result of the following logic.

When highLight=true, sets it to value of the textRollOverColor property
When highLight=false, sets it to null.

Parameters:

cell Object

The IFlexDataGridCell to highligh or remove the highlight from
row Object

The rowInfo object associated with this cell.
highLight Object

Whether to add a highlight or remove the highlight
highLightColor Object

If you want to override the color that is calculated using the logic above.

`initialize`

()

Initializes the auto complete and watermark plugins

`invalidateCells`

()

Invalidates the display (Calls invalidateDisplayList of all the cells). This will re-evaluate the backgroud and borders of each cell. There are four functions that you can use to redraw the grid, on basis of what your needs are.

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.

`invalidateFiller`

()

Queues a call to drawFiller in the next validation cycle

`invalidateList`

()

Calls the rebuild function, which basically rebuild the entire grid. This is also the most expensive functions. There are four functions that you can use to redraw the grid, on basis of what your needs are.

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.

`invalidateSelection`

()

`isCtrlKeyDownOrSticky`

()

Return true if enableStickyControlKeySelection Or (Control Key is down AND (selectionMode is MultipleRows or MultipleCells))

`isToolbarActionValid`

()

Evaluates whether the given toolbar action is valid or not.

If toolbarActionValidFunction is not null, returns the result of the function passing in the given ToolbarAction. Else returns true.

`keyDownHandler`

()

Support for key board interaction.
First, if allowInteractivity or enableKeyboardNavigation flags are not set, then we do not handle any keyboard interaction.
If the body container is in edit mode, keyboard interaction that is handled is limited to the TAB and Enter keys, which will end the edit session and move on to the next cell or row on basis of which key has been selected.
If we are in any of the filter control, the TAB and SHIFT TAB keys will move between the filter controls. Once you focus on a filter control, all keyboard interaction except TAB, SHIFT TAB and Arrow Keys is handled by the Filter Control in question. These are all Flex SDK controls, and you should refer to the the documentation of the SDK control for more information about its keyboard interaction. Arrow keys will move focus out of the filter control and highlight the next cell (for down arrow) or the header (for up arrow) on basis of what the displayOrder property of the grid specifies.
For TextInput Filter control where filterTriggerEvent=enterKeyUp, hitting the enter key will cause the filter to run.
For the most part, the Flexicious Ultimate grid's keyboard interactions are similar to the SDK datagrid, with one important difference. We have a concept of an active cell, which is the cell that is currently active either via a mouseover gesture, or via a arrow key navigation gesture. You can style this color of the active cell via the activeCellColor style. You can completely disable the active cell tracking by setting enableActiveCellHighlight to false.

When the grid is not in edit mode, and focus is not on the filter but on a specific grid cell, the following keyboard interactions are available:

Keyboard.UP : Navigates to the cell and row above the currently highlighted cell. The active cell is highligted via the activeCellColor style, and the active row is highligted via the rollover color style
Keyboard.DOWN : Navigates to the cell and row below the currently highlighted cell
Keyboard.LEFT : Navigates to the cell to the left the currently highlighted cell
Keyboard.RIGHT : Navigates to the cell to the right the currently highlighted cell
Keyboard.TAB : Relinquishes focus from the grid and moves on to the next focussable control in the display tree
Keyboard.PAGE_DOWN: Moves the scroll bar down by the height of the grid and highlights the newly visible first row
Keyboard.PAGE_UP: Moves the scroll bar up by the height of the grid and highlights the newly visible first row
Keyboard.HOME: Moves the scroll to the top (i.e.) the first record of the grid and highlights the newly visible first row
Keyboard.END: Moves the scroll to the end (i.e.) the last record of the grid and highlights the newly visible first row
Keyboard.F2:
Keyboard.NUMPAD_MULTIPLY OR CTRL + SHIFT + DOWN : If the current row can be expanded, expands it, AND all of its children. (Shows child records)
Keyboard.NUMPAD_DIVIDE OR CTRL + SHIFT + UP : If the current row can be collapsed, collapses it. (Hides child records)
Keyboard.NUMPAD_ADD OR CTRL + SHIFT + RIGHT : If the current row can be expanded, expands it. (Shows child records)
Keyboard.NUMPAD_SUBSTRACT OR CTRL + SHIFT + LEFT : If the current row can be collapsed, collapses it. (Hides child records)
Keyboard.SPACE: Performs the equivalent of a click on the active cell

`keyUpOrDown`

()

Not used, because it is handled by the grid itself.

`kill`

()

Cleanup method

`loadPreferences`

()

Loads preference values from the Shared object, called automatically in preferencePersistenceMode=client. In server mode, you can directly set the preferences property to the string XML value persisted earlier.

`measure`

()

Measures the DataGrid based on its contents, summing the total of the visible column widths.

`measureCellHeight`

(

col
paddingLeft
paddingRight
paddingTop
paddingBottom
itemRenderer
ht
txt
item

)

Given a column and padding values, calculate the height required to fully render the text

Parameters:

col Object

The column to render. The width of this column is used to calculate the height.
paddingLeft Object

The left padding to apply while calculating the height
paddingRight Object

The right padding to apply while calculating the height
paddingTop Object

The top padding to apply while calculating the height
paddingBottom Object

The bottom padding to apply while calculating the height
itemRenderer Object

The renderer to use - for data cells uses itemRenderer for header cells uses headerRenderer
ht Object

The previously calculated max height. The ht will return this value if the calculated height is less than the passed in ht.
txt Object

The text to render.
item Object

The item (or row data) object that will be applied to the data property of the renderer

Returns:

If the calculated height is greater than ht parameter, returns the calculated height. Else returns the value of the ht parameter

`multiColumnSortGetTooltip`

()

Gets the text of the tooltip to show to the user to prompt for the multi column sort.

`multiColumnSortShowPopup`

()

Creates an instance of the multiSortRenderer and pushes it into view

`onCellContextMenuItemClick`

(

event

)

Method to handle the click for the copy cell menu item Copies the current cell in tab delimited format into the clipboard

Parameters:

event Object

`onColumnResized`

()

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.

`onGridMouseOut`

()

`onGridResized`

()

`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.

Parameters:

event Object

`onRootFilterChange`

()

`onRootPageChange`

(

event

)

Parameters:

event Object

`onRowContextMenuItemClick`

()

Method to handle the click for the copy row menu item Copies the current row in tab delimited format into the clipboard

`onSelectAllChanged`

()

`onSelectChanged`

()

`onTableContextMenuItemClick`

(

event

)

Method to handle the click for the copy table menu item Copies the entire dataprovider in tab delimited format into the clipboard

Parameters:

event Object

`parse`

()

used by the buildFromXml method to parse the XML to build the grid

`pauseKeyboardListeners`

()

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.

`persistPreferences`

()

Persists the preferences as Shared Objects when preferencePersistenceMode=client or dispatches an event with the preference information when preferencePersistenceMode=server

`placeBottomBar`

()

Left Locked Header
Left Locked Content
Left Locked Footer
Right Locked Header
Right Locked Content
Right Locked Footer
UnLocked Header
UnLocked Content
UnLocked Footer

On basis of the column lock modes specified, this method will size each section and place them in the correct location.

`processFilter`

()

Processes filters at the root level. 1) Ensures the root filter exists
2) In filterPageSortMode="client", invalidates the row position info objects, so they are rebuilt
3) In filterPageSortMode="client", Calls the create components method on each of the container sections.
4) In Server mode, gathers the filter information, and dispatches a filterPageSortChange event, for the client code to listen to.

`processRootFilter`

()

`processSort`

(

sorts

)

Used by state persistence to load sort settings that were persisted previously.

Parameters:

sorts Object

A method that simply rebuilds the pager as opposed to rebuilding the entire grid.

`recycleH`

()

`redrawBody`

()

A method that simply redraws the body as opposed to rebuilding the entire grid. As opposed to rebuild, does not recalculate row positions and heights, just refreshes the currently drawn rows.

`refreshCells`

()

Calls the refresh cell method on all visible cells in the bodyContainer section.
The refreshCell method re-evaulates the following properties:

Cell Text

Cell Enabled

Cell data

Various style properties like text decoration, underline

Sets the width, and places the renderer appropriately.

Dispatches the renderer intialized event.

If you wish to re evaluate the background/border, use the invalidate cells instead.

`refreshCheckBoxes`

()

Updates the visible state of all row selection checkboxes and header checkboxes.

`removeAllSorts`

()

()

`setChildData`

(

item
children
totalRecords
level
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.

This event is then handled by client code, and when the data is retreieved from the server, this method should be called with the item being expanded, and children to insert.

Parameters:

item Object

The item that is being expanded. You can pass in an ID value if you set useSelectedKeyField=true (default)
children Object

The list of items to add to the children collection of the item being expanded
totalRecords Object

Total number of child records. Only applicable if the filterPageSortMode for the child level is server. Use this parameter to tell the level that you are showing the first page of totalRecords records
level Object

The parent level (the level at which the item object is located).
useSelectedKeyField Object

Flag to indicate whether to use the selectedKeyField to identify the item being expanded, or to compare against the item directly against the list of items pending expansion.

`setCurrentPreferenceInfo`

()

When enableMultiplePreferences = true, applies the given preference as the current preference.

`setDataProvider`

()

`setDisabledField`

()

`setDisplayOrder`

()

`setEditedItemPosition`

()

`setExpandCollapseCellRenderer`

()

`setExpandCollapseHeaderCellRenderer`

()

`setFilterFocus`

(

fld

)

Sets the filter at the top level.

Parameters:

fld Object

The string to match the searchField property of the filter control with.

Returns:

True if focus was set, false if otherwise.
Focus may not be set if the given search field does not exist,
or if the filter control for the given search field does not
implement IFocusManagerComponent.

`setFilterFunction`

()

`setFilterPageSortMode`

()

`setFilterRowHeight`

()

Sets the filter row height at the top level.

`setFilterValue`

()

`setFilterVisible`

()

Sets the filter row to visible at the top level.

`setFooterRowHeight`

()

Sets the footer row height at the top level.

`setFooterVisible`

()

Sets the footer row to visible at the top level.

`setForcePagerRow`

()

`setGridPreferencesInfo`

()

Sets the multiple preferences array. On basis of the applyPreferences parameter, loops through the preferences and sets the preferences value to the first preference where isDefault=true.

`setGroupedColumns`

()

`setHeaderRowHeight`

()

`setHeaderSeperatorWidth`

()

`setHeaderVisible`

()

Sets the filter row to visible at the top level.

`setHeight`

()

()

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 grid.getOpenItems()

When you reset the dataprovider via server call, the original objects that we were tracking with openItems are gone, so the grid no longer has a handle to know which items to retain open. To combat this, you may use the following snippet:

var openKeys:Array=grid.getOpenKeys();
grid.dataProvider=yourNewDataProvider;
grid.setOpenKeys(openKeys);

Please note, these API calls rely on the selectedKeyField being defined at each level, as well as the key values being unique.

`setPageIndex`

()

Page index at the top level.

`setPagerCellRenderer`

()

`setPagerRenderer`

()

`setPagerRowHeight`

()

Sets the pager row height at the top level.

`setPagerVisible`

()

Sets the pager row to visible at the top level.

`setPageSize`

()

`setPredefinedFilters`

()

Adds to built in filters and refreshes the toolbar.

`setPreferencePersistenceKey`

()

`setPreferences`

()

`setPreferencesFromSettings`

()

()

Sets the selected keys for the top level. If you pass in TriStateCheckBox.STATE_CHECKED, all items are selected. If you pass in TriStateCheckBox.STATE_UNCHECKED, all items are unselected. TriStateCheckBox.STATE_MIDDLE is not valid parameter for this function.

`setSelectedField`

()

`setSelectedIndex`

()

`setSelectedItem`

()

`setSelectedItemsBasedOnSelectedField`

(

[rebuild]
[openItems]

)

Sets the open items on basis of the selectedField.

Parameters:

[rebuild] Object optional

Flag to rebuild the grid. Set to true if calling from your code, unless rebuild is being called else where.
[openItems] Object optional

`setSelectedKeyField`

()

`setSelectedKeys`

()

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. Ensure that the selectedKeyField is set at the level.

When you reset the dataprovider via server call, the original objects that we were tracking with selected objects are gone, so the grid no longer has a handle to know which items to retain selected. To combat this, you may use the following snippet:

var selectedKeys:Array=grid.getSelectedKeys();
grid.dataProvider=yourNewDataProvider;
grid.setSelectedKeys(selectedKeys);

Please note, these API calls rely on the selectedKeyField being defined at each level, as well as the key values being unique.

`setSelectedObjects`

()

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

Please see the documentation of setSelectedKeys for instructions on maintaining grid selection post a data provider refresh.

`setToolbarActionButtonProperty`

()

Sets a property or a style of the button object associated with the toolbar action that has the given code.

`setToolbarActions`

()

Adds to toolbar actions, and refreshes the toolbar.

`setTotalRecords`

(

val

)

private

Parameters:

val Object

`setVerticalScrollPolicy`

()

`setVerticalScrollPosition`

()

`setVirtualScrollDelay`

()

`setWidth`

()

Sets the width of this component

`shiftColumns`

()

Inserts the column specified column before the specified column

`showColumns`

()

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

`showDropIndicator`

()

Called to show the drop indicator below the passed in cells row. IF you wish to see custom drop signs, override this function.

`showHideHScroll`

()

`showHideVScroll`

()

`showMessage`

(

msg

)

Displays a message without the spinner label.

Parameters:

msg Object

`showPrintableColumns`

()

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

`showSpinner`

()

`showToaster`

()

`showTooltip`

()

`snapToColumnWidths`

()

Goes through all the sections and resizes the cells to match the current column widths. If you update the column widths programatically, call this to resize the currently visible cells.

`synchronizeHorizontalScroll`

()

Synchronizes the vertical scroll positions of the three locked sections

`synchronizeLockedVerticalScroll`

()

Synchronizes the vertical scroll positions of the three locked sections

`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.

Parameters:

changedItem Object

Item being changed
changeType Object

Type of the change
[changeLevel] Object optional

Nest Level of the level being changed
[changedProperty] Object optional

The property being changed
[previousValue] Object optional

The value prior to the change
[newValue] Object optional

The new value.

Default: false

`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.

Default: #000000

`allowMultipleRowDrag`

Boolean

Flag to enable dragging multiple rows.

Default: false

`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. The value is an array of two or more colors. The backgrounds of the list items alternate among the colors in the array.

Default: undefined

`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. The value is an array of two colors. The text color of the list items alternate among the colors in the array.

Default: [ #000000, #000000]

`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();
}

Default: true

`autoRefreshInterval`

Number

Default: 30000

`autoRefreshTimer`

Unknown

Timer instance to work with the auto refresh mechanism

@type {null}

Default: null

`backgroundColor`

Array

Backgrond color, the color of the fill area. [Style(name="backgroundColor", type="Array", arrayType="uint", format="Color", inherit="no")]

Default: null

`borderColor`

Uint

Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC. [Style(name="borderColor", type="uint", format="Color", inherit="no")]

Default: null

`borderSides`

String

Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides.

This style is only used when borderStyle is "solid". [Style(name="borderSides", type="String", inherit="no")]

Default: null

`borderThickness`

Number

`columnMoveAlpha`

Null deprecated

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.

Default: null

`columnMoveResizeSeparatorColor`

Null

[Style(name="columnMoveResizeSeparatorColor", format="Color")] The color of the line to draw when the user is moving or resizing the column

Default: null

`contextMenuShown`

Boolean

Set to true when the context menu is shown.

Default: false

`currentCell`

Null private

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.

Default: null

`currentExportLevel`

Null

Default: null

Boolean

Default: true

`dragAlpha`

Number

[Style(name="dragAlpha", type="Number")] Alpha for the drag operation.

Default: 0.8

`dragRowBorderStyle`

String

[Style(name="dragRowBorderStyle", type="String")] Border for the drag row for the drag operation.

Default: 0.8

`dynamicLevelHasChildrenFunction`

Function

Function to determine if the given object has children.

Default: defaultDynamicLevelHasChildrenFunction

`editable`

Boolean

Default: false

`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. The value is an array two colors.

Default: undefined

`editTextColor`

Null

[Style(name="editTextColor", format="Color")] The colors to use for the text of the items in the editable grid.

Default: null

`enableActiveCellHighlight`

Boolean

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.

Default: true

`enableAutoRefresh`

Null

Default: null

`enableColumnWidthUserOverride`

Boolean

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".

Default: true

`enableCopy`

Boolean

Flag to enable the context menu copy items.

Default: null

Boolean

Default: true

`enableHeightAutoAdjust`

Boolean

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. If you click again, the grid will remove it from selection. If you click on another row (or cell), the grid will add that row/cell to the selection.

When you set this to false, when you click on a row, the grid will add it to selection, If you click again nothing will happen. If you click with the control key down the grid will remove it from selection. If you click another row/cell, the originally selected row/cell will be unselected. If you CTRL click on another row, the grid will add that row in addition to the previously selected row. In short, the grid will behave like the SDK MX datagrid.

Default: true

`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. These can then be retrieved using the changes collection on the grid. The Changes Collection is an array of ChangeInfo objects that contains all the changes made to the data provider using the grid editing mechanism.

Default: false

`enableTriStateCheckbox`

Boolean

Flag to enable tristate behavior for selection checkboxes.

Default: true

`enableVirtualScroll`

Null

Default: null

`errorBackgroundColor`

Uint

[Style(name="errorBackgroundColor", type="uint", format="Color", inherit="yes")] The background color of the row that has the error .

Default: #FCDCDF

`errorBorderColor`

Uint

[Style(name="errorBorderColor", type="uint", format="Color", inherit="yes")] The border color of the cell that has the error .

Default: #F23E2C

`errorMap`

Object

Default: null

`excelOptions`

ExportOptions

The Export options object that is used to configure the excel export behavior - currently only supported in Ultimate

`expandCollapseTooltipFunction`

Function

Default function will return the value of expandTooltip or collapseTooltip. Should take a IFlexDataGridCell object

Default: defaultExpandCollapseTooltipFunction

`expandTooltip`

String

Tooltip to display when user hovers over expand icon

Default: Expand

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.

Default: 2

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. The default value is [0xCCCCCC,0xCFCFCF]

`footerStyleName`

String

The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.

Default: null

`footerVerticalGridLineColor`

Uint

[Style(name="footerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.

Default: 0x666666

`footerVerticalGridLines`

Boolean

[Style(name="footerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns. If true, shows vertical grid lines. If false, hides vertical grid lines.

Default: true

`footerVerticalGridLineThickness`

Number

[Style(name="footerVerticalGridLineThickness", type="Number", format="Length")] Thickness of the footer vertical grid lines.

Default: 1

`generateColumns`

Boolean

Flag to automatically generate columns. If the data provider is set, has atleast one item, and there are no columns specified the grid will attempt to introspect the first item and create columns on basis of the properties on the first item. Set this flag to false if you do not want this behavior.

Default: true

`getChildrenFunction`

Null

This function basically gives you the opportunity to tie in to the grids hierarchy lookup mechanism. By default, the grid will call the getChildren method on this class to get the children of any object when it is time to draw the hierarchy. By defining a custom getChildrenFunction, you can intercept this mechanism to provide your own implementation of retrieving children. The signature of this function should be like below: getChildren(object:Object,level:FlexDataGridColumnLevel):Object

Default: null

`getRowHeightFunction`

Null

When variableRowHeight =true, atleast one column needs to have the wordWrap flag set to true. If you use custom item rendereres, these are not accounted for in the height measurement for performance reasons. In this case, you should define a getRowHeightFunction and provide your own implementation which is optimized for your situation. It should take the following parameters

param item The item being displayed

param level The FlexDataGridColumnLevel object that the item belongs to

param rowType The type of the row, one of the RowPositionInfo.ROW_TYPE_XXXX constants

The Export options object that is used to configure the html export behavior - currently only supported in Ultimate

`inRebuildBody`

Boolean

Default: false

`inUpdate`

Boolean

Default: false

`isHScrollBarVisible`

Number

Default: 0

`isVScrollBarVisible`

Number

Default: 0

`itemFilters`

Dictionary

Default: {}

[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.

Default: 2

`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. The default value is [0xE6E6E6,0xFFFFFF]

`pagerStyleName`

String

The name of a CSS style declaration for controlling other aspects of the appearance of the pager bar(toolbar).

[Style(name="pagerStyleName", type="String", inherit="no")]

Default: null

`pagerVerticalGridLineColor`

Uint

[Style(name="pagerVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.

Default: 0x666666

`pagerVerticalGridLines`

Boolean

[Style(name="pagerVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns. If true, shows vertical grid lines. If false, hides vertical grid lines.

Default: true

`pagerVerticalGridLineThickness`

Number

Default: concatenatePersistenceValues

`printComponentFactory`

flexiciousNmsp.ClassFactory

Default: PrintFlexDataGrid

`printOptions`

PrintOptions

The Print options object that is used to configure the print behavior - currently only supported in Ultimate

`rebuildGridOnDataProviderChange`

Boolean

Flag that controls whether or not to rebuild the entire grid on dataprovider change. If you set this to false, only the body will be rebuilt.

Default: true

`recalculateSeedOnEachScroll`

Boolean

Flag should be set to true when you have large variable height based rows that are potentially taller than the grid itself. The first row in view is the reference view. As you scroll, newer rows become the reference rows and the view port end updated. However, when you have rows that are taller than the grid, or when they account for a disproportionate amount of the viewport the grid no longer renders view port end becuase the reference row is large and has not scrolled out of view. This flag is used to instruct the grid to check after each scroll gesture whether or not additional rows have come into view.

Default: false

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.

Default: 0

`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.

Default: 2

`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. The default value is [0xFFFFFF,0xFFFFFF]

`rendererVerticalGridLineColor`

Uint

[Style(name="rendererVerticalGridLineColor", type="uint", format="Color", inherit="yes")] The color of the vertical grid lines.

Default: 0x666666

`rendererVerticalGridLines`

Boolean

[Style(name="rendererVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns. If true, shows vertical grid lines. If false, hides vertical grid lines.

Default: true

`rendererVerticalGridLineThickness`

Number

[Style(name="rendererVerticalGridLineThickness", type="Number", format="Length")] Thickness of the renderer vertical grid lines.

Default: 1

`rollOverColor`

Uint

[Style(name="rollOverColor", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the row.

The default value for the Halo theme is 0xB2E1FF. The default value for the Spark theme is 0xCEDBEF.

Default: null

`selectionChain`

Object

When grid.enableSelectionExclusion=true, we keep track of chains of each explicitly selected/unselected item. We need to do this in order to correctly put the parents in the chain to middle state.

Default: null

`selectionDisabledColor`

Uint

[Style(name="selectionDisabledColor", type="uint", format="Color", inherit="yes")] The color of the background of a renderer when the component is disabled.

Default: null

`showSpinnerOnFilterPageSort`

Boolean

Default: false

`spinner`

Null

Default: null

`spinnerBehavior`

flexiciousNmsp.SpinnerBehavior

Default: SpinnerBehavior

`spinnerColors`

Array

Colors for the spinners as an array. First element for the circle color and second for the spinner color [Style(name="spinnerColors",type="Array",format="Color")]

Default: null

`spinnerGridAlpha`

Number

Background color of the grid when the spinner is active [Style(name="spinnerGridAlpha", type="Number", format="Length", minValue="0.0")]

Default: null

`spinnerRadius`

Null

Spinner radius , default value is 10

[Style(name="spinnerRadius", type="Number", format="Length", minValue="0.0")]

Default: null

`spinnerThickness`

Number

Spinner thickness , default value is 5 [Style(name="spinnerThickness", type="Number", format="Length", minValue="0.0")]

Default: null

`textAlign`

String

Alignment of text within a container. Possible values are "left", "right", or "center".

flexiciousNmsp.TooltipBehavior

TooltipBehavior

`updateTotalRecords`

Boolean

Default: true

`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.

Please note, for the JavaScript edition, only useCompactPreferences=true is supported.

Default: true

`useRollOver`

`verticalGridLineColor`

Uint

The color of the vertical grid lines.

Default: null

`verticalGridLines`

Boolean

Flag that indicates whether to show vertical grid lines between the columns. If true, shows vertical grid lines. If false, hides vertical grid lines.

Default: null

`verticalGridLineThickness`

Number

Thickness of the vertical grid lines.

Default: null

`wordOptions`

ExportOptions

The Export options object that is used to configure the word export behavior - currently only supported in Ultimate

Events

`afterExport`

Dispatched when the grid is finished exporting. At this point, the textWritten variable of the dispatched event is available to you, to customize the generated text if you need to. Event Type:com.flexicious.export.ExportEvent

`autoRefresh`

Dispatched when the autorefresh interval is hit. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`beforeExport`

Dispatched when the grid is about to be exported Event Type:com.flexicious.export.ExportEvent

`beforePrint`

Dispatched when the grid is about to be generated for the print, or the preview. The event has a handle to the grid that is being printed, as well as the PrintDataGrid instance. This lets you perform custom logic on the PrintDataGrid before the print occurs. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridPrintEvent

`beforePrintProviderSet`

Dispatched before the beforePrint event, right prior to the data provider being set. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridPrintEvent

`cellRendered`

Dispatched when the cell is rendered completely. That is, the background and borders are drawn, the renderers are placed Use this event to perform post processing of the cell after the grid has applied all its formatting and positioning Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`change`

Dispatched when row selection or cell selection changes. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`clearPreferences`

Fired when the grid needs to clear its preferences. Event Type:com.flexicious.grids.events.PreferencePersistenceEvent

`columnsResized`

Dispatched when the columns at this level are resized Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`columnsShift`

Dispatched when columns are dragged and dropped to change their position Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`componentsCreated`

Dispatched when all the cells snap to the calculated column widths. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`dynamicAllLevelsCreated`

When enableDynamicLevels=true, this event is dispatched whenever all the dynamic levels are created. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`dynamicLevelCreated`

When enableDynamicLevels=true, this event is dispatched whenever a new level is created. This event can be used to initialize the newly created level. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`filterPageSortChange`

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. Event Type:com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent

`headerClicked`

Dispatched when any header cell is clicked Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`iconClick`

Dispatched when user clicks on an icon enabled via the enableIcon flag on a column Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`iconMouseOut`

Dispatched when user mouse outs on an icon enabled via the enableIcon flag on a column Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`iconMouseOver`

Dispatched when user mouseovers on an icon enabled via the enableIcon flag on a column Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemClick`

Dispatched when user clicks on a row in row selection mode or cell in cell selection mode Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemClose`

Dispatched when the use clicks on the disclosure icon to collapse a previously opened item. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemClosing`

Dispatched when an item is about to close. If you call preventDefault() on the event, the item will not close Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemDoubleClick`

Dispatched when user double clicks on a row in row selection mode or cell in cell selection mode Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemEditBegin`

Dispatched when the editor is instantiated. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridItemEditEvent

`itemEditBeginning`

Dispatched when the user attempts to edit an item. If you call preventDefault on this event, the edit session will not begin. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridItemEditEvent

`itemEditCancel`

Dispatched when the edit session is cancelled. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridItemEditEvent

`itemEditEnd`

Dispatched when the edit session ends. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridItemEditEvent

`itemEditValueCommit`

Dispatched just before committing the value of the editorDataField property of the editor to the property specified by the datafield property of the column of the item being edited. If you call preventDefault on the event, the value will not be committed. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridItemEditEvent

`itemFocusIn`

Dispatched when the item editor receives focus. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridItemEditEvent

`itemLoad`

Dispatched only in server mode, when an item opens for the first time. Used to wire up an event handler to load the next level of data in lazy loaded grids.

Event Type:com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent

`itemOpen`

Dispatched when the user clicks on the disclosure icon to expand a previously collapsed item. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemOpening`

Dispatched when an item is about to open. If you call preventDefault() on the event, the item will not open Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemRollOut`

Dispatched when user rolls out of a row in row selection mode or cell in cell selection mode (only if rollover on a different item) Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`itemRollOver`

Dispatched when user rolls over a row in row selection mode or cell in cell selection mode (only if rollover on a different item) Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`loadPreferences`

Fired In preferencePersistenceMode=server , when the grid needs to load its preferences. Fired In preferencePersistenceMode=client , when the grid has successfully loaded preferences. Event Type:com.flexicious.grids.events.PreferencePersistenceEvent

`pageSizeChanged`

Dispatched whenever the page size is changed.

`pdfBytesReady`

Dispatched when the user clicks the 'Generate PDF' button on the Print Preview. In response to this user action, the grid simply prints it output to a byte array of page images. This byte array can then be sent to any pdf generation library either on the client or the server, for example Alive PDF. We provide integration code for AlivePDF out of the box. Event Type:com.flexicious.print.PrintPreviewEvent

`persistPreferences`

Fired when the grid needs to persist its preferences. Event Type:com.flexicious.grids.events.PreferencePersistenceEvent

`placingSections+`

Dispatched prior to the widths, heights, x, and y of the various sections are calculated. By sections, we mean the left locked,right locked and unlocked content, header, footer, and body sections. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`prebuiltFilterRun`

Dispatched by the grid when a prebuilt filter is run. Event Type:com.flexicious.grids.events.WrapperEvent

`preferencesLoading`

Fired right before preferences are being loaded and applied. Event Type:com.flexicious.grids.events.PreferencePersistenceEvent

`printComplete`

Dispatched when the grid is sent to the printer. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridPrintEvent

`printExportDataRequest`

Dispatched only in server mode, when the grid needs to print or export more data than is currently loaded in memory. Event Type:com.flexicious.grids.events.PrintExportDataRequestEvent

`rendererInitialized`

Dispatched when the renderer is initialized.

Please note, any changes you made to the renderer stay in place when the renderer is recycled. So if you make any changes, please ensure that the changes are rolled back in the event handler first. For example, if you set the text to bold if a condition is met, then you should first set it to normal, check for the condition, and then set it to bold. This will ensure that if the renderer was previously used to display something that match the condition, and the current item does not, then we do not display bold text. Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`rowChanged`

When enableTrackChanges is set to true, this event is dispatched when any change (add,delete or update) is made to the grid. Only the updates made via the grid editors are tracked.

`scroll`

Dispatched when the content is scrolled. Event Type:mx.events.ScrollEvent

`selectAllCheckBoxChanged`

Dispatched when the top level select checkbox is changed

Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`toolbarActionExecuted`

Dispatched when any toolbarAction is executed. Wrapper events' data contains the action being executed. If you call prevent default in this event, the default handling code does not execute

Event Type:com.flexicious.grids.events.WrapperEvent

`virtualScroll`

When grid.enableVirtualScroll=true, the grid dispatches a virtualScroll event when the grid scrolls. This event contains a recordsToLoad array, which contains an series of VirtualScrollLoadInfo records. This provides the application a list of record indexes to load, and which levels to load them at.

In flat grids, the FlexDataGridVirtualScrollEvent.recordsToLoad will always contain a list of VirtualScrollLoadInfo records were level=1. For nested grids, depending on where the user scrolls and which items are open, you could get a list of records from multiple levels, for example. Records 1-3 from level 1, All children of record 3 from level 2, and then Record 4-10 from level 1.

Setting enableVirtualScroll requires that you specify childrenCountField as well as selectedKeyField. Additionally, enableVirtualScroll also requires that you set filterPageSortMode=server and itemLoadMode=server. Finally, virtual scroll does not work with variableRowHeights.

APIs

flexiciousNmsp.FlexDataGrid Class

Constructor

flexiciousNmsp.FlexDataGrid

Item Index

Methods

Properties

Events

Methods

addColumn

addComponent

addEventListener

addRemoveFromOpenItems

addSelectedItem

Parameters:

addToolbarAction

alignColumnGroups

applyAttribute

Parameters:

applyTheme

buildFromXml

calculateRowHeight

Parameters:

Returns:

cascadeColumnGroups

checkGetterAndRetrieve

checkNoDataMessage

checkResize

checkSetterAndApply

clearAllCollections

clearAllErrors

clearAllFilters

clearChanges

clearColumns

clearErrorByKey

clearErrorByObject

clearFilter

clearFlattenedCache

clearPreferences

clearSelection

collapseAll

collapseAllColumnGroups

concatenatePersistenceValues

createBodyContainer

createBuiltinAction

Parameters:

createChromeContainer

createComponents

createElasticContainer

createFilter

createLockedContent

createPrintComponentFactory

Returns:

defaultDynamicLevelHasChildrenFunction

Parameters:

Returns:

defaultExcelHandlerFunction

defaultExpandCollapseTooltipFunction

defaultPdfHandlerFunction

defaultPrintHandlerFunction

defaultUseSettingsOptionsFunction

defaultWordHandlerFunction

dispatchAutoRefreshEvent

Parameters:

dispatchEvent

distributeColumnWidthsEqually

dragAcceptReject

dragBegin

Parameters:

dragComplete

dragDrop

Parameters:

dragDropInternal

dragEnter

Parameters:

dragEnterInternal

drawDefaultSeperators

drawFiller

drawFillerCell

enableDisableToolbarAction

`flexiciousNmsp.FlexDataGrid`

`addColumn`

`addComponent`

`addEventListener`

`addRemoveFromOpenItems`

`addSelectedItem`

`addToolbarAction`

`alignColumnGroups`

`applyAttribute`

`applyTheme`

`buildFromXml`

`calculateRowHeight`

`cascadeColumnGroups`

`checkGetterAndRetrieve`

`checkNoDataMessage`

`checkResize`

`checkSetterAndApply`

`clearAllCollections`

`clearAllErrors`

`clearAllFilters`

`clearChanges`

`clearColumns`

`clearErrorByKey`

`clearErrorByObject`

`clearFilter`

`clearFlattenedCache`

`clearPreferences`

`clearSelection`

`collapseAll`

`collapseAllColumnGroups`

`concatenatePersistenceValues`

`createBodyContainer`

`createBuiltinAction`

`createChromeContainer`

`createComponents`

`createElasticContainer`

`createFilter`

`createLockedContent`

`createPrintComponentFactory`

`defaultDynamicLevelHasChildrenFunction`

`defaultExcelHandlerFunction`

`defaultExpandCollapseTooltipFunction`

`defaultPdfHandlerFunction`

`defaultPrintHandlerFunction`

`defaultUseSettingsOptionsFunction`

`defaultWordHandlerFunction`

`dispatchAutoRefreshEvent`

`dispatchEvent`

`distributeColumnWidthsEqually`

`dragAcceptReject`

`dragBegin`

`dragComplete`

`dragDrop`

`dragDropInternal`

`dragEnter`

`dragEnterInternal`

`drawDefaultSeperators`

`drawFiller`

`drawFillerCell`

`enableDisableToolbarAction`

`ensureLevelsCreated`

`expandAll`

`expandAllColumnGroups`

`expandChildrenOf`

`expandDown`

`expandToLevel`

`expandUp`

`extractAction`

`extractAction`

`extractActionFromObject`

`extractActions`

`extractCol`

`extractColGroup`

`extractColumns`

`extractFilters`

`extractLevel`

`flatten`

`flattenRecursive`

`generateImageForDrag`

`getActionByCode`