Home Reference Source 
import FlexDataGrid from 'flexicious-react-datagrid/js/flexgrid/grids/FlexDataGrid.js'
public class | source

FlexDataGrid

Extends:

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

Direct Subclass:

ReactDataGrid

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

It attempts to provide most of the functionality that is currently available in the Adobe SDK DataGrid, AdvancedDataGrid, and the Flexicious Extensions in addition to a number of unique features.

Although Flexicious Ultimate offers all of the features outlined below, The ones in bold or italic are features that are exclusive to the Flexicious family of products, and not available in the Halo DataGrid/Advanced DataGrid components that ship with the SDK. The features in bold above are exclusive to Flexicious Ultimate. Features in italic are available both in Ultimate, as well as Flexicious Classic. The rest of the features are found in the Flexicious Grids, as well as either the SDK DataGrid or AdvancedDataGrid.

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

  1. Ability to organize information as rows and columns, with locked headers
  2. Ability to Customize the appearance Rows and Columns
  3. Inline Editing, Customizable Editors, with validation hooks
  4. User Interactive, Draggable, Resizable, Sortable and Editable Columns
  5. Fully Configurable Drag and Drop
  6. Keyboard Navigation
  7. Multi Column Sort
  8. Multi Level, Expand Collapse enabled Grouped Column Headers
  9. Single Cell, Single Row, Multiple Cell, Multiple Row selection modes.
  10. Support for UI skinning via styles, factories, as well as programmatic control
  11. Display of Homogenous Hierarchical Data (Single Set Of Columns)
  12. <em>Inline Filtering, with numerous built in Filter Controls, and extensible architecture to define your own.</em>
  13. <em>Server and Client based Paging, with a fully Customizable Pager UI.</em>
  14. <em>Summary Footers, with fine tuned control over Formula, Precision, Formatting, Placement and Rendering of Footers.</em>
  15. <em>Print and Live Print Preview, with ability to control Page Size, Orientation, Columns To Print, Page/Report Headers and Footers.</em>
  16. <em>Ability to Export the Print output to any ActionScript PDF library, including Alive PDF</em>
  17. <em>Ability to create Customizable Reports with your own Headers/Footers.</em>
  18. <em>Ability to Export to Excel, Word, Text, XML and other formats. Ability to plug in your own Exporters</em>
  19. <em>Preference Persistence (Ability for your end users to save viewing preferences)</em>
  20. <em>CheckBox based selection of data, with Tri State CheckBox Header</em>
  21. <em>Customizable loading Animation</em>
  22. <b>Smooth Scrolling</b>
  23. <b>Display of Heterogonous Hierarchical Data (Multiple Sets Of Columns)</b>
  24. <b>Ability to define paging, filtering and summary footers at each hierarchical level</b>
  25. <b>Ability to define Fully Lazy Loaded, Partially Lazy Loaded and Initial Loaded Flat as well as Hierarchical Data Grids.</b>
  26. <b>Left and Right Locked columns</b>
  27. A vast number of Business Scenarios supported out of the box:
    • <b>Cascading of row selection for hierarchical data</b>
    • <b>Ability to control whether or not rows with no children are shown (For grouped entries)</b>
    • <b>Drill Down/Drill Up/Drill To of Hierarchical data</b>
    • <b>Toolbar action icons, with ability to define custom actions</b>
    • <b>Ability to define initial sort values at any level</b>
    • <b>Ability to programmatically navigate to a row</b>
    • <b>Ability to show custom tooltip on hover over</b>
    • <b>Ability to fully customize sizes, borders, backgrounds, and styles for any cell programmatically as well as via CSS</b>
    • <b>Ability to define custom logic that control row selection, enabled, background, border.</b>
    • <b>Auto adjustment of the height on basis of the number of rows displayed</b>
    • <em>Read write nested properties of complex objects</em>
    • <em>Automatic column width adjustment on basis of data</em>
    • <em>Context menu based copying of data rows</em>
    • <em>Ability to define Hand Cursors, Underline, truncateToFit, wordWrap on the columns</em>
    • <em>Ability to define various column width modes, like fitToContent, Percentage and Fixed</em>

Constructor Summary

Public Constructor
public

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

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

Member Summary

Public Members
public

[Style(name="activeCellColor", type="uint", format="Color", inherit="yes")] The color of the cell directly under the mouse or if using keyboard navigation, current keyboard seed.
public

Flag to enable dragging multiple rows.
public

[Style(name="alternatingItemColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the backgrounds of the items in the grid.
public

[Style(name="alternatingTextColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the text of the items in the grid.
public

By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference. This works well in most cases, but in some cases, where the data needed to build selection comboboxes (for filters) is built from the dataprovider, it makes sense to wait until the dataprovider is loaded to parse and set the preferences, otherwise the grid will end up ignoring saved preferences for filters that have dropdown based UI. In this case set autoLoadPreferences to true, and manually call loadPreferences when the data is received from the server and the dataprovider is set.

grid:FlexDataGrid autoLoadPreferences=”false”
And then, when you set the dataprovider:
dgReport.dataProvider=dp;
if(!dgReport.getPreferencesLoaded()){
dgReport.loadPreferences();
}
public

The number of milliseconds to wait before issuing an autorefresh call.
public

Timer instance to work with the auto refresh mechanism
public

Backgrond color, the color of the fill area.
public

borderColor: uint

Color of the border.
public

Bounding box sides.
public

Bounding box thickness.
public

bottomBarLeft: flexiciousNmsp.UIComponent

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

bottomBarRight: flexiciousNmsp.UIComponent

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

A function that can be used to control the background color of each cell in this column.
public

This is a fimctopm that gets called when the cell is placed.
public
public

[Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the checkbox that appears when you drag and drop a header cell to reposition the column, and you drop it on a header cell where you can actually complete the re-order operation The default value for the Halo theme is mx.skins.halo.DataGridSortArrow.
public

Flag that controls whether or not to clear out errors when the data provider changes Defaults to true, so if you are using server paging, set this false
public

Flag that controls whether or not to clear out openItems when the data provider changes Defaults to true, so if you are using server paging, set this false
public

Flag that controls whether or not to clear out selectedObjects and selectedKeys when the data provider changes Defaults to true, so if you are using server paging, set this false
public

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

A function that takes in a data object, and a column, and returns a number.
public

Tooltip to display when user hovers over collapse icon
public

[Style(name="columnGroupClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed column group.
public

[Style(name="columnGroupColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the Column Groups background gradient.
public

[Style(name="columnGroupDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border
public

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

[Style(name="columnGroupHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the header horizontal grid lines.
public

[Style(name="columnGroupHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public

[Style(name="columnGroupOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open column group.
public

[Style(name="columnGroupPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="columnGroupPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="columnGroupPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="columnGroupPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="columnGroupRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the Column Groups.
public

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

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

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

[Style(name="columnGroupVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public
this member was deprecated. Starting in 2.9 we no longer draw a glyph, we simply draw a line. This is to add support for dropping column on both sides of the target cell.

[Style(name="columnMoveAlpha")] The alpha to apply to the glyph when moving the column.
public

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

Set to true when the context menu is shown.
public

[Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the checkbox that appears when you drag and drop a header cell to reposition the column, and you drop it on a header cell where you can NOT complete the re-order operation
public
public
public

currentPoint: flexiciousNmsp.InsertionLocationInfo

public

When used in conjunction with any third party library (like angular js) YOu may want to point this variable to the controller.
public

[Style(name="disclosureClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed branch node of the navigation tree.
public

[Style(name="disclosureOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open branch node of the navigation tree.
public

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

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

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

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

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

Function to determine if the given object has children.
public

[Style(name="editItemColor", type="Array", arrayType="uint", format="Color")] The colors to use for the backgrounds of the items in the grid in the editable mode.
public

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

Flag to hightlight the active cell.
public

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

Added in 2.9 to force columns to take the widths that the user specified.
public

Flag to enable the context menu copy items.
public

By default, the grid draws a set of expand collapse icons on the left locked section.
public

Added in 2.9 to avoid multiple change events from firing.
public

Flag to enable edit on doubleclick as opposed to single click.
public

When enableVirtualScroll=true, setting this to true will cause each scroll event to issue a server request..
public

Flag to enable creation of the next level dynamically as the hierarchy is set.
public

By default, the grid renders when the dataprovider is set.
public

Flag to hightlight the edit row.
public

Flag to enable export to word and excel.
public

Not supported.
public

Flag to size the grid on basis of the number of rows displayed.
public

Flag to control whether or not an item that has no children is filtered out or not.
public
public

Added in 2.9 to avoid flicker.
public

In server mode, if this flag is set to true and the user hits select all on a particular page, the grid will maintain the selections made on previous pages.
public
public

Enables the print pdf operation.
public

When set to true, causes the grid to look for settings stored previously in the local shared object store if preferencePersistenceMode='client' or dispatch an event requesting settings from the server in preferencePersistenceMode='server'
public

Enables the print operation.
public

Flag To watch if our size changed and react accordingly
public

In server mode, if the user selects all and hits page change, this flag will control if the next page of newly loaded records is automatically selected.
public

Flag to enable dataprovider based preselection of data.
public

A flag to bubble up selection from children to parents.
public

Flag to cascade checkbox or row selection down from the selection level.
public

Support for selection based on exclusion.
public

Only applicable when selectionMode=multipleRows or multipleCells By default, when you click on a row (or cell), the grid will add it to the selection.
public

Flag to enable change tracking If set to true, each addition, update(via the grid) or deletion to the data provider will be tracked.
public

Flag to enable tristate behavior for selection checkboxes.
public

Flag to enable virtual scroll.
public

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

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

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

Default function will return the value of expandTooltip or collapseTooltip.
public

Tooltip to display when user hovers over expand icon
public

[Style(name="filterColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background for the filter.
public

[Style(name="filterDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public

By default, for hierarchical datagrids, when there is a object that does not have the property being searched for, these objects are included in the filter match.
public

The color of the horizontal grid lines.
public

[Style(name="filterHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the filter horizontal grid lines.
public

[Style(name="filterHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public

[Style(name="filterPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="filterPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="filterPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="filterPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

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

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

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

[Style(name="filterVerticalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show vertical grid lines between the columns.
public

[Style(name="fixedColumnFillColors", type="Array", arrayType="uint", format="Color", inherit="yes")] A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns
public

[Style(name="footerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the footer background gradient.
public

[Style(name="footerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public

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

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

[Style(name="footerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public

[Style(name="footerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="footerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="footerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="footerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

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

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

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

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

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

Flag to automatically generate columns.
public

This function basically gives you the opportunity to tie in to the grids hierarchy lookup mechanism.
public

When variableRowHeight =true, atleast one column needs to have the wordWrap flag set to true.
public

Function to control all the filtering at all levels.
public

This is a property that gets called to determine if a expand/collapse icon needs to be drawn.
public

A Flag that indicates if there are any errors
public

By default, there is no filter applied.
public

[Style(name="headerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the header background gradient.
public

Flag that indicates whether to force the top border [Style(name="headerDrawTopBorder", type="Boolean", inherit="no")]
public

The color of the horizontal grid lines.
public

Thickness of the header horizontal grid lines.
public

Flag that indicates whether to show horizontal grid lines between the rows.
public

[Style(name="headerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="headerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="headerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="headerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

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

[Style(name="headerSortSeparatorColor", format="Color")] The color of the line between header and the sort section for multi column sort
public

[Style(name="headerSortSeparatorRight", format="int")] The distance between the sort line and the right edge of the header cell
public

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

The color of the vertical grid lines.
public

Thickness of the header vertical grid lines.
public

Flag that indicates whether to show vertical grid lines between the columns.
public
public
public

The color of the horizontal grid lines.
public

Thickness of the horizontal grid lines.
public

Flag that indicates whether to show horizontal grid lines between the rows.
public

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

The root path to all images used by the grid
public
public
public
public
public
public

itemFilters: Dictionary

public
public

Last time the auto refresh timer was triggered

public
public
public

[Style(name="lockedSeperatorColor", type="uint", format="Color", inherit="yes")] The color of the vertical seperators for the locked content.
public

[Style(name="lockedSeperatorThickness", type="Number", inherit="yes")] The width of the vertical seperators for the locked content.
public
public

The maximum height to adjust the grid when enableHeightAutoAdjust is set to true.
public
public
public
public
public
public

The number of field dropdowns to display in the multi column sort popup.
public

The height of the numeric value representing the order of the column sort.
public

The name of a CSS style declaration for controlling other aspects of the appearance of the numeric value representing the order of the column sort.
public

The width of the numeric value representing the order of the column sort.
public

If enabled (set to a string with length>0), when a dataprovider with zero items is set, or when filter criteria returns no records, a message is shown with this data.
public

[Style(name="paddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="paddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="paddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="paddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="pagerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the pager background gradient.
public

[Style(name="pagerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public

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

[Style(name="pagerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the pager horizontal grid lines.
public

[Style(name="pagerHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public

[Style(name="pagerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="pagerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="pagerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="pagerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

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

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

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

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

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

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

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

popupFactoryExportOptions: flexiciousNmsp.ClassFactory

public

popupFactoryOpenSettingsPopup: flexiciousNmsp.ClassFactory

public

popupFactoryPrintOptions: flexiciousNmsp.ClassFactory

public

popupFactorySaveSettingsPopup: flexiciousNmsp.ClassFactory

public

popupFactorySettingsPopup: flexiciousNmsp.ClassFactory

public

String value "server" or "client".
public
public
public

printComponentFactory: flexiciousNmsp.ClassFactory

public

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

Flag that controls whether or not to rebuild the entire grid on dataprovider change.
public

Flag should be set to true when you have large variable height based rows that are potentially taller than the grid itself.
public
public
public

[Style(name="rendererColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the renderer background gradient.
public

[Style(name="rendererDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn
public

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

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

[Style(name="rendererHorizontalGridLines", type="Boolean", inherit="no")] Flag that indicates whether to show horizontal grid lines between the rows.
public

[Style(name="rendererPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="rendererPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public

[Style(name="rendererPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.
public

[Style(name="rendererPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.
public
  • [Style(name="rendererRollOverColors", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over a level renderer.
public

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

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

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

resizeTimer: flexiciousNmsp.Timer

To watch if our size changed and react accordingly
public

responsiveBehavior: flexiciousNmsp.ResponsiveBehavior

The behavior responsible for adding responsiveness to the grid
public

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

A function that takes in a data object, and a column, and returns a number.
public

Function to intercept the body scrolling.
public
public
public

[Style(name="selectionColor", type="uint", format="Color", inherit="yes")] The color of the background for the row when the user selects an item renderer in the row.
public

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

[Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the arrow that indicates the column sort direction.
public
public

spinnerBehavior: flexiciousNmsp.SpinnerBehavior

public

Colors for the spinners as an array.
public

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

Spinner radius , default value is 10
public

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

Alignment of text within a container.
public

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

[Style(name="textRollOverColor", type="uint", format="Color", inherit="yes")] Color of the text when the user rolls over a row.
public

[Style(name="textSelectedColor", type="uint", format="Color", inherit="yes")] Color of the text when the user selects a row.
public
public
public

Function that actually runs the export to excel.
public

Function that actually runs the pdf.
public

Function that actually runs the print.
public

Function that actually runs the export to word.
public

tooltipBehavior: flexiciousNmsp.TooltipBehavior

TooltipBehavior
public
public

If set to true, uses the newer preference persistence scheme introduced in Flexicious 2.0, which stores the preferences as custom string as opposed to XML, making it a lot less verbose.
public

HTMLTreeGrid v3.0 introduced an enhanced printing feature, for those of you who want the old feature, just set this flag to false.
public

HTMLTreeGrid v3.0 introduced an enhanced printing feature, for those of you who want the old feature, just set this flag to false.
public
public
public

When you enable headerWordWrap=true, then we need to set this to true, because we will dyamically adjust the height of the header row.
public

In case the calculations of the row height with text measurements is not accurate browser style issue you can use this variable to adjust the calculation based on your scenario
public

A flag that indicates whether the individual rows can have different height.
public

In case the calculations of the row height with text measurements is not accurate (Flash player bug) you can use this variable to adjust the calculation based on your scenario
public

By default, the flexicious Ultimate Grid does not instantiate and measure each cell renderer when you set variable row heights.
public

The color of the vertical grid lines.
public

Thickness of the vertical grid lines.
public

Flag that indicates whether to show vertical grid lines between the columns.
public
public

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

Method Summary

Public Methods
public

addColumn(col: *)

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

addComponent(component: *)

public

addEventListener(type: *, listener: *, useCapture: *, priority: *, useWeakReference: *)

public

addPopup(component: *)

public

addRemoveFromOpenItems(item: *, open: *, level: *)

public

addSelectedItem(val: *)

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

addToolbarAction(action: *, itemIndex: *)

public

If you modify one or more column groups, calling this method is required so that inter related column groups can update themselves.
public

applyAttribute(target: *, attr: *, node: *, direct: *)

Applies the given attribute to the target.
public

applyTheme(themeID: *)

Rebuilds the grid based on the current theme
public

buildFromXml(strXml: *)

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

calculateRowHeight(item: *, level: *, rowType: *): *

If variableRowHeight returns the minimum height required to display text of each column without clipping.
public
public

checkGetterAndRetrieve(target: *, attrName: *): *

Checks to see if there is a getter with the specified name, and if so, return the value of that getter other wise return the value of the field with this name,
public

checkNoDataMessage(force: *)

If a noDataMessage value is specified, and a dataprovider with zero records is set, calls the showMessage function passing in the noDataMessage, which in turn shows the value of the noDataMessage using the Spinner component with its spinner hidden.
public

Check for changes to the div that holds us.
public
public

checkSetterAndApply(target: *, attrName: *, val: *)

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

Clears out the following collections

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

Clears out all the errors
public

Clears filters at all levels and rebuilds the grid.
public
public

Sets changes to an empty array.
public

clearColumns(rebuild: *)

Clears out all the columns of the grid If the parameter to rebuild is true, the grid will be rebuilt.
public

clearCurrentHighlight(currentMatchedObject: *)

public

clearErrorByKey(key: *, fld: *)

Clears the errors for the specified key
public

clearErrorByObject(item: *, fld: *)

Similar to clearErrorByKey, except takes the actual object that the key represents.
public

Clears the filters at all levels
public

When the dataprovider changes or when new data comes in from the server for lazy loaded grids, you can call this to clear out the flattened cache.
public
public

Clears the selected rows and cells.
public

For nested datagrids, expands all items one level down
public

For grids with column groups, expands them all.
public
public
public
public
public
public

Method to create an instance of the FlexDataGridBodyContainer class.
public

createBuiltinAction(lbl: *, code: *, requiresSelection: *, requiresSingleSelection: *): *

Creates a Toolbar Action
public

Method to create an instance of the FlexDataGridHeaderContainer class.
public

createColumn(isCheckBox: *): *

public

createColumnGroup(): flexiciousNmsp.FlexDataGridColumnGroup

public

createColumnLevel(): flexiciousNmsp.FlexDataGridColumnLevel

public

createComponents(currentScroll: *)

public

Method to create an instance of the ElasticContainer class.
public

Returns the top level filter.
public

Method to create an instance of the LockedContent class.
public

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

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

Default handler for the Word Export Button.
public

If grid.getOpenItems().contains(getItemKey(cell.rowInfo.data)), return the value of expandTooltip else collapseTooltip
public

Default handler for the Print Button.
public

Default handler for the Print Button.
public

returns UserSettingsOptions.create(this);
public

Default handler for the Word Export Button.
public

Handle for the auto refresh.
public

dispatchEvent(e: *): *

public

Modifies the columns so the width is distributed equally.
public

dragAcceptReject(cell: *)

Called when the drag enters over a cell.
public

dragBegin(event: *)

Triggered when drag is starting.
public

dragComplete(event: *)

Triggered when the drag is complete.
public

dragDrop(event: *)

Called when the DragDrop event is dispatched over any of the cells.
public

dragDropInternal(event: *)

public

dragEnter(event: *)

Called when the DragEnter event is dispatched over any of the cells.
public

dragEnterInternal(event: *)

public
public

When enableFillerRows=true, wipes out and recreates the filler rows.
public

drawFillerCell(section: *, color: *, pointer: *, currx: *, colWidth: *, verticalGridLines: *, verticalGridLineThickness: *, verticalGridLineColor: *, horizontalGridLines: *, horizontalGridLineThickness: *, horizontalGridLineColor: *, rowHt: *, draw: *, colIsInView: *, sectionHorizontalScrollPosition: *): *

public

Dumps the configuration information
public

enableDisableToolbarAction(code: *, enable: *)

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

ensureLevelsCreated(item: *, level: *)

When enableDynamicLevels=true and there is only one level, we iterate through the data provider and ensure that the maximum depth has been accounted for.
public

executeFunctionByName(functionName: *, context: *): *

public

For nested datagrids, expands all items one level down
public

For grids with column groups, expands them all.
public

expandChildrenOf(item: *, open: *, level: *)

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

For nested datagrids, expands all items one level down
public

expandToLevel(level: *, maxItems: *)

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

For nested datagrids, expands all items one level up
public

extractAction(actionNode: *, action: *): *

public

extractAction(item: *): *

public

Method to extract action.
public

extractActions(actionsNode: *, grid: *)

public

extractCol(colNode: *): *

public

extractColGroup(cgNode: *): *

public

extractColumns(levelNodeChild: *, lvl: *): {"cols": *, "hasColumnGroups": *, "j": *, "colNode": *}

Method to extact column information from XML
public

extractFilters(filtersNode: *, grid: *)

Code to extract filters.
public

extractLevel(levelNode: *, lvl: *)

Method to extract level information from xml
public

flatten(depthRequested: *, inclusive: *, filter: *, page: *, sort: *, max: *): Array

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

flattenRecursive(depthRequested: *, result: *, parent: *, level: *, inclusive: *, filter: *, page: *, sort: *)

public

Generates a snapshot of the row for the drag visual indicator
public

getActionByCode(code: *): *

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

Pointer to the TOP level additionalFilterArgumentsFunction In scenarios where there are detached filters, this function may be used to add on to the list of arguments before the filter is run.
public

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

By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference. This works well in most cases, but in some cases, where the data needed to build selection comboboxes (for filters) is built from the dataprovider, it makes sense to wait until the dataprovider is loaded to parse and set the preferences, otherwise the grid will end up ignoring saved preferences for filters that have dropdown based UI. In this case set autoLoadPreferences to true, and manually call loadPreferences when the data is received from the server and the dataprovider is set.

grid:FlexDataGrid autoLoadPreferences=”false”
And then, when you set the dataprovider:
dgReport.dataProvider=dp;
if(!dgReport.getPreferencesLoaded()){
dgReport.loadPreferences();
}
public

The main scrollable area of the grid.
public

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

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

Pointer to the TOP level cellBorderFunction A function that lets you control the border drawing mechanism for each cell.
public

Pointer to the TOP level cellCustomBackgroundDrawFunction A function that lets you control the background drawing mechanism for each cell.
public

getCellForRowColumn(data: *, column: *): *

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

getCellInDirection(cell: *, direction: *): *

Gets the cell in the specified direction of the provided cell
public

getChanges(): *

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

getChildren(object: *, level: *, filter: *, page: *, sort: *): *

If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object.
public

Pointer to the TOP level childrenCountField A property on the object that identifies if the object has children.
public

The property of the parent level object, that identifies the children that should be displayed on the next level.
public

getChildrenLength(object: *, level: *, filter: *, page: *, sort: *): *

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

A function that takes in a data object, and a column, and returns a number.
public

Returns the column with the specified datafield, only at the root level
public

Returns the column with the specified UniqueIdentifier, only at the root level
public

Returns the top level columnCount
public

Returns the list of columns groups at the root level.
public

The Root Column Level.
public

Returns the top level column names
public

getColumns(): *

Returns the list of columns at the root level.
public

getContainerForCell(cell: *): *

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

getContainerInDirection(container: *, up: *): *

Returns the section above or below the provided section.
public

getContainerName(container: *): string

Given a container, returns its displayOrder string equivalent.
public

getCornerY(comp: *): *

Corner areas are special containers that exist to hold filter and header on the top and Pager and Footer on the bottom If I am filter cell, return 0 if filter is above header (true always) IF I am header cell, return filterHeight + (headerHeight * header Depth) If I am footer cell, return 0 If I am pager cell, return pager footer height
public

Gets the cell that is currently being edited.
public

Gets the editor that is currently being edited.
public

The index of the currently matched object
public

When enableMultiplePreferences = true, this represents the currently applied preference
public

Return the FilterSort objects at the top level
public

The current tooltip object.
public

The current tooltip object trigger.
public

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

The data provider for the grid.
public

Returns the TOP level data without any filters.
public

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

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

A comma seperated list of the following strings: filter,header,body,footer,pager.
public

The column that initiated the drag
public

The element of the owner that should be used to center the spinner.
public

All elements of the spinner owner that should be blurred when the spinner is active.
public

Flag that indicates whether or not to show the filter
public

Flag that indicates whether or not to show the footer
public

Flag to indicate whether or not to enable paging functionality
public

Flag to embed a column that shows row numbers
public

When enableMultiColumnSort=true, setting this flag to on will enable AdvancedDataGrid like Split headers to enable multi column sort.
public

getError(item: *): *

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

Pointer to the TOP level expandCollapseCellRenderer
public

Pointer to the TOP level expandCollapseHeaderCellRenderer
public

Returns the export controller instance
public

getExportableColumns(exportOptions: *): *

Returns all columns at all levels.
public

Returns the columns where excludeFromExport=false
public

getExportableColumnsAtAllLevel(exportOptions: *): *

Returns all columns at all levels.
public

Returns the filter at the top level.
public

getFilterColumn(searchField: *): *

Gets the column with the specified search field
public

The container for the filter cells.
public

Pointer to the TOP level filterFunction
public

The Filter/Page/Sort Mode.
public

Sets the filter row height at the top level.
public

Returns an array of RowInfo objects in the filter row.
public

getFilterValue(col: *): *

Used to set the initial value of the filter at the top level for the specified field.
public

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

getFilterX(renderer: *): *

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

getFilteredPagedSortedData(dictionary: *, applyFilter: *, applyPaging: *, applySort: *, pages: *): *

Returns the data provider, with filter, paging and sorting applied on basis of the boolean flags specified.
public

The container for the footer cells.
public

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

Returns an array of RowInfo objects in the footer row.
public

Returns true if the footer row is visible at the top level.
public

Flag to force appearance of the pager row even with enablePaging=false.
public

A list of columns that the global search uses to search.
public
public

Array to search for when highlighting a term in specific columns
public

A Boolean variable that tells us whether to highlight just the first occurence or all occurences
public

A String to highlight in the grid.
public

When enableMultiplePreferences = true, this represents a list of all preferences saved for this grid.
public

Returns the list of groupedColumns at the root level.
public

returns true if any of the levels have a filter function
public

Added for Persistence support
public

If rowSpanFunction!=null or colSpanFunction!=null
public

The container for the header cells.
public

Pointer to the TOP level headerHeight Height of the header for this level.
public

Returns the sum of:
If enableFilters, then filterRowHeight else 0 plus
headerHeight
public

Pointer to the TOP level headerSeparatorWidth Width to show the resize indicator between columns.
public

Gets the value of the headerSortSeparatorRight property
public

Returns true if the header row is visible at the top level.
public

Gets the height of this component
public

The horizontal scrollbar associated with the this.getBodyContainer().
public

Whether or not to show the horizontal scroll bar.
public

The horizontal scroll position of the body container.
public

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

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

Returns true if the top column level filterPageSortMode is client.
public
public

getItemAtPosition(position: *): *

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

getItemFilter(level: *, item: *): *

public

Pointer to the TOP level itemLoadMode
public

The container for the left locked data cells.
public

The container for the left locked footer cells.
public

The container for the left locked filter and header cells.
public

getLength(arr: *): *

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

getLevel(levelDepth: *): *

Returns FlexDataGridColumnLevel object at the specified depth
public

getLevelAtNestDepth(depth: *): *

public

getLevelForItem(itemToFind: *, flat: *, level: *): *

Provided an item, loops through the data provider, and finds the level associated with the provided item.
public

Pointer to the TOP level levelRendererHeight Height to assign to the renderer for each level.
public

getLocalName(node: *): * | String | *

IE does not know localName, it knows baseName.
public

Unused/Not Applicable.
public

Unused/Not Applicable.
public
public

Returns the max depth possible for nested datagrids
public

The max horizontal scroll position of the bodyContainer
public

A Class that is responsible for the multi column sort view.
public

getNamedContainer(name: *): *

Given a displayOrder string , returns its container equivalent.
public

Pointer to the TOP level nestIndent The indentation to apply to each progressive nest level.
public

Pointer to the TOP level nestIndentPaddingCellRenderer Container for the nest indent padding cell.
public

getNewIndex(lcw: *, item: *, direction: *): *

public

Pointer to the TOP level nextLevelRenderer
public

getOpenItemCount(cell: *): *

Given a cell if it is a datarow, and it is associated with a column and the column is at the nest level of the cell, and the column is left locked and the data item bound to the cell is open, then will return the recursive count of all open items under this cell.
public
this method was deprecated. Please use the getOpenKeys and getOpenItems instead.

A list of items that the user has opened.
public

A list of ID values, based on the selectedKeyField property.
public

Returns a copy of the open items array.
public

Page index at the top level.
public

The page size of the top(root) level.
public

getPager(): *

Returns the top level pager
public

Pointer to the TOP level pagerCellRenderer Container for the footer renderer.
public

The container for the pager cells.
public

Returns the pager control at the root level.
public

A Class that implements com.flexicious.controls.interfaces.IPager.
public

Gets the pager row height at the top level.
public

Returns true if the pager row is visible at the top level.
public

getParent(object: *, level: *): *

Returns the parent object for the passed in object.
public

getParentContainer(cell: *): *

Returns the container for the given cell
public

String value that uniquely identifies this grid across the application.
public

String value that uniquely identifies this grid across the application.
public

Returns an XML representation of the preferences specified in the preferencesToPersist property and values being the actual values.
public

Returns true if the load preferences has been called.
public

If you set this to true, the next call to rebuild will not rebuild the pager control Needed in cases where there is user interaction in the pager control that we do not want to loose, but we want to rebuild the rest of the grid.
public

Returns the print controller instance
public

getPrintableColumns(options: *): *

public

getRecursiveOpenItemCount(children: *, nextLevel: *): *

public

The container for the right locked data cells.
public

The container for the right locked footer cells.
public

The container for the right locked filter and header cells.
public

Returns the maximum width of right locked columns.
public

Gets the filter at the root level
public

Returns a iterable representation of the dataprovider.
public

Returns the number of rows currently visible.
public

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

Height of the row for this level.
public

A function that can be used to control whether clicking on any cell in this level will select it.
public

Given a cell, returns it row span based upon how many children are open Recursively inspects the children to see if any of them are open as well.
public

A function that takes in a data object, and a column, and returns a number.
public

getRowText(item: Object, cols: Array): String

Iterates through the passed in cols, calls itemToLabel on each of them passing in the item, and return the resulting string in tab delimited format.
public

If all items from the top level are selected, returns TriStateCheckBox.STATE_CHECKED.
public

This is a boolean flag on the dataprovider that notifies the grid whether or not the grid should allow interactive selection on the corresponding record.
public

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

Only applicable for flat grids.
public

Returns dataProvider.indexOf(selectedObjects(0))
public

Returns (selectedObjects(0)).
public

Returns the top level selectedObjects
public

The concept of selection in Flexicious Ultimate is much more powerful as compared to the basic SDK datagrids in the following ways:

  • First, It supports selection independant of dataprovider, so when a row is selected in the grid, we store the the selected object in the selectedObects array collection.

    		•
    public

    A list of ID values, based on the selectedKeyField property.
    public

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

    getSelectedObjects(getKey: *, unSelected: *): *

    A list of selected objects from the data provider.
    public

    A list of selected objects from the data provider.
    public

    Support for selection based on exclusion.
    public

    Returns the columns where excludeFromSettings=false
    public

    Returns the columns where excludeFromExport=false
    public

    The parent to add the spinner to.
    public

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

    Returns the built in Add Row Action
    public

    Gets the actual button object for the provided toolbar action.
    public

    Returns the built in Delete Action
    public

    Returns the built in Edit Action
    public

    Returns the built in Filter Action
    public

    Returns the built in moveDown Action
    public

    Returns the built in Move to Action
    public

    Returns the built in moveUp Action
    public

    Returns the built in moveUp Action
    public

    Returns the built in Edit Action
    public

    The total number of records at the root level (needs to be set only in server mode, because there is no way for the grid to know how many records on the server match the filter criteria) In client mode, the count of the data provider is used instead.
    public
    public

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

    Whether to use addElement or addChild;
    public
    public

    The vertical scrollbar associated with the this.getBodyContainer().
    public

    Not used.
    public

    The vertical scroll position of the body container.
    public
    public

    The main scrollable area of the grid.
    public

    Delay in milliseconds before "virtualScroll" event is dispatched.
    public

    Returns the columns where visible=true
    public

    Gets the height of this component
    public

    This is not used.
    public

    globalFilterFunction(item: *): *

    A global filter function that matches against gloalSearchString
    public

    Goes to the specified horizontal position.
    public

    gotoItem(item: *, highlight: *, level: *)

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

    gotoKey(key: *, highlight: *, level: *)

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

    gotoNextHighlight(backwards: *)

    Handler for the next highlight
    public

    gotoRow(rowIndex: *)

    Given a row index (less than the total number of rows, goes to the row in question).
    public

    Goes to the specified vertical position.
    public
    public

    Hides the current tooltip.
    public

    highlightRow(cell: *, row: *, highLight: *, highLightColor: *)

    On basis of the highLight flag, removes or adds highlight to the row in question.
    public

    Initializes the auto complete and watermark plugins
    public

    Invalidates the display (Calls invalidateDisplayList of all the cells).
    public
    public

    Queues a call to drawFiller in the next validation cycle
    public

    Called when you scroll and expand collapse.
    public

    Calls the rebuild function, which basically rebuild the entire grid.
    public
    public

    isCtrlKeyDownOrSticky(event: *): *

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

    Returns true if the passed in cordinates are in the visible ViewPort
    public

    isToolbarActionValid(action: *, currentTarget: *, extendedPager: *): boolean

    Evaluates whether the given toolbar action is valid or not.
    public

    itemsQuickFind(whatToFind: String, flat: Object, level: FlexDataGridColumnLevel, result: Array, searchCols: Array, breakAfterFind: Boolean, captureCols: Boolean, flatIndex: Number): *

    public

    keyDownHandler(event: *)

    Support for key board interaction.
    public

    keyUpOrDown(keyCode: *)

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

    kill()

    Cleanup method
    public

    Loads preference values from the Shared object, called automatically in preferencePersistenceMode=client.
    public

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

    measureCellHeight(col: *, paddingLeft: *, paddingRight: *, paddingTop: *, paddingBottom: *, itemRenderer: *, ht: *, txt: *, item: *, styl: *, isHeader: *): *

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

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

    Creates an instance of the multiSortRenderer and pushes it into view
    public

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

    onCreationComplete(event: *)

    public

    onDoubleClick(event: *)

    In this method, we trap all double click events, walk up the target tree until we hit a IFlexDataGridDataCell object, and if we indeed double clicked a data cell, we dispatch and ITEM_DOUBLE_CLICK event.
    public

    onDragEnd(event: *)

    public

    onDragMove(evt: *)

    public

    onGridMouseOut(event: *)

    public

    onGridResized(event: *)

    public

    onMouseWheel(event: *)

    Transfers mouse wheel events over the locked left and right sections to scroll events on the body container, so we scroll when the user mouse wheels over the left or right locked containers.
    public

    onRootFilterChange(event: *)

    public

    onRootPageChange(event: *)

    public

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

    parse(strXml: *, grid: *)

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

    pauseKeyboardListeners(filterRenderer: *)

    For some operations, like shift tab and tab key up, purposely pause the Container keyboard listenters, so we do not overwrite the work of one keyboard handler by triggering another.
    public

    persistPreferences(name: *, isDefault: *)

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

    When you have left or right locked sections, the scroll bar only covers the area occupied by the body container, or the unlocked columns section.
    public

    placeChildComponents(components: *)

    public

    placeComponent(comp: *)

    public

    placeComponents(row: *)

    public

    The grid is composed of the following sections:
    public

    Processes filters at the root level.
    public

    processRootFilter(triggerEvent: *)

    public

    processSort(sorts: *)

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

    quickFind(whatToFind: *): *

    Iterates through the data provider to get a list of row positions that match the text provided.
    public

    rebuildBody(vupdateTotalRecords: *)

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

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

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

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

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

    recycleH(right: *)

    public

    A method that simply redraws the body as opposed to rebuilding the entire grid.
    public

    Calls the refresh cell method on all visible cells in the bodyContainer section.
    public

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

    Removes all the sorts and calls doInvalidate.
    public

    removeColumn(col: *)

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

    removePopup(component: *)

    public
    public

    runToolbarAction(action: *, currentTarget: *, extendedPager: *)

    Runs the given toolbar action.
    public

    scrollToExistingRow(vsp: *, scrollDown: *)

    Scrolls to the row that appears at the specified vertical position
    public

    selectText(txt: *)

    Selects the provided text in the currently visible cells that have the default item renderer, or if the item renderer has the selection property
    public
    public
    public
    public

    setChildData(item: *, children: *, level: *, totalRecords: *, useSelectedKeyField: *)

    In lazy loaded grid levels, (filterPageSortMode=server), when the user expands a level for the first time, since the data is not loaded, the level dispatches the filterPageSortChange, or itemLoad.
    public
    public

    setChildrenField(value: *)

    public

    setColSpanFunction(value: *)

    A function that takes in a data object, and a column, and returns a number.
    public

    setColumnLevel(value: *)

    public

    setColumns(val: *)

    public
    public

    setCurrentPreferenceInfo(val: *, applyPreferences: *)

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

    setDataProvider(value: *)

    public
    public

    setDisplayOrder(value: *)

    public
    public

    setEditedItemPosition(rowIndex: *, colIndex: *)

    Takes an object that has a rowIndex and a columnIndex property.
    public

    setEnableFilters(enabled: *)

    public

    setEnableFooters(enabled: *)

    public

    setEnablePaging(enabled: *)

    public

    setEnablePdf(enabled: *)

    public

    setEnablePrint(enabled: *)

    public
    public
    public

    setEnabled(value: *)

    public

    setErrorByKey(key: *, fld: *, errorMsg: *)

    On grids that allow for tracking errors, call this method to highlight the error using the errorRowStyle, errorContainerRowStyle, and errorMessageStyle.
    public

    setErrorByObject(item: *, fld: *, errorMsg: *)

    Similar to setErrorByKey, except takes the actual object that the key represents.
    public
    public
    public

    setFilterFocus(fld: *): *

    Sets the filter at the top level.
    public

    setFilterFunction(value: *)

    public
    public

    Sets the filter row height at the top level.
    public

    setFilterValue(col: *, val: *, triggerEvent: *)

    Used to set the initial value of the filter at the top level for the specified field.
    public

    Sets the filter row to visible at the top level.
    public

    Sets the footer row height at the top level.
    public

    Sets the footer row to visible at the top level.
    public
    public

    setGridPreferencesInfo(val: *, applyPreferences: *)

    Sets the multiple preferences array.
    public
    public
    public
    public

    Sets the filter row to visible at the top level.
    public

    setHeight(val: Number): *

    Sets the height of this component
    public
    public
    public
    public
    public

    setItemLoadMode(val: *)

    public
    public

    setNestIndent(val: *)

    public
    public
    public

    setOpenItems(valCollection: *)

    public

    setOpenKeys(keys: *)

    For nested/grouped hierarchical datagrids, used to select records.
    public

    setPageIndex(val: *)

    Page index at the top level.
    public

    setPageSize(val: *)

    public
    public
    public

    Sets the pager row height at the top level.
    public

    setPagerVisible(val: *)

    Sets the pager row to visible at the top level.
    public

    setPredefinedFilters(filters: *)

    Adds to built in filters and refreshes the toolbar.
    public
    • String value that uniquely identifies this grid across the application.
    public

    setPreferences(val: *)

    public

    setPreferencesFromSettings(arrayCollection: *)

    Takes an array collection of preferences and applies them to the grid.
    public

    setPreservePager(value: *)

    public

    Responsive mode for this grid.
    public
    public

    setRowHeight(o: *)

    public
    public

    setRowSpanFunction(value: *)

    A function that takes in a data object, and a column, and returns a number.
    public

    Sets the selected keys for the top level.
    public
    public
    public
    public

    setSelectedItem(val: *)

    public

    setSelectedItemsBasedOnSelectedField(rebuild: *, openItems: *)

    Sets the open items on basis of the selectedField.
    public
    public

    setSelectedKeys(objects: *, openItems: *)

    For nested/grouped hierarchical datagrids, used to select records.
    public

    setSelectedObjects(objects: *, openItems: *)

    For nested/grouped hierarchical datagrids, used to select records.
    public

    setToolbarActionButtonProperty(toolbarActionCode: *, property: *, value: *)

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

    setToolbarActions(actions: *)

    Adds to toolbar actions, and refreshes the toolbar.
    public
    public
    public
    public

    setWidth(val: *): *

    Sets the width of this component
    public
    public

    shiftColumns(columnToInsert: *, insertBefore: *, level: *, movingCg: *)

    Inserts the column specified column before the specified column
    public

    showColumns(colsToShow: *)

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

    Called to show the drop indicator below the passed in cells row.
    public

    showMessage(msg: *)

    Displays a message without the spinner label.
    public

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

    showSpinner(msg: *)

    public

    showToaster(message: *, toasterPosition: *, toasterRenderer: *, animationDuration: *, visibleDuration: *, moveAnimate: *, fadeAnimate: *): *

    Shows the given toaster message
    public

    showTooltip(relativeTo: *, tooltip: *, dataContext: *, point: *, leftOffset: *, topOffset: *, offScreenMath: *, where: *, container: *)

    Displays a tooltip for the control in question.
    public

    Goes through all the sections and resizes the cells to match the current column widths.
    public

    Synchronizes the vertical scroll positions of the three locked sections
    public

    Synchronizes the vertical scroll positions of the three locked sections
    public

    trackChange(changedItem: *, changeType: *, changeLevel: *, changedProperty: *, previousValue: *, newValue: *)

    Method to track a change, called by track change API to keep track of additions, deletions and modifications to the data provider.
    public

    updateDisplayList(unscaledWidth: *, unscaledHeight: *)

    Inherited Summary

    From class EventDispatcher
    public

    [prop]: *

    public
    public

    A list of event listeners for this event dispatcher object.
    public

    typeCache: {}

    public

    addEventListener(context: *, type: *, listener: *)

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
    public
    public

    dispatchEvent(event: *): boolean

    Dispatches an event into the event flow.
    public
    public

    getStyle(prop: *): *

    Gets the value of the prop property on this object
    public

    Returns true if an event listener exists
    public

    Returns true if the class name to check is in the list of class names defined for this class.
    public

    kill()

    Removes all event listeners
    public

    killArray(arr: *)

    Given an array of event dispatchers, calls the kill method on each of them.
    public

    removeEventListener(type: *, listener: *)

    Removes a listener from the EventDispatcher object.
    public

    setStyle(prop: *, val: *)

    Sets the value of the prop property on this object
    From class UIComponent
    public static
    public static
    public
    public

    children: *[]

    public
    public

    data: *

    This is a getter/setter for the data property.
    public

    domElement: HTMLElement

    The dom element associated with this UIComponent.
    public

    A list of event listeners that are added to the domElement (these create html dom event listeners as opposed to js only event listeners)
    public

    Whether or not this control is enabled.
    public
    public
    public
    public
    public
    public
    public
    public

    A flag to store if this object has been marked for invalidation.
    public
    public

    parent: *

    public
    public

    props: *

    public

    reactElement: ReactElement

    The react element associated with this UIComponent.
    public

    state: *

    public

    tagName: *

    public

    toolTip: *

    public
    public

    Whether or not this control is enabled.
    public
    public

    x: *

    public

    y: *

    public

    addChild(child: *)

    This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
    public

    addChildAt(child: *, idx: *)

    This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
    public

    addDomEventListener(evt: *, f: *)

    When you call addEventListener on a UIComponent, certain events, defined by the domEvents array are also associated with the corresponding domElement.
    public

    addEventListener(context: *, type: *, listener: *)

    Calls super.addEventListener, and for dom based events, also adds a HTML Event listener
    public

    attachClass(newClass: *)

    public
    public
    public
    public
    public
    public

    detachClass(newClass: *)

    public

    domEventFired(event: *)

    The event handler that gets triggered from the HTML DOM.
    public

    focus()

    public
    public

    getAttribute(attr: *): *

    public
    public

    getChildAt(idx: *): *

    Returns the child of the domElement at the specified index.
    public
    public
    public

    getData(): *

    This is a getter/setter for the data property.
    public

    getElementByTagName(tag: *): *

    public

    getEnabled(): *

    Sets the enabled flag
    public

    getErrorString(val: *): *

    public
    public
    public

    getHeight(): *

    public
    public
    public

    getIncludeInLayout(val: *): *

    public

    Getter for the innerHTML property
    public
    public

    getStyleAttribute(attr: *): *

    public

    getText(): *

    Getter for the text property
    public
    public
    public

    getVisible(val: *): *

    Sets the visible flag
    public

    getWidth(): *

    public

    getX(): *

    Gets the X co ordinate
    public

    getY(): *

    Gets the Y co ordinate
    public

    globalToLocal(ptIn: *): flexiciousNmsp.Point

    Converts the given global Point to local co-ordinates.
    public

    initFromProps(props: *)

    public

    Any initialization code is supposed to go in this method.
    public

    This method will queue the component so the display list will render it once the current frame of execution is over.
    public

    kill()

    First, calls super.kill(), which takes out all event listeners.
    public

    localToGlobal(ptIn: *): flexiciousNmsp.Point

    Converts the given local Point to global co-ordinates.
    public

    measureText(textToMeasure: *): {"width": *}

    Returns the width of the given text.
    public

    mergeObjects(obj1: *, obj2: *): *

    public

    move(x: *, y: *)

    Sets the X and Y co ordinates of the current dom element
    public

    Gets the number of children of the dom element associated with this UIComponent.
    public

    owns(elem: *): Boolean

    Recursively iterates through the parent hierarchy of the given element to check to see if the current node is in its parent hierarchy.
    public

    ownsPoint(pt: *): boolean

    public

    removeAllChildren(child: *)

    public

    removeChild(child: *)

    This methods takes another UIComponent object, and removes it from the dom.
    public

    removeChildAt(idx: *)

    This methods takes another UIComponent object, and removes it from the dom.
    public
    public

    removeDomEventListener(evt: *, f: *)

    Removes a previously attached DOM event listener.
    public

    removeEventListener(type: *, listener: *)

    Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
    public

    removeEventListenerKeepDomListener(type: *, listener: *)

    Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
    public

    render(): *

    public

    setActualSize(w: *, h: *)

    public
    public

    setAttribute(attr: *, val: *)

    public
    public

    setChildIndex(child: *, index: *)

    Sets the visible flag
    public

    setComponentStyleAttribute(attr: *, val: *)

    public

    setData(val: *)

    This is important, because the grid looks for a "setData" method on the renderer.
    public

    setDomElement(elem: *)

    Sets the domElement of this UIComponent to the specified element, and creates a property on the dom element called component to this.
    public

    setEnabled(val: *)

    Sets the enabled flag
    public

    setErrorString(val: *)

    public

    setHandCursor(val: *)

    public

    setHeight(val: *): *

    public
    public
    public
    public

    setInnerHTML(val: *)

    Setter for the innerHTML property
    public

    setState(newState: *)

    public

    setStateIfDomPresent(state: *, db: *)

    public

    setStateInternal(newState: *)

    public

    setStyleAttribute(attr: *, val: *)

    public

    setText(val: *)

    Setter for the text property
    public

    setToolTip(val: *)

    public
    public
    public

    setVisible(val: *)

    Sets the visible flag
    public

    setWidth(val: *): *

    public

    setX(val: *): *

    Sets the X co ordinate
    public

    setY(val: *): *

    Sets the Y co ordinate
    public

    updateDisplayList(w: *, h: *)

    Called as a part of render phase.
    public
    public
    From class NdgBase
    public
    public

    Text for the Copy All Rows
    public

    Text for the Copy Cell Menu
    public

    Text for the Copy Selected Row
    public

    The default number of rows to display.
    public

    A function that determines whether drag should be initiated.
    public

    A function that gets executed when the drag drop operation is complete.
    public

    A function that determines whether drop should be shown.
    public
    public

    Flag that indicates whether or not to setup drag support.
    public
    public
    public
    public
    public
    public
    public

    For some operations, like shift tab and tab key up, purposely pause the Container keyboard listenters, so we do not overwrite the work of one keyboard handler by triggering another.
    public
    public
    public

    A collection of toolbar actions.
    public
    public
    public
    public
    public
    public

    A collection of toolbar actions.
    public
    public
    public

    createListData(text: *, dataField: *, i: *): *

    public

    Calls invalidateDisplayList()
    public

    dragDrop(event: *)

    public

    dragEnter(event: *)

    public
    public
    public

    Flag that indicates whether or not to setup drag support.
    public

    The row data that is currently being dragged
    public

    Flag that indicates whether or not to setup drop support.
    public

    The dropIndicator separator Sprite.
    public

    Flag that indicates whether or not to setup drop support.
    public
    public

    Returns true if selectionMode=MULTIPLE_ROWS or SINGLE_ROW
    public

    Returns true if selectionMode=MULTIPLE_ROWS or SINGLE_ROW
    public

    The left locked vertical separator Sprite.
    public

    The right locked vertical separator Sprite.
    public

    A list of CellInfo objects.
    public

    Selection mode for the grid.
    public

    getUIComponentBitmapData(target: *): *

    Drag and Drop support, create a image representation of the row.
    public

    Returns true if the grid defines the border style specified
    public

    Invalidates the cell widths, so in the next commit properties, we snap to the new column widths.
    public

    Invalidates the height, which in turn adjusts the various section based on the updated numbers, and recycles the renderers, so if there is more stuff on the viewport than is currently visible, it is drawn.
    public

    Invalidates the width, which in turn adjusts the various section based on the updated numbers, and recycles the renderers, so if there is more stuff on the viewport than is currently visible, it is drawn.
    public

    onCollectionChange(event: *)

    public

    onCreationComplete(event: *)

    public

    onGridMouseClick(event: *)

    public

    onGridResized(event: *)

    On grid resized, we reposition the cells.
    public

    reDraw()

    Redraws the grid, assuming the data provider is the same, we're just changing column widths or ordinals. There are four functions that you can use to redraw the grid, on basis of what your needs are.

      S
    • rebuild : Most expensive. Rebuilds the entire grid. This is also the most expensive function
    • reDraw : Removes the cells in view, and redraws them. Should be used when there are no additions/removals to the data provider
    • refreshCells : Resets the text,enabled, styles and border/background etc. of the currently visible cells. See the refreshCells() function for details.
    • invalidateCells : Least expensive. Only resets the border/background of the currently visible cells.
    • rebuildBody : A light weight replacement for rebuild that only rebuids the body, not the header,footer,filter, and pager (which are generally more expensive to rebuild).

    public

    Rebuild the entire grid.
    public

    Calls rebuild internally.
    public
    public
    public
    public
    public
    public
    public
    public
    public

    showToaster(message: *, toasterPosition: *, toasterRenderer: *, animationDuration: *, visibleDuration: *, moveAnimate: *, fadeAnimate: *)

    public
    public

    updateDisplayList(unscaledWidth: number, unscaledHeight: number)

    Public Constructors

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

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

    Override:

    NdgBase#constructor

    Params:

    NameTypeAttributeDescription
    props *
    arg1 *
    arg2 *

    Public Members

    public activeCellColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    activeCellColor *

    public allowMultipleRowDrag: Boolean source

    Flag to enable dragging multiple rows.

    Properties:

    NameTypeAttributeDescription
    allowMultipleRowDrag *

    public alternatingItemColors: Number source

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

    Properties:

    NameTypeAttributeDescription
    alternatingItemColors *

    See:

    public alternatingTextColors: Array source

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

    Properties:

    NameTypeAttributeDescription
    alternatingTextColors *

    public autoLoadPreferences: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    autoLoadPreferences *

    public autoRefreshInterval: Number source

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

    Properties:

    NameTypeAttributeDescription
    autoRefreshInterval *

    public autoRefreshTimer: Timer source

    Timer instance to work with the auto refresh mechanism

    Properties:

    NameTypeAttributeDescription
    autoRefreshTimer *

    public backgroundColor: Array source

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

    Properties:

    NameTypeAttributeDescription
    backgroundColor *

    public borderColor: uint source

    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")]

    Properties:

    NameTypeAttributeDescription
    borderColor *

    public borderSides: String source

    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")]

    Properties:

    NameTypeAttributeDescription
    borderSides *

    public borderThickness: Number source

    Bounding box thickness.

    Properties:

    NameTypeAttributeDescription
    borderThickness *

    public bottomBarLeft: flexiciousNmsp.UIComponent source

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

    Properties:

    NameTypeAttributeDescription
    bottomBarLeft *

    public bottomBarRight: flexiciousNmsp.UIComponent source

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

    Properties:

    NameTypeAttributeDescription
    bottomBarRight *

    public builtInActions: String source

    Properties:

    NameTypeAttributeDescription
    builtInActions *

    See:

    public cellBackgroundColorFunction: Function source

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

    Properties:

    NameTypeAttributeDescription
    cellBackgroundColorFunction *

    See:

    public cellPlacementFunction: Function source

    This is a fimctopm that gets called when the cell is placed. It will get a parameter which is the cell being placed. It will be placed at its default position.

    Properties:

    NameTypeAttributeDescription
    cellPlacementFunction *

    See:

    public cellTextColorFunction: null source

    Properties:

    NameTypeAttributeDescription
    cellTextColorFunction *

    public checkIconClass: * source

    [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the checkbox that appears when you drag and drop a header cell to reposition the column, and you drop it on a header cell where you can actually complete the re-order operation The default value for the Halo theme is mx.skins.halo.DataGridSortArrow. The default value for the Spark theme is mx.skins.spark.DataGridSortArrow.

    public clearErrorsOnDataProviderChange: Boolean source

    Flag that controls whether or not to clear out errors when the data provider changes Defaults to true, so if you are using server paging, set this false

    Properties:

    NameTypeAttributeDescription
    clearErrorsOnDataProviderChange *

    public clearOpenItemsOnDataProviderChange: Boolean source

    Flag that controls whether or not to clear out openItems when the data provider changes Defaults to true, so if you are using server paging, set this false

    Properties:

    NameTypeAttributeDescription
    clearOpenItemsOnDataProviderChange *

    See:

    public clearSelectionOnDataProviderChange: Boolean source

    Flag that controls whether or not to clear out selectedObjects and selectedKeys when the data provider changes Defaults to true, so if you are using server paging, set this false

    Properties:

    NameTypeAttributeDescription
    clearSelectionOnDataProviderChange *

    See:

    public clearSelectionOnFilter: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    clearSelectionOnFilter *

    public colSpanFunction: null source

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

    Since this function is defined on the grid, it will get a IFlexDataGridCell object that you should use to return a rowSpan or colSpan.

    Properties:

    NameTypeAttributeDescription
    colSpanFunction *

    See:

    public collapseTooltip: String source

    Tooltip to display when user hovers over collapse icon

    Properties:

    NameTypeAttributeDescription
    collapseTooltip *

    public columnGroupClosedIcon: Class source

    [Style(name="columnGroupClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed column group.

    The default value is TreeDisclosureClosed in the assets.swf file.

    Properties:

    NameTypeAttributeDescription
    columnGroupClosedIcon *

    public columnGroupColors: Array source

    [Style(name="columnGroupColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the Column Groups background gradient. The first color is the top color. The second color is the bottom color.

    Properties:

    NameTypeAttributeDescription
    columnGroupColors *

    See:

    public columnGroupDrawTopBorder: Boolean source

    [Style(name="columnGroupDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border

    Properties:

    NameTypeAttributeDescription
    columnGroupDrawTopBorder *

    public columnGroupHorizontalGridLineColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    columnGroupHorizontalGridLineColor *

    public columnGroupHorizontalGridLineThickness: Number source

    [Style(name="columnGroupHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the header horizontal grid lines.

    Properties:

    NameTypeAttributeDescription
    columnGroupHorizontalGridLineThickness *

    public columnGroupHorizontalGridLines: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    columnGroupHorizontalGridLines *

    public columnGroupOpenIcon: Class source

    [Style(name="columnGroupOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open column group. The default value is TreeDisclosureOpen in the assets.swf file.

    Properties:

    NameTypeAttributeDescription
    columnGroupOpenIcon *

    public columnGroupPaddingBottom: Number source

    [Style(name="columnGroupPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

    Properties:

    NameTypeAttributeDescription
    columnGroupPaddingBottom *

    public columnGroupPaddingLeft: Number source

    [Style(name="columnGroupPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

    Properties:

    NameTypeAttributeDescription
    columnGroupPaddingLeft *

    public columnGroupPaddingRight: Number source

    [Style(name="columnGroupPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

    Properties:

    NameTypeAttributeDescription
    columnGroupPaddingRight *

    public columnGroupPaddingTop: Number source

    [Style(name="columnGroupPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

    Properties:

    NameTypeAttributeDescription
    columnGroupPaddingTop *

    public columnGroupRollOverColors: Array source

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

    The default value is [0xE6E6E6,0xFFFFFF]

    Properties:

    NameTypeAttributeDescription
    columnGroupRollOverColors *

    public columnGroupStyleName: String source

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

    Properties:

    NameTypeAttributeDescription
    columnGroupStyleName *

    See:

    public columnGroupVerticalGridLineColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    columnGroupVerticalGridLineColor *

    public columnGroupVerticalGridLineThickness: Number source

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

    Properties:

    NameTypeAttributeDescription
    columnGroupVerticalGridLineThickness *

    public columnGroupVerticalGridLines: Boolean source

    [Style(name="columnGroupVerticalGridLines", 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.

    Properties:

    NameTypeAttributeDescription
    columnGroupVerticalGridLines *

    public columnMoveAlpha: null source

    this member was deprecated. Starting in 2.9 we no longer draw a glyph, we simply draw a line. This is to add support for dropping column on both sides of the target cell.

    [Style(name="columnMoveAlpha")] The alpha to apply to the glyph when moving the column.

    Properties:

    NameTypeAttributeDescription
    columnMoveAlpha *

    public columnMoveResizeSeparatorColor: null source

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

    Properties:

    NameTypeAttributeDescription
    columnMoveResizeSeparatorColor *

    public configuration: * source

    public contextMenuShown: Boolean source

    Set to true when the context menu is shown.

    Properties:

    NameTypeAttributeDescription
    contextMenuShown *

    public crossIconClass: * source

    [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the checkbox that appears when you drag and drop a header cell to reposition the column, and you drop it on a header cell where you can NOT complete the re-order operation

    The default value for the Halo theme is mx.skins.halo.DataGridSortArrow. The default value for the Spark theme is mx.skins.spark.DataGridSortArrow.

    public currentDataFld: string source

    public currentExportLevel: null source

    Properties:

    NameTypeAttributeDescription
    currentExportLevel *

    See:

    public currentPoint: flexiciousNmsp.InsertionLocationInfo source

    Properties:

    NameTypeAttributeDescription
    currentPoint *

    public delegate: * source

    When used in conjunction with any third party library (like angular js) YOu may want to point this variable to the controller. This way any function names you have will point to the delegate.

    public disclosureClosedIcon: Class source

    [Style(name="disclosureClosedIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to a closed branch node of the navigation tree. The default value is TreeDisclosureClosed in the assets.swf file.

    Properties:

    NameTypeAttributeDescription
    disclosureClosedIcon *

    public disclosureOpenIcon: Class source

    [Style(name="disclosureOpenIcon", type="Class", format="EmbeddedFile", inherit="no")] The icon that is displayed next to an open branch node of the navigation tree. The default value is TreeDisclosureOpen in the assets.swf file.

    Properties:

    NameTypeAttributeDescription
    disclosureOpenIcon *

    public dispatchCellCreated: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    dispatchCellCreated *

    public dispatchCellRenderered: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    dispatchCellRenderered *

    public dispatchRendererInitialized: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    dispatchRendererInitialized *

    public doubleClickEnabled: Boolean source

    Properties:

    NameTypeAttributeDescription
    doubleClickEnabled *

    See:

    public dragAlpha: Number source

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

    Properties:

    NameTypeAttributeDescription
    dragAlpha *

    public dragDropCompleteFunction: * source

    A function that gets executed when the drag drop operation is complete. Takes 2 IFlexDataGridDataCell objects, the initiator, and the target.

    Override:

    NdgBase#dragDropCompleteFunction

    public dragDropGlyph: * source

    public dragRowBorderStyle: String source

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

    Properties:

    NameTypeAttributeDescription
    dragRowBorderStyle *

    public dynamicLevelHasChildrenFunction: Function source

    Function to determine if the given object has children.

    Defaults to the defaultDynamicLevelHasChildrenFunction method of the grid.

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

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

    Properties:

    NameTypeAttributeDescription
    dynamicLevelHasChildrenFunction *

    public editItemColor: Array source

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

    Properties:

    NameTypeAttributeDescription
    editItemColor *

    public editTextColor: null source

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

    Properties:

    NameTypeAttributeDescription
    editTextColor *

    public editable: Boolean source

    Properties:

    NameTypeAttributeDescription
    editable *

    See:

    public enableActiveCellHighlight: Boolean source

    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.

    Properties:

    NameTypeAttributeDescription
    enableActiveCellHighlight *

    See:

    public enableAutoRefresh: null source

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

    Properties:

    NameTypeAttributeDescription
    enableAutoRefresh *

    See:

    public enableColumnWidthUserOverride: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    enableColumnWidthUserOverride *

    public enableCopy: Boolean source

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

    The result of the copy operation is pasted to the clipboard

    In Flex or Flash Builder, only top-level components in the application can have context menus. For example, if a DataGrid control is a child of a TabNavigator or VBox container, the DataGrid control cannot have its own context menu

    Properties:

    NameTypeAttributeDescription
    enableCopy *

    See:

    public enableDefaultDisclosureIcon: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    enableDefaultDisclosureIcon *

    See:

    public enableDelayChange: Boolean source

    Added in 2.9 to avoid multiple change events from firing. Actions like select all, (selecting a parent with enableSelectionCascade, selecting a child with enableSelectionBubble) will result that add or remove multiple items from the selected set, will result in multiple change events being dispatched. If you set this flag to true (this is the default starting in 2.9) the call to the change event dispatch gets queued for the next update cycle. This results in a single change event being dispatched irrespective of the number of rows selected/unselected.

    Properties:

    NameTypeAttributeDescription
    enableDelayChange *

    public enableDoubleClickEdit: Boolean source

    Flag to enable edit on doubleclick as opposed to single click.

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

    Properties:

    NameTypeAttributeDescription
    enableDoubleClickEdit *

    public enableDrawAsYouScroll: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    enableDrawAsYouScroll *

    public enableDynamicLevels: Boolean source

    Flag to enable creation of the next level dynamically as the hierarchy is set.

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

    Properties:

    NameTypeAttributeDescription
    enableDynamicLevels *

    See:

    public enableEagerDraw: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    enableEagerDraw *

    See:

    public enableEditRowHighlight: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    enableEditRowHighlight *

    public enableExport: Boolean source

    Flag to enable export to word and excel.

    Properties:

    NameTypeAttributeDescription
    enableExport *

    See:

    public enableFillerRows: Boolean source

    Not supported.

    Properties:

    NameTypeAttributeDescription
    enableFillerRows *

    public enableHeightAutoAdjust: Boolean source

    Flag to size the grid on basis of the number of rows displayed. When set to true, the grid will shrink or expand to show all the rows displayed, upto a maximum of the maxAutoAdjustHeight (which defaults to 500).

    Properties:

    NameTypeAttributeDescription
    enableHeightAutoAdjust *

    See:

    public enableHideIfNoChildren: Boolean source

    Flag to control whether or not an item that has no children is filtered out or not.

    Properties:

    NameTypeAttributeDescription
    enableHideIfNoChildren *

    See:

    public enableKeyboardNavigation: Boolean source

    Properties:

    NameTypeAttributeDescription
    enableKeyboardNavigation *

    public enableLocalStyles: Boolean source

    Added in 2.9 to avoid flicker.

    Properties:

    NameTypeAttributeDescription
    enableLocalStyles *

    public enableMaintainSelectionOnSelectAll: * source

    In server mode, if this flag is set to true and the user hits select all on a particular page, the grid will maintain the selections made on previous pages. If this flag is set to false, (default) selections on othere pages will be cleared.

    Properties:

    NameTypeAttributeDescription
    enableMaintainSelectionOnSelectAll *

    See:

    public enableMultiplePreferences: Boolean source

    Properties:

    NameTypeAttributeDescription
    enableMultiplePreferences *

    See:

    public enablePdf: Boolean source

    Enables the print pdf operation.

    Properties:

    NameTypeAttributeDescription
    enablePdf *

    See:

    public enablePreferencePersistence: Boolean source

    When set to true, causes the grid to look for settings stored previously in the local shared object store if preferencePersistenceMode='client' or dispatch an event requesting settings from the server in preferencePersistenceMode='server'

    Properties:

    NameTypeAttributeDescription
    enablePreferencePersistence *

    See:

    public enablePrint: Boolean source

    Enables the print operation.

    Properties:

    NameTypeAttributeDescription
    enablePrint *

    See:

    public enableResizeTimer: Boolean source

    Flag To watch if our size changed and react accordingly

    public enableSelectAllOnPageChange: * source

    In server mode, if the user selects all and hits page change, this flag will control if the next page of newly loaded records is automatically selected.

    Properties:

    NameTypeAttributeDescription
    enableSelectAllOnPageChange *

    See:

    public enableSelectionBasedOnSelectedField: null source

    Flag to enable dataprovider based preselection of data. Please ensure you set selectedField at all appropriate columns levels.

    Properties:

    NameTypeAttributeDescription
    enableSelectionBasedOnSelectedField *

    public enableSelectionBubble: Boolean source

    A flag to bubble up selection from children to parents. If this is set to true, If all of the parents children are selected, the parent will be added to its corresponding levels selectedObjects property If any of the children are unselected, the parent will be removed from its corresponding levels selectedObjects Property, in addition to the child being removed from its corresponding level.

    Please note - if your dataprovider is a flat array collection, along with childrenfield, you will also need to specify a parentField that exists on the children object to point back to the parent.

    Post 2.6, this property works in tandem with enableSelectionCascade and enableTristateCheckbox. Setting this to true requires that you also set enableSelectionCascade and enableTristateCheckbox to true

    Properties:

    NameTypeAttributeDescription
    enableSelectionBubble *

    See:

    public enableSelectionCascade: Boolean source

    Flag to cascade checkbox or row selection down from the selection level. Post 2.6, this property works in tandem with enableSelectionBubble and enableTristateCheckbox. Setting this to true requires that you also set enableSelectionBubble and enableTristateCheckbox to true

    Properties:

    NameTypeAttributeDescription
    enableSelectionCascade *

    See:

    public enableSelectionExclusion: Boolean source

    Support for selection based on exclusion. In scenarios 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. Selection

    Properties:

    NameTypeAttributeDescription
    enableSelectionExclusion *

    See:

    public enableStickyControlKeySelection: Boolean source

    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.

    Properties:

    NameTypeAttributeDescription
    enableStickyControlKeySelection *

    See:

    public enableTrackChanges: Boolean source

    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.

    Properties:

    NameTypeAttributeDescription
    enableTrackChanges *

    See:

    public enableTriStateCheckbox: Boolean source

    Flag to enable tristate behavior for selection checkboxes. Applicable in nested grids, where if you select a child, the parent goes into middle state, indicating visually that atleast one of the children is selected. Post 2.6, this property works in tandem with enableSelectionBubble and enableSelectionCascade. Setting this to true requires that you also set enableSelectionBubble and enableSelectionCascade to true.

    Properties:

    NameTypeAttributeDescription
    enableTriStateCheckbox *

    See:

    public enableVirtualScroll: null source

    Flag to enable virtual scroll. This property can only be set at initialization time. In other words, changing this at runtime has no impact. Please note, when you set virtual scroll, you cannot set variableRowHeight. Printing and Export will work only if you wire up the printExportDataRequest event, and the grid will print only what you return in the printExportDataRequest event. For an example of how this is used, see the "Remoting Example" grid.

    Selection cascade, bubble and tristate will only work with enableSelectionExclusion. This blog post has more information about selection exclusion: http://blog.flexicious.com/post/Filtering-with-hierarchical-data-and-selection-across-large-lazy-loaded-datasets.aspx

    Please refer http://blog.flexicious.com/post/Ultimate-DataGrid-now-supports-Virtual-Scroll-with-Hierarchical-Data.aspx for more information.

    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.

    Properties:

    NameTypeAttributeDescription
    enableVirtualScroll *

    public errorBackgroundColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    errorBackgroundColor *

    public errorBorderColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    errorBorderColor *

    public errorMap: Object source

    Properties:

    NameTypeAttributeDescription
    errorMap *

    public excelOptions: ExportOptions source

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

    Properties:

    NameTypeAttributeDescription
    excelOptions *

    See:

    public expandCollapseTooltipFunction: Function source

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

    If grid.openItems.contains(getItemKey(cell.rowInfo.data)), return the value of expandTooltip else collapseTooltip

    Properties:

    NameTypeAttributeDescription
    expandCollapseTooltipFunction *

    public expandTooltip: String source

    Tooltip to display when user hovers over expand icon

    Properties:

    NameTypeAttributeDescription
    expandTooltip *

    public filterColors: Array source

    [Style(name="filterColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background for the filter. The default value is [0xCFCFCF,0xCFCFCF]

    Properties:

    NameTypeAttributeDescription
    filterColors *

    public filterDrawTopBorder: Boolean source

    [Style(name="filterDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn

    Properties:

    NameTypeAttributeDescription
    filterDrawTopBorder *

    public filterExcludeObjectsWithoutMatchField: Boolean source

    By default, for hierarchical datagrids, when there is a object that does not have the property being searched for, these objects are included in the filter match. Set this flag to true to exclude such objects

    Properties:

    NameTypeAttributeDescription
    filterExcludeObjectsWithoutMatchField *

    See:

    public filterHorizontalGridLineColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    filterHorizontalGridLineColor *

    public filterHorizontalGridLineThickness: Number source

    [Style(name="filterHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the filter horizontal grid lines.

    Properties:

    NameTypeAttributeDescription
    filterHorizontalGridLineThickness *

    public filterHorizontalGridLines: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    filterHorizontalGridLines *

    public filterPaddingBottom: Number source

    [Style(name="filterPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

    Properties:

    NameTypeAttributeDescription
    filterPaddingBottom *

    public filterPaddingLeft: Number source

    [Style(name="filterPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

    Properties:

    NameTypeAttributeDescription
    filterPaddingLeft *

    public filterPaddingRight: Number source

    [Style(name="filterPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

    Properties:

    NameTypeAttributeDescription
    filterPaddingRight *

    public filterPaddingTop: Number source

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

    Properties:

    NameTypeAttributeDescription
    filterPaddingTop *

    public filterRollOverColors: Array source

    [Style(name="filterRollOverColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over the filter. The default value is [0xCFCFCF,0xCFCFCF]

    Properties:

    NameTypeAttributeDescription
    filterRollOverColors *

    See:

    public filterVerticalGridLineColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    filterVerticalGridLineColor *

    public filterVerticalGridLineThickness: Number source

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

    Properties:

    NameTypeAttributeDescription
    filterVerticalGridLineThickness *

    public filterVerticalGridLines: Boolean source

    [Style(name="filterVerticalGridLines", 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.

    Properties:

    NameTypeAttributeDescription
    filterVerticalGridLines *

    public fixedColumnFillColors: Array source

    [Style(name="fixedColumnFillColors", type="Array", arrayType="uint", format="Color", inherit="yes")] A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns

    Properties:

    NameTypeAttributeDescription
    fixedColumnFillColors *

    public footerColors: Array source

    [Style(name="footerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the footer background gradient. The first color is the top color. The second color is the bottom color.

    Properties:

    NameTypeAttributeDescription
    footerColors *

    See:

    public footerDrawTopBorder: Boolean source

    [Style(name="footerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn

    Properties:

    NameTypeAttributeDescription
    footerDrawTopBorder *

    See:

    public footerHorizontalGridLineColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    footerHorizontalGridLineColor *

    public footerHorizontalGridLineThickness: Number source

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

    Properties:

    NameTypeAttributeDescription
    footerHorizontalGridLineThickness *

    public footerHorizontalGridLines: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    footerHorizontalGridLines *

    public footerPaddingBottom: Number source

    [Style(name="footerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

    Properties:

    NameTypeAttributeDescription
    footerPaddingBottom *

    public footerPaddingLeft: Number source

    [Style(name="footerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

    Properties:

    NameTypeAttributeDescription
    footerPaddingLeft *

    public footerPaddingRight: Number source

    [Style(name="footerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

    Properties:

    NameTypeAttributeDescription
    footerPaddingRight *

    public footerPaddingTop: Number source

    [Style(name="footerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

    Properties:

    NameTypeAttributeDescription
    footerPaddingTop *

    public footerRollOverColors: Array source

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

    Properties:

    NameTypeAttributeDescription
    footerRollOverColors *

    See:

    public footerStyleName: String source

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

    Properties:

    NameTypeAttributeDescription
    footerStyleName *

    See:

    public footerVerticalGridLineColor: uint source

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

    Properties:

    NameTypeAttributeDescription
    footerVerticalGridLineColor *

    public footerVerticalGridLineThickness: Number source

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

    Properties:

    NameTypeAttributeDescription
    footerVerticalGridLineThickness *

    public footerVerticalGridLines: Boolean source

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

    Properties:

    NameTypeAttributeDescription
    footerVerticalGridLines *

    public generateColumns: Boolean source

    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.

    Properties:

    NameTypeAttributeDescription
    generateColumns *

    See:

    public getChildrenFunction: Function source

    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

    Properties:

    NameTypeAttributeDescription
    getChildrenFunction *

    public getRowHeightFunction: null source

    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
      • and return Height of the row

      Properties:

      NameTypeAttributeDescription
      getRowHeightFunction *

      public globalFilterMatchFunction: null source

      Function to control all the filtering at all levels. If you specify this, all built in filtering mechanics are ignored. This allows you to have full control over filtering.

      Properties:

      NameTypeAttributeDescription
      globalFilterMatchFunction *

      public hasChildrenFunction: Function source

      This is a property that gets called to determine if a expand/collapse icon needs to be drawn. If this is null, or returns true, then the expand collapse icon is drawn on basis of whether or not there are children. This is useful when you have a nextLevelRenderer defined, but do not want to show it if you dont have children. It should take an object (the row data) and a cell parameter.

      Properties:

      NameTypeAttributeDescription
      hasChildrenFunction *

      public hasErrors: Boolean source

      A Flag that indicates if there are any errors

      Properties:

      NameTypeAttributeDescription
      hasErrors *

      public hasFilter: Boolean source

      By default, there is no filter applied. This is used by enableHideIfNoChildren, to hide items if there is a filter and no children qualify.

      Properties:

      NameTypeAttributeDescription
      hasFilter *

      public headerColors: Array source

      [Style(name="headerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the header background gradient. The first color is the top color. The second color is the bottom color.

      Properties:

      NameTypeAttributeDescription
      headerColors *

      See:

      public headerDrawTopBorder: Boolen source

      Flag that indicates whether to force the top border [Style(name="headerDrawTopBorder", type="Boolean", inherit="no")]

      Properties:

      NameTypeAttributeDescription
      headerDrawTopBorder *

      public headerHorizontalGridLineColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      headerHorizontalGridLineColor *

      public headerHorizontalGridLineThickness: Number source

      Thickness of the header horizontal grid lines.

      Properties:

      NameTypeAttributeDescription
      headerHorizontalGridLineThickness *

      public headerHorizontalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      headerHorizontalGridLines *

      public headerPaddingBottom: Number source

      [Style(name="headerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      headerPaddingBottom *

      public headerPaddingLeft: Number source

      [Style(name="headerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

      Properties:

      NameTypeAttributeDescription
      headerPaddingLeft *

      public headerPaddingRight: Number source

      [Style(name="headerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      headerPaddingRight *

      public headerPaddingTop: Number source

      [Style(name="headerPaddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

      Properties:

      NameTypeAttributeDescription
      headerPaddingTop *

      public headerRollOverColors: Array source

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

      The default value is [0xE6E6E6,0xFFFFFF]

      Properties:

      NameTypeAttributeDescription
      headerRollOverColors *

      See:

      public headerSortSeparatorColor: null source

      [Style(name="headerSortSeparatorColor", format="Color")] The color of the line between header and the sort section for multi column sort

      Properties:

      NameTypeAttributeDescription
      headerSortSeparatorColor *

      public headerSortSeparatorRight: null source

      [Style(name="headerSortSeparatorRight", format="int")] The distance between the sort line and the right edge of the header cell

      Properties:

      NameTypeAttributeDescription
      headerSortSeparatorRight *

      public headerStyleName: String source

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

      Properties:

      NameTypeAttributeDescription
      headerStyleName *

      See:

      public headerVerticalGridLineColor: uint source

      The color of the vertical grid lines.

      Properties:

      NameTypeAttributeDescription
      headerVerticalGridLineColor *

      public headerVerticalGridLineThickness: Number source

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

      Properties:

      NameTypeAttributeDescription
      headerVerticalGridLineThickness *

      See:

      public headerVerticalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      headerVerticalGridLines *

      public height: number source

      Override:

      UIComponent#height

      public highlightedCellInfo: * source

      public horizontalGridLineColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      horizontalGridLineColor *

      See:

      public horizontalGridLineThickness: Number source

      Thickness of the horizontal grid lines.

      Properties:

      NameTypeAttributeDescription
      horizontalGridLineThickness *

      See:

      public horizontalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      horizontalGridLines *

      See:

      public htmlOptions: ExportOptions source

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

      Properties:

      NameTypeAttributeDescription
      htmlOptions *

      public imagesRoot: String source

      The root path to all images used by the grid

      public inExport: boolean source

      public inRebuildBody: Boolean source

      Properties:

      NameTypeAttributeDescription
      inRebuildBody *

      public inUpdate: Boolean source

      Properties:

      NameTypeAttributeDescription
      inUpdate *

      public isHScrollBarVisible: Number source

      Properties:

      NameTypeAttributeDescription
      isHScrollBarVisible *

      public isVScrollBarVisible: Number source

      Properties:

      NameTypeAttributeDescription
      isVScrollBarVisible *

      public itemFilters: Dictionary source

      Override:

      NdgBase#itemFilters

      Properties:

      NameTypeAttributeDescription
      itemFilters *

      public keyboardListenersPaused: boolean source

      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.

      Override:

      NdgBase#keyboardListenersPaused

      public lastAutoRefresh: Date source

      Last time the auto refresh timer was triggered

      Properties:

      NameTypeAttributeDescription
      lastAutoRefresh *

      public lastHScroll: number source

      public lastVScroll: number source

      public lockedSeperatorColor: uint source

      [Style(name="lockedSeperatorColor", type="uint", format="Color", inherit="yes")] The color of the vertical seperators for the locked content.

      Properties:

      NameTypeAttributeDescription
      lockedSeperatorColor *

      See:

      public lockedSeperatorThickness: Number source

      [Style(name="lockedSeperatorThickness", type="Number", inherit="yes")] The width of the vertical seperators for the locked content.

      Properties:

      NameTypeAttributeDescription
      lockedSeperatorThickness *

      See:

      public matchedObjects: *[] source

      public maxAutoAdjustHeight: Number source

      The maximum height to adjust the grid when enableHeightAutoAdjust is set to true. When enableHeightAutoAdjust set to true, the grid will shrink or expand to show all the rows displayed, upto a maximum of the maxAutoAdjustHeight (which defaults to 500).

      Properties:

      NameTypeAttributeDescription
      maxAutoAdjustHeight *

      See:

      public measuredHeight: * source

      public measuredMinHeight: * source

      public measuredMinWidth: * source

      public measuredWidth: * source

      public measurer: * source

      public multiColumnSortNumberFields: Number source

      The number of field dropdowns to display in the multi column sort popup.

      Properties:

      NameTypeAttributeDescription
      multiColumnSortNumberFields *

      public multiColumnSortNumberHeight: Number source

      The height of the numeric value representing the order of the column sort.

      Properties:

      NameTypeAttributeDescription
      multiColumnSortNumberHeight *

      public multiColumnSortNumberStyleName: String source

      The name of a CSS style declaration for controlling other aspects of the appearance of the numeric value representing the order of the column sort.

      Properties:

      NameTypeAttributeDescription
      multiColumnSortNumberStyleName *

      public multiColumnSortNumberWidth: Number source

      The width of the numeric value representing the order of the column sort.

      Properties:

      NameTypeAttributeDescription
      multiColumnSortNumberWidth *

      public noDataMessage: String source

      If enabled (set to a string with length>0), when a dataprovider with zero items is set, or when filter criteria returns no records, a message is shown with this data. To disable this functionality, please set this property to a blank string.

      Properties:

      NameTypeAttributeDescription
      noDataMessage *

      public paddingBottom: Number source

      [Style(name="paddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      paddingBottom *

      public paddingLeft: Number source

      [Style(name="paddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

      Properties:

      NameTypeAttributeDescription
      paddingLeft *

      public paddingRight: Number source

      [Style(name="paddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      paddingRight *

      public paddingTop: Number source

      [Style(name="paddingTop", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

      Properties:

      NameTypeAttributeDescription
      paddingTop *

      public pagerColors: Array source

      [Style(name="pagerColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the pager background gradient. The first color is the top color. The second color is the bottom color.

      Properties:

      NameTypeAttributeDescription
      pagerColors *

      public pagerDrawTopBorder: Boolean source

      [Style(name="pagerDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn

      Properties:

      NameTypeAttributeDescription
      pagerDrawTopBorder *

      public pagerHorizontalGridLineColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      pagerHorizontalGridLineColor *

      public pagerHorizontalGridLineThickness: Number source

      [Style(name="pagerHorizontalGridLineThickness", type="Number", format="Length")] Thickness of the pager horizontal grid lines.

      Properties:

      NameTypeAttributeDescription
      pagerHorizontalGridLineThickness *

      public pagerHorizontalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      pagerHorizontalGridLines *

      public pagerPaddingBottom: Number source

      [Style(name="pagerPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      pagerPaddingBottom *

      public pagerPaddingLeft: Number source

      [Style(name="pagerPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

      Properties:

      NameTypeAttributeDescription
      pagerPaddingLeft *

      public pagerPaddingRight: Number source

      [Style(name="pagerPaddingRight", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      pagerPaddingRight *

      public pagerPaddingTop: Number source

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

      Properties:

      NameTypeAttributeDescription
      pagerPaddingTop *

      public pagerRollOverColors: Array source

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

      Properties:

      NameTypeAttributeDescription
      pagerRollOverColors *

      public pagerStyleName: String source

      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")]

      Properties:

      NameTypeAttributeDescription
      pagerStyleName *

      public pagerVerticalGridLineColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      pagerVerticalGridLineColor *

      public pagerVerticalGridLineThickness: Number source

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

      Properties:

      NameTypeAttributeDescription
      pagerVerticalGridLineThickness *

      public pagerVerticalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      pagerVerticalGridLines *

      public pdfOptions: PrintOptions source

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

      Properties:

      NameTypeAttributeDescription
      pdfOptions *

      public pdfOptionsBasic: ExportOptions source

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

      Properties:

      NameTypeAttributeDescription
      htmlOptions *

      public pdfPrinter: null source

      Properties:

      NameTypeAttributeDescription
      pdfPrinter *

      public placed: boolean source

      public placedHeight: * source

      public placedWidth: * source

      public popupFactoryExportOptions: flexiciousNmsp.ClassFactory source

      Properties:

      NameTypeAttributeDescription
      popupFactoryExportOptions *

      public popupFactoryOpenSettingsPopup: flexiciousNmsp.ClassFactory source

      Properties:

      NameTypeAttributeDescription
      popupFactoryOpenSettingsPopup *

      See:

      public popupFactoryPrintOptions: flexiciousNmsp.ClassFactory source

      Properties:

      NameTypeAttributeDescription
      popupFactoryPrintOptions *

      public popupFactorySaveSettingsPopup: flexiciousNmsp.ClassFactory source

      Properties:

      NameTypeAttributeDescription
      popupFactorySaveSettingsPopup *

      See:

      public popupFactorySettingsPopup: flexiciousNmsp.ClassFactory source

      Properties:

      NameTypeAttributeDescription
      popupFactorySettingsPopup *

      See:

      public preferencePersistenceMode: String source

      String value "server" or "client". When this property is set to client(default), the grid uses a shared object on the client to store preference settings. When it is set to server, the grid fires an event, preferencesChanged, which contains a XML string representation of the preference values. This can then be persisted on the backend, tied to a specific user id.

      Properties:

      NameTypeAttributeDescription
      preferencePersistenceMode *

      public preferencesSet: Boolean source

      Properties:

      NameTypeAttributeDescription
      preferencesSet *

      public preferencesToPersist: * source

      Properties:

      NameTypeAttributeDescription
      preferencesToPersist *

      public printComponentFactory: flexiciousNmsp.ClassFactory source

      Properties:

      NameTypeAttributeDescription
      printComponentFactory *

      public printOptions: PrintOptions source

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

      Properties:

      NameTypeAttributeDescription
      printOptions *

      public rebuildGridOnDataProviderChange: Boolean source

      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.

      Properties:

      NameTypeAttributeDescription
      rebuildGridOnDataProviderChange *

      See:

      public recalculateSeedOnEachScroll: Boolean source

      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.

      Properties:

      NameTypeAttributeDescription
      recalculateSeedOnEachScroll *

      public recordBeingExported: * source

      public rendererCache: RendererCache source

      Properties:

      NameTypeAttributeDescription
      rendererCache *

      public rendererColors: Array source

      [Style(name="rendererColors", type="Array", arrayType="uint", format="Color", inherit="yes")] An array of two colors used to draw the renderer background gradient. The first color is the top color. The second color is the bottom color.

      Properties:

      NameTypeAttributeDescription
      rendererColors *

      public rendererDrawTopBorder: Boolean source

      [Style(name="rendererDrawTopBorder", type="Boolean", inherit="no")] Flag that indicates whether to force the top border, when horizontal gridlines are not drawn

      Properties:

      NameTypeAttributeDescription
      rendererDrawTopBorder *

      public rendererHorizontalGridLineColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      rendererHorizontalGridLineColor *

      public rendererHorizontalGridLineThickness: Number source

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

      Properties:

      NameTypeAttributeDescription
      rendererHorizontalGridLineThickness *

      public rendererHorizontalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      rendererHorizontalGridLines *

      public rendererPaddingBottom: Number source

      [Style(name="rendererPaddingBottom", type="Number", format="Length", inherit="no")] Number of pixels between the control's right border and the right edge of its content area.

      Properties:

      NameTypeAttributeDescription
      rendererPaddingBottom *

      public rendererPaddingLeft: Number source

      [Style(name="rendererPaddingLeft", type="Number", format="Length", inherit="no")] Number of pixels between the control's left border and the left edge of its content area.

      Properties:

      NameTypeAttributeDescription
      rendererPaddingLeft *

      public rendererPaddingRight: Number source

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

      Properties:

      NameTypeAttributeDescription
      rendererPaddingRight *

      public rendererPaddingTop: Number source

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

      Properties:

      NameTypeAttributeDescription
      rendererPaddingTop *

      public rendererRollOverColors: uint source

      • [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]

      Properties:

      NameTypeAttributeDescription
      rendererRollOverColors *

      public rendererVerticalGridLineColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      rendererVerticalGridLineColor *

      public rendererVerticalGridLineThickness: Number source

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

      Properties:

      NameTypeAttributeDescription
      rendererVerticalGridLineThickness *

      public rendererVerticalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      rendererVerticalGridLines *

      public resizeListenerPaused: boolean source

      public resizeTimer: flexiciousNmsp.Timer source

      To watch if our size changed and react accordingly

      public responsiveBehavior: flexiciousNmsp.ResponsiveBehavior source

      The behavior responsible for adding responsiveness to the grid

      Properties:

      NameTypeAttributeDescription
      responsiveBehavior *

      public rollOverColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      rollOverColor *

      public rowSpanFunction: null source

      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.

      Properties:

      NameTypeAttributeDescription
      rowSpanFunction *

      See:

      public scrollEnabledFunction: Function source

      Function to intercept the body scrolling.

      Defaults to null.

      Here you can prevent the grid's body from scrolling on mousewheel. This is used to implement fixed scrolling type scenarios where you want the page to scroll upto a certain point and then the grid to start scrolling.

      Properties:

      NameTypeAttributeDescription
      scrollEnabledFunction *

      Example:

      private function scrollEnabledFunction(event:Event):void{
		//your code here
     const doc = document.documentElement;
const top = (window.pageYOffset || doc.scrollTop) - (doc.clientTop || 0);
if (evt.wheelDelta > 0) {
 //scroll down
 if (top < 100) {//or some predefined value
evt.preventDefault
  window.scrollBy(0, 20); // Scroll 100px to the bottom
 }
}
}

      public scrollTimer: * source

      public selectionChain: Object source

      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.

      Properties:

      NameTypeAttributeDescription
      selectionChain *

      See:

      public selectionColor: * source

      [Style(name="selectionColor", type="uint", format="Color", inherit="yes")] The color of the background for the row when the user selects an item renderer in the row.

      The default value for the Halo theme is 0x7FCEFF. The default value for the Spark theme is 0xA8C6EE.

      public selectionDisabledColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      selectionDisabledColor *

      public showSpinnerOnFilterPageSort: Boolean source

      Override:

      NdgBase#showSpinnerOnFilterPageSort

      Properties:

      NameTypeAttributeDescription
      showSpinnerOnFilterPageSort *

      See:

      public sortArrowSkin: * source

      [Style(name="sortArrowSkin", type="Class", inherit="no")] The class to use as the skin for the arrow that indicates the column sort direction. The default value for the Halo theme is mx.skins.halo.DataGridSortArrow. The default value for the Spark theme is mx.skins.spark.DataGridSortArrow.

      public spinner: null source

      Properties:

      NameTypeAttributeDescription
      spinner *

      See:

      public spinnerBehavior: flexiciousNmsp.SpinnerBehavior source

      Properties:

      NameTypeAttributeDescription
      spinnerBehavior *

      public spinnerColors: Array source

      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")]

      Properties:

      NameTypeAttributeDescription
      spinnerColors *

      public spinnerGridAlpha: Number source

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

      Properties:

      NameTypeAttributeDescription
      spinnerGridAlpha *

      public spinnerRadius: null source

      Spinner radius , default value is 10

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

      Properties:

      NameTypeAttributeDescription
      spinnerRadius *

      public spinnerThickness: Number source

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

      Properties:

      NameTypeAttributeDescription
      spinnerThickness *

      public textAlign: String source

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

      The default value for most components is "left". For the FormItem component, the default value is "right". For the Button, LinkButton, and AccordionHeader components, the default value is "center", and this property is only recognized when the labelPlacement property is set to "left" or "right". If labelPlacement is set to "top" or "bottom", the text and any icon are centered.

      [Style(name="textAlign", type="String", enumeration="left,center,right", inherit="yes")]

      Properties:

      NameTypeAttributeDescription
      textAlign *

      public textDisabledColor: uint source

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

      Properties:

      NameTypeAttributeDescription
      textDisabledColor *

      public textRollOverColor: uint source

      [Style(name="textRollOverColor", type="uint", format="Color", inherit="yes")] Color of the text when the user rolls over a row.

      Properties:

      NameTypeAttributeDescription
      textRollOverColor *

      public textSelectedColor: uint source

      [Style(name="textSelectedColor", type="uint", format="Color", inherit="yes")] Color of the text when the user selects a row.

      Properties:

      NameTypeAttributeDescription
      textSelectedColor *

      public themeID: String source

      Properties:

      NameTypeAttributeDescription
      themeID *

      Default theme

      public toolbarActions: *[] source

      A collection of toolbar actions.

      Override:

      NdgBase#toolbarActions

      public toolbarExcelHandlerFunction: Function source

      Function that actually runs the export to excel. Defaults to defaultExcelHandlerFunction

      Properties:

      NameTypeAttributeDescription
      toolbarExcelHandlerFunction *

      See:

      public toolbarPdfHandlerFunction: Function source

      Function that actually runs the pdf. Defaults to defaultPdfHandlerFunction

      Properties:

      NameTypeAttributeDescription
      toolbarPdfHandlerFunction *

      See:

      public toolbarPrintHandlerFunction: Function source

      Function that actually runs the print. Defaults to defaultPrintHandlerFunction

      Properties:

      NameTypeAttributeDescription
      toolbarPrintHandlerFunction *

      See:

      public toolbarWordHandlerFunction: Function source

      Function that actually runs the export to word. Defaults to defaultWordHandlerFunction

      Properties:

      NameTypeAttributeDescription
      toolbarWordHandlerFunction *

      See:

      public tooltipBehavior: flexiciousNmsp.TooltipBehavior source

      TooltipBehavior

      Properties:

      NameTypeAttributeDescription
      tooltipBehavior *

      public updateTotalRecords: Boolean source

      Properties:

      NameTypeAttributeDescription
      updateTotalRecords *

      public useCompactPreferences: Boolean source

      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.

      Properties:

      NameTypeAttributeDescription
      useCompactPreferences *

      See:

      public useEnhancedPdf: Boolean source

      HTMLTreeGrid v3.0 introduced an enhanced printing feature, for those of you who want the old feature, just set this flag to false. If set to false, it will use the basic PDF export, which is simple text pdf as opposed to a full graphical. Text is better pdf quality. But graphics has support for screenshot based output, which is lower quality but an accurate representation of the grid.

      Properties:

      NameTypeAttributeDescription
      useEnhancedPdf *

      public useEnhancedPrint: Boolean source

      HTMLTreeGrid v3.0 introduced an enhanced printing feature, for those of you who want the old feature, just set this flag to false.

      Properties:

      NameTypeAttributeDescription
      useEnhancedPrint *

      public useRollOver: Boolean source

      Properties:

      NameTypeAttributeDescription
      useRollOver *

      public userSettingsOptionsFunction: Function source

      Properties:

      NameTypeAttributeDescription
      userSettingsOptionsFunction *

      public variableHeaderHeight: Boolean source

      When you enable headerWordWrap=true, then we need to set this to true, because we will dyamically adjust the height of the header row. Please be advised, currently, (as of 2.9) columnGroups get the same height as the header cells.

      Properties:

      NameTypeAttributeDescription
      variableHeaderHeight *

      See:

      public variableHeaderHeightOffset: Number source

      In case the calculations of the row height with text measurements is not accurate browser style issue you can use this variable to adjust the calculation based on your scenario

      Properties:

      NameTypeAttributeDescription
      variableHeaderHeightOffset *

      public variableRowHeight: Boolean source

      A flag that indicates whether the individual rows can have different height. 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 or define a getRowHeightFunction and provide your own implementation which is optimized for your situation.

      Properties:

      NameTypeAttributeDescription
      variableRowHeight *

      See:

      public variableRowHeightOffset: Number source

      In case the calculations of the row height with text measurements is not accurate (Flash player bug) you can use this variable to adjust the calculation based on your scenario

      Properties:

      NameTypeAttributeDescription
      variableRowHeightOffset *

      public variableRowHeightUseRendererForCalculation: Boolean source

      By default, the flexicious Ultimate Grid does not instantiate and measure each cell renderer when you set variable row heights. It just uses the measureText functionality to estimate the height required to fit the given text. In case where you have custom item renderers that have other flex components that affect the heights of the cells, the grid does not take these into consideration, for performance reasons.

      This flag, introduced in 2.8 will change this behavior so such cells will be taken in to account and a renderer will be instantiated. The grid will instantiate a renderer, set its data, and then measure it to calculate the height required to render it. Please note, this may slightly degrade performance, so set this flag to true only if you need it. Specifying a getRowHeightFunction and estimating the height without involving display objects will be usually faster.

      Properties:

      NameTypeAttributeDescription
      variableRowHeightUseRendererForCalculation *

      See:

      public verticalGridLineColor: uint source

      The color of the vertical grid lines.

      Properties:

      NameTypeAttributeDescription
      verticalGridLineColor *

      public verticalGridLineThickness: Number source

      Thickness of the vertical grid lines.

      Properties:

      NameTypeAttributeDescription
      verticalGridLineThickness *

      public verticalGridLines: Boolean source

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

      Properties:

      NameTypeAttributeDescription
      verticalGridLines *

      public width: number source

      Override:

      UIComponent#width

      public wordOptions: ExportOptions source

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

      Properties:

      NameTypeAttributeDescription
      wordOptions *

      Public Methods

      public addColumn(col: *) source

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

      Params:

      NameTypeAttributeDescription
      col *

      public addComponent(component: *) source

      Params:

      NameTypeAttributeDescription
      component *

      public addEventListener(type: *, listener: *, useCapture: *, priority: *, useWeakReference: *) source

      Calls super.addEventListener, and for dom based events, also adds a HTML Event listener

      Override:

      UIComponent#addEventListener

      Params:

      NameTypeAttributeDescription
      type *
      listener *
      useCapture *
      priority *
      useWeakReference *

      public addPopup(component: *) source

      Params:

      NameTypeAttributeDescription
      component *

      public addRemoveFromOpenItems(item: *, open: *, level: *) source

      Params:

      NameTypeAttributeDescription
      item *
      open *
      level *

      public addSelectedItem(val: *) source

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

      Params:

      NameTypeAttributeDescription
      val *

      public addToolbarAction(action: *, itemIndex: *) source

      Params:

      NameTypeAttributeDescription
      action *
      itemIndex *

      public alignColumnGroups() source

      If you modify one or more column groups, calling this method is required so that inter related column groups can update themselves.

      public applyAttribute(target: *, attr: *, node: *, direct: *) source

      Applies the given attribute to the target. Has built in logic to check to see if the property is a getter or a setter or a public field, or an event listener, or a factory, or a renderer. If there is a factory or a renderer, we try to evaluate the actual function on basis of the string passed in.

      Params:

      NameTypeAttributeDescription
      target *

      The target to apply the property to
      attr *

      The attribute on the target
      node *

      The value to apply
      direct *

      public applyTheme(themeID: *) source

      Rebuilds the grid based on the current theme

      Params:

      NameTypeAttributeDescription
      themeID *

      public buildFromXml(strXml: *) source

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

      Params:

      NameTypeAttributeDescription
      strXml *

      public calculateRowHeight(item: *, level: *, rowType: *): * source

      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.

      Params:

      NameTypeAttributeDescription
      item *

      The item being displayed
      level *

      The FlexDataGridColumnLevel object that the item belongs to
      rowType *

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

      Return:

      *

      Height of the row

      public cascadeColumnGroups(cg: *) source

      Params:

      NameTypeAttributeDescription
      cg *

      public checkGetterAndRetrieve(target: *, attrName: *): * source

      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,

      Params:

      NameTypeAttributeDescription
      target *
      attrName *

      Return:

      *

      public checkNoDataMessage(force: *) source

      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.

      Params:

      NameTypeAttributeDescription
      force *

      public checkResize(): boolean source

      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.

      Return:

      boolean

      public checkScrollEnabled(evt: *) source

      Params:

      NameTypeAttributeDescription
      evt *

      public checkSetterAndApply(target: *, attrName: *, val: *) source

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

      Params:

      NameTypeAttributeDescription
      target *
      attrName *
      val *

      public clearAllCollections() source

      Clears out the following collections

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

      public clearAllErrors() source

      Clears out all the errors

      public clearAllFilters() source

      Clears filters at all levels and rebuilds the grid.

      public clearAllHighlight() source

      public clearChanges() source

      Sets changes to an empty array.

      public clearColumns(rebuild: *) source

      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.

      Params:

      NameTypeAttributeDescription
      rebuild *

      public clearCurrentHighlight(currentMatchedObject: *) source

      Params:

      NameTypeAttributeDescription
      currentMatchedObject *

      public clearErrorByKey(key: *, fld: *) source

      Clears the errors for the specified key

      Params:

      NameTypeAttributeDescription
      key *
      fld *

      public clearErrorByObject(item: *, fld: *) source

      Similar to clearErrorByKey, except takes the actual object that the key represents.

      Params:

      NameTypeAttributeDescription
      item *
      fld *

      public clearFilter() source

      Clears the filters at all levels

      public clearFlattenedCache() source

      When the dataprovider changes or when new data comes in from the server for lazy loaded grids, you can call this to clear out the flattened cache.

      public clearPreferences() source

      public clearSelection() source

      Clears the selected rows and cells.

      Override:

      NdgBase#clearSelection

      public collapseAll() source

      For nested datagrids, expands all items one level down

      public collapseAllColumnGroups(lvl: *) source

      For grids with column groups, expands them all.

      Params:

      NameTypeAttributeDescription
      lvl *

      public commitProperties() source

      public componentDidMount() source

      Override:

      UIComponent#componentDidMount

      public componentWillReceiveProps(nextProps: *) source

      Override:

      UIComponent#componentWillReceiveProps

      Params:

      NameTypeAttributeDescription
      nextProps *

      public componentWillUnmount() source

      Override:

      UIComponent#componentWillUnmount

      public concatenatePersistenceValues(): * source

      Return:

      *

      public createBodyContainer(): * source

      Method to create an instance of the FlexDataGridBodyContainer class. In case you need to implement custom logic by extending the FlexDataGridBodyContainer you will need to override this method. Creates an instance of FlexDataGridVirtualBodyContainer if enableVirtualScroll, else creates FlexDataGridBodyContainer

      Return:

      *

      public createBuiltinAction(lbl: *, code: *, requiresSelection: *, requiresSingleSelection: *): * source

      Creates a Toolbar Action

      Params:

      NameTypeAttributeDescription
      lbl *

      The label to apply to the action
      code *

      The code to associate with the action
      requiresSelection *
      • optional

      Whether or not the action requires an item to be selected within the grid.
      requiresSingleSelection *
      • optional

      Whether or not the action requires a single item to be selected within the grid.

      Return:

      *

      public createChromeContainer(): * source

      Method to create an instance of the FlexDataGridHeaderContainer class. In case you need to implement custom logic by extending the FlexDataGridHeaderContainer you will need to override this method.

      Return:

      *

      public createColumn(isCheckBox: *): * source

      Params:

      NameTypeAttributeDescription
      isCheckBox *

      Return:

      *

      public createColumnGroup(): flexiciousNmsp.FlexDataGridColumnGroup source

      Return:

      flexiciousNmsp.FlexDataGridColumnGroup

      public createColumnLevel(): flexiciousNmsp.FlexDataGridColumnLevel source

      Return:

      flexiciousNmsp.FlexDataGridColumnLevel

      public createComponents(currentScroll: *) source

      Params:

      NameTypeAttributeDescription
      currentScroll *

      public createElasticContainer(): * source

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

      Return:

      *

      public createFilter(): * source

      Returns the top level filter.

      Return:

      *

      public createLockedContent(): * source

      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

      Return:

      *

      public createPrintComponentFactory(): * source

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

      Return:

      *

      public defaultDynamicLevelHasChildrenFunction(item: *): * source

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

      Params:

      NameTypeAttributeDescription
      item *

      Return:

      *

      public defaultExcelHandlerFunction() source

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

      public defaultExpandCollapseTooltipFunction(cell: *): * source

      If grid.getOpenItems().contains(getItemKey(cell.rowInfo.data)), return the value of expandTooltip else collapseTooltip

      Params:

      NameTypeAttributeDescription
      cell *

      Return:

      *

      public defaultPdfHandlerFunction() source

      Default handler for the Print Button. Calls var po:PrintOptions=PrintOptions.create(true); po.printOptionsViewrenderer = new ClassFactory(ExtendedPrintOptionsView); ExtendedPrintController.instance().print(this.grid,po)

      public defaultPrintHandlerFunction() source

      Default handler for the Print Button. Calls var po:PrintOptions=PrintOptions.create(); po.printOptionsViewrenderer = new ClassFactory(ExtendedPrintOptionsView); ExtendedPrintController.instance().print(this.grid,po)

      public defaultUseSettingsOptionsFunction(): * source

      returns UserSettingsOptions.create(this);

      Return:

      *

      public defaultWordHandlerFunction() source

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

      public dispatchAutoRefreshEvent(event: *) source

      Handle for the auto refresh.

      Params:

      NameTypeAttributeDescription
      event *

      public dispatchEvent(e: *): * source

      Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

      Override:

      EventDispatcher#dispatchEvent

      Params:

      NameTypeAttributeDescription
      e *

      Return:

      *

      public distributeColumnWidthsEqually() source

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

      public dragAcceptReject(cell: *) source

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

      Params:

      NameTypeAttributeDescription
      cell *

      public dragBegin(event: *) source

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

      Params:

      NameTypeAttributeDescription
      event *

      public dragComplete(event: *) source

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

      Params:

      NameTypeAttributeDescription
      event *

      public dragDrop(event: *) source

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

      Override:

      NdgBase#dragDrop

      Params:

      NameTypeAttributeDescription
      event *

      public dragDropInternal(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public dragEnter(event: *) source

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

      Override:

      NdgBase#dragEnter

      Params:

      NameTypeAttributeDescription
      event *

      public dragEnterInternal(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public drawDefaultSeperators() source

      public drawFiller() source

      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.

      public drawFillerCell(section: *, color: *, pointer: *, currx: *, colWidth: *, verticalGridLines: *, verticalGridLineThickness: *, verticalGridLineColor: *, horizontalGridLines: *, horizontalGridLineThickness: *, horizontalGridLineColor: *, rowHt: *, draw: *, colIsInView: *, sectionHorizontalScrollPosition: *): * source

      Params:

      NameTypeAttributeDescription
      section *
      color *
      pointer *
      currx *
      colWidth *
      verticalGridLines *
      verticalGridLineThickness *
      verticalGridLineColor *
      horizontalGridLines *
      horizontalGridLineThickness *
      horizontalGridLineColor *
      rowHt *
      draw *
      colIsInView *
      sectionHorizontalScrollPosition *

      Return:

      *

      public dumpConfig() source

      Dumps the configuration information

      public enableDisableToolbarAction(code: *, enable: *) source

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

      Params:

      NameTypeAttributeDescription
      code *
      enable *

      public ensureLevelsCreated(item: *, level: *) source

      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.

      Params:

      NameTypeAttributeDescription
      item *
      level *

      public executeFunctionByName(functionName: *, context: *): * source

      Params:

      NameTypeAttributeDescription
      functionName *
      context *

      Return:

      *

      public expandAll() source

      For nested datagrids, expands all items one level down

      public expandAllColumnGroups(lvl: *) source

      For grids with column groups, expands them all.

      Params:

      NameTypeAttributeDescription
      lvl *

      public expandChildrenOf(item: *, open: *, level: *) source

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

      Params:

      NameTypeAttributeDescription
      item *

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

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

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

      public expandDown() source

      For nested datagrids, expands all items one level down

      public expandToLevel(level: *, maxItems: *) source

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

      Params:

      NameTypeAttributeDescription
      level *
      maxItems *

      public expandUp() source

      For nested datagrids, expands all items one level up

      public extractAction(actionNode: *, action: *): * source

      Params:

      NameTypeAttributeDescription
      actionNode *
      action *

      Return:

      *

      public extractAction(item: *): * source

      Params:

      NameTypeAttributeDescription
      item *

      Return:

      *

      public extractActionFromObject(item: *): * source

      Method to extract action. Unused

      Params:

      NameTypeAttributeDescription
      item *

      Return:

      *

      public extractActions(actionsNode: *, grid: *) source

      Params:

      NameTypeAttributeDescription
      actionsNode *
      grid *

      public extractCol(colNode: *): * source

      Params:

      NameTypeAttributeDescription
      colNode *

      Return:

      *

      public extractColGroup(cgNode: *): * source

      Params:

      NameTypeAttributeDescription
      cgNode *

      Return:

      *

      public extractColumns(levelNodeChild: *, lvl: *): {"cols": *, "hasColumnGroups": *, "j": *, "colNode": *} source

      Method to extact column information from XML

      Params:

      NameTypeAttributeDescription
      levelNodeChild *
      lvl *

      Return:

      {"cols": *, "hasColumnGroups": *, "j": *, "colNode": *}

      public extractFilters(filtersNode: *, grid: *) source

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

      Params:

      NameTypeAttributeDescription
      filtersNode *
      grid *

      public extractLevel(levelNode: *, lvl: *) source

      Method to extract level information from xml

      Params:

      NameTypeAttributeDescription
      levelNode *
      lvl *

      public flatten(depthRequested: *, inclusive: *, filter: *, page: *, sort: *, max: *): Array source

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

      Params:

      NameTypeAttributeDescription
      depthRequested *

      The depth until which to recurse.
      inclusive *

      Whether to add the parent object to the resulting
      filter *

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

      Whether to page while getting children of parent objects
      sort *

      Whether to sort while getting children of parent objects
      max *

      The maximum number of records to return

      Return:

      Array

      public flattenRecursive(depthRequested: *, result: *, parent: *, level: *, inclusive: *, filter: *, page: *, sort: *) source

      Params:

      NameTypeAttributeDescription
      depthRequested *
      result *
      parent *
      level *
      inclusive *
      filter *
      page *
      sort *

      public generateImageForDrag(cell: *) source

      Generates a snapshot of the row for the drag visual indicator

      Params:

      NameTypeAttributeDescription
      cell *

      public getActionByCode(code: *): * source

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

      Params:

      NameTypeAttributeDescription
      code *

      Return:

      *

      public getAdditionalFilterArgumentsFunction(): * source

      Pointer to the TOP level additionalFilterArgumentsFunction In scenarios where there are detached filters, this function may be used to add on to the list of arguments before the filter is run. The function must take a column level as the only parameter, and return an array collection of the filter expressions.

      Return:

      *

      public getAllErrorString(): * source

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

      Return:

      *

      public getAutoLoadPreferences(): * source

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

      Return:

      *

      public getBodyContainer(): * source

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

      Return:

      *

      public getCanExpandDown(): * source

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

      Return:

      *

      public getCanExpandUp(): * source

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

      Return:

      *

      public getCellBorderFunction(): * source

      Pointer to the TOP level cellBorderFunction 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.

      Return:

      *

      public getCellCustomBackgroundDrawFunction(): * source

      Pointer to the TOP level cellCustomBackgroundDrawFunction 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.

      Return:

      *

      public getCellForRowColumn(data: *, column: *): * source

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

      Params:

      NameTypeAttributeDescription
      data *

      The row data
      column *

      The FlexDataGridColumn

      Return:

      *

      public getCellInDirection(cell: *, direction: *): * source

      Gets the cell in the specified direction of the provided cell

      Params:

      NameTypeAttributeDescription
      cell *

      The cell to start searching at.
      direction *

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

      Return:

      *

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

      public getChanges(): * source

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

      Return:

      *

      public getChildren(object: *, level: *, filter: *, page: *, sort: *): * source

      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

      Params:

      NameTypeAttributeDescription
      object *
      level *
      filter *
      page *
      sort *

      Return:

      *

      public getChildrenCountField(): * source

      Pointer to the TOP level childrenCountField 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.

      Return:

      *

      public getChildrenField(): * source

      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

      Return:

      *

      public getChildrenLength(object: *, level: *, filter: *, page: *, sort: *): * source

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

      Params:

      NameTypeAttributeDescription
      object *
      level *
      filter *
      page *
      sort *

      Return:

      *

      public getClassNames(): string[] source

      Override:

      NdgBase#getClassNames

      Return:

      string[]

      public getColSpanFunction(): * source

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

      Since this function is defined on the grid, it will get a IFlexDataGridCell object that you should use to return a rowSpan or colSpan.

      Return:

      *

      public getColumnByDataField(fld: *): * source

      Returns the column with the specified datafield, only at the root level

      Params:

      NameTypeAttributeDescription
      fld *

      Return:

      *

      public getColumnByUniqueIdentifier(fld: *): * source

      Returns the column with the specified UniqueIdentifier, only at the root level

      Params:

      NameTypeAttributeDescription
      fld *

      Return:

      *

      public getColumnCount(): * source

      Returns the top level columnCount

      Return:

      *

      public getColumnGroups(): * source

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

      Return:

      *

      public getColumnLevel(): * source

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

      The FlexDataGridColumnLevel class has a "nextLevel" property, which is a pointer to another instance of the same class, or a "nextLevelRenderer" property, which is a reference to a ClassFactory the next level. Please note, currently, if you specify nextLevelRenderer, the nextLevel is ignored. This means, at the same level, you cannot have both a nested subgrid as well as a level renderer.

      Return:

      *

      public getColumnNames(): * source

      Returns the top level column names

      Return:

      *

      public getColumns(): * source

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

      Return:

      *

      public getContainerForCell(cell: *): * source

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

      Params:

      NameTypeAttributeDescription
      cell *

      The IFlexDataGridCell object to get the container for.

      Return:

      *

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

      • headerContainer
      • filterContainer
      • footerContainer
      • pagerContainer
      • bodyContainer

      public getContainerInDirection(container: *, up: *): * source

      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.

      Params:

      NameTypeAttributeDescription
      container *

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

      Whether to return the section above or below

      Return:

      *

      A FlexDataGridContainerBase object

      public getContainerName(container: *): string source

      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

      Params:

      NameTypeAttributeDescription
      container *

      The container to look for.

      Return:

      string

      public getCornerY(comp: *): * source

      Corner areas are special containers that exist to hold filter and header on the top and Pager and Footer on the bottom If I am filter cell, return 0 if filter is above header (true always) IF I am header cell, return filterHeight + (headerHeight * header Depth) If I am footer cell, return 0 If I am pager cell, return pager footer height

      Params:

      NameTypeAttributeDescription
      comp *

      Return:

      *

      public getCurrentEditCell(): * source

      Gets the cell that is currently being edited.

      Return:

      *

      public getCurrentEditor(): * source

      Gets the editor that is currently being edited.

      Return:

      *

      public getCurrentMatch(): Number source

      The index of the currently matched object

      Return:

      Number

      public getCurrentPreferenceInfo(): * source

      When enableMultiplePreferences = true, this represents the currently applied preference

      Return:

      *

      public getCurrentSorts(): * source

      Return the FilterSort objects at the top level

      Return:

      *

      public getCurrentTooltip(): * source

      The current tooltip object.

      Return:

      *

      public getCurrentTooltipTrigger(): * source

      The current tooltip object trigger.

      Return:

      *

      public getDataForPrintExport(printOptions: PrintOptions): * source

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

      Params:

      NameTypeAttributeDescription
      printOptions PrintOptions
      • optional

      Return:

      *

      public getDataProvider(): * source

      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.

      Return:

      *

      public getDataProviderNoFilters(): * source

      Returns the TOP level data without any filters.

      Return:

      *

      public getDataProviderNoPaging(): * source

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

      Return:

      *

      public getDisabledField(): * source

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

      Return:

      *

      public getDisplayOrder(): * source

      A comma seperated list of the following strings: filter,header,body,footer,pager.

      Changes the order in which the grid displays the filter,header,body,footer,pager The order in which the various sections of the grid are laid out.

      Defaults to pager,filter,body,footer

      Return:

      *

      public getDragColumn(): * source

      The column that initiated the drag

      Return:

      *

      public getElementToCenter(): * source

      The element of the owner that should be used to center the spinner.

      Return:

      *

      public getElementsToBlur(): undefined[] source

      All elements of the spinner owner that should be blurred when the spinner is active. The alpha of this element will be set to the spinnerGridAlpha style or 0.3.

      Return:

      undefined[]

      public getEnableFilters(): * source

      Flag that indicates whether or not to show the filter

      Return:

      *

      public getEnableFooters(): * source

      Flag that indicates whether or not to show the footer

      Return:

      *

      public getEnablePaging(): * source

      Flag to indicate whether or not to enable paging functionality

      Return:

      *

      public getEnableRowNumbers(): * source

      Flag to embed a column that shows row numbers

      Return:

      *

      public getEnableSplitHeader(): Boolean source

      When enableMultiColumnSort=true, setting this flag to on will enable AdvancedDataGrid like Split headers to enable multi column sort.

      Return:

      Boolean

      public getError(item: *): * source

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

      Params:

      NameTypeAttributeDescription
      item *

      Return:

      *

      public getExpandCollapseCellRenderer(): * source

      Pointer to the TOP level expandCollapseCellRenderer

      Return:

      *

      public getExpandCollapseHeaderCellRenderer(): * source

      Pointer to the TOP level expandCollapseHeaderCellRenderer

      Return:

      *

      public getExportController(): * source

      Returns the export controller instance

      Return:

      *

      public getExportableColumns(exportOptions: *): * source

      Returns all columns at all levels.

      Params:

      NameTypeAttributeDescription
      exportOptions *

      Return:

      *

      public getExportableColumns(): * source

      Returns the columns where excludeFromExport=false

      Return:

      *

      public getExportableColumnsAtAllLevel(exportOptions: *): * source

      Returns all columns at all levels.

      Params:

      NameTypeAttributeDescription
      exportOptions *

      Return:

      *

      public getFilterArguments(): * source

      Returns the filter at the top level.

      Return:

      *

      public getFilterColumn(searchField: *): * source

      Gets the column with the specified search field

      Params:

      NameTypeAttributeDescription
      searchField *

      Return:

      *

      public getFilterContainer(): * source

      The container for the filter 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 FlexDataGridFilterCell Although the parent property of each of the cells could be either the leftLockedHeader, rightLockedHeader or the this.getFilterContainer(), the rowInfo is the same, so the cells will include left, right, and unlocked cells.

      Return:

      *

      public getFilterFunction(): * source

      Pointer to the TOP level filterFunction

      Return:

      *

      public getFilterPageSortMode(): * source

      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.grids.events.FilterPageSortChangeEvent named filterPageSortChange that should be used to construct an appropriate query to be sent to the backend.

      Return:

      *

      See:

      public getFilterRowHeight(): * source

      Sets the filter row height at the top level.

      Return:

      *

      public getFilterRows(): * source

      Returns an array of RowInfo objects in the filter row.

      Return:

      *

      public getFilterValue(col: *): * source

      Used to set the initial value of the filter at the top level for the specified field.

      Params:

      NameTypeAttributeDescription
      col *

      The column to set filter for

      Return:

      *

      public getFilterVisible(): * source

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

      Return:

      *

      public getFilterX(renderer: *): * source

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

      Params:

      NameTypeAttributeDescription
      renderer *

      Return:

      *

      public getFilteredPagedSortedData(dictionary: *, applyFilter: *, applyPaging: *, applySort: *, pages: *): * source

      Returns the data provider, with filter, paging and sorting applied on basis of the boolean flags specified. The passed in dictionary contains a map of each item in the resulting collection to the level that it belongs to.

      Params:

      NameTypeAttributeDescription
      dictionary *

      Map of each item in the resulting collection to the level that it belongs to
      applyFilter *

      Whether or not to apply the filter
      applyPaging *

      Whether or not to apply paging
      applySort *

      Whether or not to apply sort
      pages *

      Which pages to get, only needed if you want a page range. specify null(default) if you want only the current page.

      Return:

      *

      A flat array of all items that match the criteria generated on basis of the parameters above.

      public getFooterContainer(): * source

      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.

      Return:

      *

      public getFooterRowHeight(): * source

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

      Return:

      *

      public getFooterRows(): * source

      Returns an array of RowInfo objects in the footer row.

      Return:

      *

      public getFooterVisible(): * source

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

      Return:

      *

      public getForcePagerRow(): * source

      Flag to force appearance of the pager row even with enablePaging=false.

      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.

      Return:

      *

      public getGlobalFilterColumns(): Array source

      A list of columns that the global search uses to search. If no columns are defined, all columns are searched.

      Return:

      Array

      public getGlobalFilterString(): String source

      Return:

      String

      public getGlobalHighlightColumns(): Array source

      Array to search for when highlighting a term in specific columns

      Return:

      Array

      public getGlobalHightlightAll(): Array source

      A Boolean variable that tells us whether to highlight just the first occurence or all occurences

      Return:

      Array

      public getGlobalHightlightString(): String source

      A String to highlight in the grid.

      Return:

      String

      public getGridPreferencesInfo(): * source

      When enableMultiplePreferences = true, this represents a list of all preferences saved for this grid.

      Return:

      *

      public getGroupedColumns(): * source

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

      Return:

      *

      public getHasFilterFunction(): * source

      returns true if any of the levels have a filter function

      Return:

      *

      public getHasGroupedColumns(): * source

      Added for Persistence support

      Return:

      *

      public getHasRowSpanOrColSpan(): * source

      If rowSpanFunction!=null or colSpanFunction!=null

      Return:

      *

      public getHeaderContainer(): * source

      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.

      Return:

      *

      public getHeaderRowHeight(): * source

      Pointer to the TOP level headerHeight Height of the header for this level. Defaults to 25

      Return:

      *

      public getHeaderSectionHeight(): * source

      Returns the sum of:
      If enableFilters, then filterRowHeight else 0 plus
      headerHeight

      Return:

      *

      public getHeaderSeperatorWidth(): * source

      Pointer to the TOP level headerSeparatorWidth Width to show the resize indicator between columns. Defaults to 4

      Return:

      *

      public getHeaderSortSeparatorRight(): * source

      Gets the value of the headerSortSeparatorRight property

      Return:

      *

      public getHeaderVisible(): * source

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

      Return:

      *

      public getHeight(): Number source

      Gets the height of this component

      Override:

      UIComponent#getHeight

      Return:

      Number

      public getHorizontalScrollBar(): * source

      The horizontal 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.

      Return:

      *

      public getHorizontalScrollPolicy(): * source

      Whether or not to show the horizontal scroll bar.

      Please note, this behavior also controls the behavior when a column is resized. If horizontalScrollPolicy is "none", increasing the size of a column reduces the size of other columns in the grid. Decreasing the size does the opposite. This makes the grid have a predictable width, and eliminates the need for a horizontal scroll bar.

      Default is "off", but if you specify any column as left or right locked, it becomes auto.

      Override:

      UIComponent#getHorizontalScrollPolicy

      Return:

      *

      public getHorizontalScrollPosition(): * source

      The horizontal scroll position of the body container.

      Override:

      UIComponent#getHorizontalScrollPosition

      Return:

      *

      public getInitialSortAscending(): * source

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

      Return:

      *

      public getInitialSortField(): * source

      The property of the object on this level that should be used in the default sort at the root level. In nested levels, this property can be set on inner levels as well.

      Return:

      *

      public getIsClientFilterPageSortMode(): * source

      Returns true if the top column level filterPageSortMode is client.

      Return:

      *

      public getIsScrolling(): * source

      Return:

      *

      public getItemAtPosition(position: *): * source

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

      Params:

      NameTypeAttributeDescription
      position *

      Return:

      *

      public getItemFilter(level: *, item: *): * source

      Params:

      NameTypeAttributeDescription
      level *
      item *

      Return:

      *

      public getItemLoadMode(): * source

      Pointer to the TOP level itemLoadMode

      Return:

      *

      public getLeftLockedContent(): * source

      The container for the left locked data cells. This is an instance of the ElasticContainer class, which basically attaches to the owner component (which is the bodyContainer) and scrolls vertically along with it. The horizontal scroll of this component is set to off)

      To access all the data cells, please use the rows collection of the bodyContainer This contains RowInfo objects, which contains a cells collection. The cells collection contains ComponentInfo objects, that has a component property, which is an instance of one of the subclasses of FlexDataGridCell. The cell will have a renderer property which is the actual UI control that is being displayed.

      Return:

      *

      public getLeftLockedFooter(): * source

      The container for the left locked footer cells. This is an instance of the LockedContent class, which basically is an extended UIComponent that manages the filter and footer cell visiblity, heights, and the y positions.

      To access all the footer cells, please use the rows collection of the footerContainer This contains a single RowInfo object, which contains a cells collection. The cells collection contains ComponentInfo objects, that has a component property, which is an instance of one of the subclasses of FlexDataGridCell. The cell will have a renderer property which is the actual UI control that is being displayed.

      Return:

      *

      public getLeftLockedHeader(): * source

      The container for the left locked filter and header cells. This is an instance of the LockedContent class, which basically is an extended UIComponent that manages the filter and footer cell visiblity, heights, and the y positions.

      To access all the filter/header cells, please use the rows collection of the headerContainer or filterContainer. This contains a single RowInfo object, which contains a cells collection. The cells collection contains ComponentInfo objects, that has a component property, which is an instance of one of the subclasses of FlexDataGridCell. The cell will have a renderer property which is the actual UI control that is being displayed.

      Return:

      *

      public getLength(arr: *): * source

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

      Params:

      NameTypeAttributeDescription
      arr *

      Return:

      *

      public getLevel(levelDepth: *): * source

      Returns FlexDataGridColumnLevel object at the specified depth

      Params:

      NameTypeAttributeDescription
      levelDepth *

      Return:

      *

      public getLevelAtNestDepth(depth: *): * source

      Params:

      NameTypeAttributeDescription
      depth *

      Return:

      *

      public getLevelForItem(itemToFind: *, flat: *, level: *): * source

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

      Params:

      NameTypeAttributeDescription
      itemToFind *
      flat *
      level *

      Return:

      *

      public getLevelRendererHeight(): * source

      Pointer to the TOP level levelRendererHeight 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.

      Return:

      *

      public getLocalName(node: *): * | String | * source

      IE does not know localName, it knows baseName.

      Params:

      NameTypeAttributeDescription
      node *

      Return:

      * | String | *

      public getLockedColumnCount(): * source

      Unused/Not Applicable. For legacy purposes only

      Return:

      *

      public getLockedColumnWidth(): * source

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

      Return:

      *

      public getMatchedObjects(): Array source

      Return:

      Array

      public getMaxDepth(): * source

      Returns the max depth possible for nested datagrids

      Return:

      *

      public getMaxHorizontalScrollPosition(): * source

      The max horizontal scroll position of the bodyContainer

      Return:

      *

      public getMultiSortRenderer(): * source

      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.

      Return:

      *

      public getNamedContainer(name: *): * source

      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

      Params:

      NameTypeAttributeDescription
      name *

      Return:

      *

      public getNestIndent(): * source

      Pointer to the TOP level nestIndent The indentation to apply to each progressive nest level.

      Return:

      *

      public getNestIndentPaddingCellRenderer(): * source

      Pointer to the TOP level nestIndentPaddingCellRenderer Container for the nest indent padding cell. Needs to inherit from FlexDataGridExpandCollapseHeaderCell.
      Defaults to FlexDataGridExpandCollapseCell

      Return:

      *

      public getNewIndex(lcw: *, item: *, direction: *): * source

      Params:

      NameTypeAttributeDescription
      lcw *
      item *
      direction *

      Return:

      *

      public getNextLevelRenderer(): * source

      Pointer to the TOP level nextLevelRenderer

      Return:

      *

      public getOpenItemCount(cell: *): * source

      Given a cell if it is a datarow, and it is associated with a column and the column is at the nest level of the cell, and the column is left locked and the data item bound to the cell is open, then will return the recursive count of all open items under this cell.

      Params:

      NameTypeAttributeDescription
      cell *

      The cell to check

      Return:

      *

      integer

      public getOpenItems(): * source

      this method was deprecated. Please use the getOpenKeys and getOpenItems instead.

      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.

      Return:

      *

      public getOpenKeys(): * source

      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.

      Return:

      *

      public getOpenObjects(): * source

      Returns a copy of the open items array.

      Return:

      *

      public getPageIndex(): * source

      Page index at the top level.

      Return:

      *

      public getPageSize(): * source

      The page size of the top(root) level. To control page sizes at inner levels, set the pageSize property on the inner level.

      Return:

      *

      public getPager(): * source

      Returns the top level pager

      Return:

      *

      public getPagerCellRenderer(): * source

      Pointer to the TOP level pagerCellRenderer Container for the footer renderer. Needs to inherit from FlexDataGridPagerCell.
      Defaults to FlexDataGridPagerCell

      Return:

      *

      public getPagerContainer(): * source

      The container for the pager cells. This is an instance of the FlexDataGridHeaderContainer class. This will contain a rows collection, which will contain a single RowInfo object. The Single RowInfo object has a cells Collection that will contain a single FlexDataGridPagerCell. The actual IPager is the renderer property of the FlexDataGridPagerCell.

      Return:

      *

      public getPagerControl(): * source

      Returns the pager control at the root level.

      Return:

      *

      public getPagerRenderer(): * source

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

      Return:

      *

      See:

      public getPagerRowHeight(): * source

      Gets the pager row height at the top level.

      Return:

      *

      public getPagerVisible(): * source

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

      Return:

      *

      public getParent(object: *, level: *): * source

      Returns the parent object for the passed in object. Please note, if your data provider is xml or hierarchical collection view, grid will use the getParent method or getParentItem method on such data providers respectively. If you have specified a parentField, which is a pointer on the object that points back to the parent, the grid will use that. If none of the above is true, the grid will use its built in map of hierarchical data, but this has a limitation of only being able to return parents of items that are on the current page of data.

      Params:

      NameTypeAttributeDescription
      object *
      level *

      Return:

      *

      public getParentContainer(cell: *): * source

      Returns the container for the given cell

      Params:

      NameTypeAttributeDescription
      cell *

      Return:

      *

      public getPeristenceKey(): * source

      String value that uniquely identifies this grid across the application. If you have multiple grids' with enablePreferencePersistence, and they happen to share the same value for the id field, e.g. id="grid1" they might overwrite each others' preferences. To combat this situation, we provide a property, which defaults to the id of the grid, but you can override to provide a globally unique key.

      Return:

      *

      public getPreferencePersistenceKey(): * source

      String value that uniquely identifies this grid across the application. If you have multiple grids' with enablePreferencePersistence, and they happen to share the same value for the id field, e.g. id="grid1" they might overwrite each others' preferences. To combat this situation, we provide a property, which defaults to the id of the grid, but you can override to provide a globally unique key.

      Return:

      *

      public getPreferences(): * source

      Returns an XML representation of the preferences specified in the preferencesToPersist property and values being the actual values. When

      Return:

      *

      public getPreferencesLoaded(): * source

      Returns true if the load preferences has been called.

      Return:

      *

      public getPreservePager(): * source

      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.

      Return:

      *

      public getPrintController(): * source

      Returns the print controller instance

      Return:

      *

      public getPrintableColumns(options: *): * source

      Params:

      NameTypeAttributeDescription
      options *

      Return:

      *

      public getRecursiveOpenItemCount(children: *, nextLevel: *): * source

      Params:

      NameTypeAttributeDescription
      children *
      nextLevel *

      Return:

      *

      public getRightLockedContent(): * source

      The container for the right locked data cells. This is an instance of the ElasticContainer class, which basically attaches to the owner component (which is the bodyContainer) and scrolls vertically along with it. The horizontal scroll of this component is set to off)

      To access all the data cells, please use the rows collection of the bodyContainer This contains RowInfo objects, which contains a cells collection. The cells collection contains ComponentInfo objects, that has a component property, which is an instance of one of the subclasses of FlexDataGridCell. The cell will have a renderer property which is the actual UI control that is being displayed.

      Return:

      *

      public getRightLockedFooter(): * source

      The container for the right locked footer cells. This is an instance of the LockedContent class, which basically is an extended UIComponent that manages the filter and footer cell visiblity, heights, and the y positions.

      To access all the footer cells, please use the rows collection of the footerContainer. This contains a single RowInfo object, which contains a cells collection. The cells collection contains ComponentInfo objects, that has a component property, which is an instance of one of the subclasses of FlexDataGridCell. The cell will have a renderer property which is the actual UI control that is being displayed.

      Return:

      *

      public getRightLockedHeader(): * source

      The container for the right locked filter and header cells. This is an instance of the LockedContent class, which basically is an extended UIComponent that manages the filter and footer cell visiblity, heights, and the y positions.

      To access all the filter/header cells, please use the rows collection of the headerContainer or this.getFilterContainer(). This contains a single RowInfo object, which contains a cells collection. The cells collection contains ComponentInfo objects, that has a component property, which is an instance of one of the subclasses of FlexDataGridCell. The cell will have a renderer property which is the actual UI control that is being displayed.

      Return:

      *

      public getRightLockedWidth(): * source

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

      Return:

      *

      public getRootFilter(): * source

      Gets the filter at the root level

      Return:

      *

      public getRootFlat(): * source

      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.

      Return:

      *

      public getRowCount(): * source

      Returns the number of rows currently visible.

      Return:

      *

      public getRowDisabledFunction(): * source

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

      Return:

      *

      public getRowHeight(): * source

      Height of the row for this level. Defaults to 25

      Return:

      *

      public getRowSelectableFunction(): * source

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

      Return:

      *

      public getRowSpanBasedOnOpenItemCount(cell: *): * source

      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.

      Params:

      NameTypeAttributeDescription
      cell *

      Return:

      *

      public getRowSpanFunction(): * source

      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.

      Return:

      *

      public getRowText(item: Object, cols: Array): String source

      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

      Params:

      NameTypeAttributeDescription
      item Object
      cols Array

      Return:

      String

      return string value

      public getSelectAllState(): * source

      If all items from the top level are selected, returns TriStateCheckBox.STATE_CHECKED. If none are selected, returns TriStateCheckBox.STATE_UNCHECKED else returns TriStateCheckBox.STATE_MIDDLE

      Return:

      *

      public getSelectableField(): * source

      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.

      Return:

      *

      public getSelectedField(): * source

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

      Return:

      *

      public getSelectedIndex(): * source

      Only applicable for flat grids. Selectd Index holds no meaning for hierarchical grids. This function will run a filter Returns dataProvider.indexOf(selectedObjects(0))

      Return:

      *

      public getSelectedIndices(): * source

      Returns dataProvider.indexOf(selectedObjects(0))

      Return:

      *

      public getSelectedItem(): * source

      Returns (selectedObjects(0)).

      Return:

      *

      public getSelectedItems(): * source

      Returns the top level selectedObjects

      Return:

      *

      public getSelectedKeyField(): * source

      The concept of selection in Flexicious Ultimate is much more powerful as compared to the basic SDK datagrids in the following ways:

      • First, It supports selection independant of dataprovider, so when a row is selected in the grid, we store the the selected object in the selectedObects array collection. 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.

      Return:

      *

      public getSelectedKeys(): * source

      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

      Return:

      *

      public getSelectedKeys(): * source

      For nested datagrids, used to get all records at all levels. Please see the documentation of setSelectedKeys for instructions on maintaining grid selection post a data provider refresh.

      Return:

      *

      public getSelectedObjects(getKey: *, unSelected: *): * source

      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.

      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.

      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.selectedObjectsAtAllLevels to get selected objects at all levels.

      Params:

      NameTypeAttributeDescription
      getKey *
      unSelected *

      Return:

      *

      public getSelectedObjectsTopLevel(): * source

      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.

      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.

      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.getColumnLevel().nextLevel...nextLevel.selectedKeys You can also call grid.getSelectedObjects to get selected objects at all levels.

      Return:

      *

      public getSelectionInfo(): * source

      Support for selection based on exclusion. In scenarios 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. Selection

      Return:

      *

      public getSettingsColumns(): * source

      Returns the columns where excludeFromSettings=false

      Return:

      *

      public getSortableColumns(): * source

      Returns the columns where excludeFromExport=false

      Return:

      *

      public getSpinnerParent(): * source

      The parent to add the spinner to.

      Return:

      *

      public getThemeToolbarIconFolder(): * source

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

      Return:

      *

      public getToolbarActionAddRow(): * source

      Returns the built in Add Row Action

      Return:

      *

      public getToolbarActionButton(code: *): * source

      Gets the actual button object for the provided toolbar action.

      Params:

      NameTypeAttributeDescription
      code *

      Return:

      *

      public getToolbarActionDelete(): * source

      Returns the built in Delete Action

      Return:

      *

      public getToolbarActionEdit(): * source

      Returns the built in Edit Action

      Return:

      *

      public getToolbarActionFilter(): * source

      Returns the built in Filter Action

      Return:

      *

      public getToolbarActionMoveDown(): * source

      Returns the built in moveDown Action

      Return:

      *

      public getToolbarActionMoveTo(): * source

      Returns the built in Move to Action

      Return:

      *

      public getToolbarActionMoveUp(): * source

      Returns the built in moveUp Action

      Return:

      *

      public getToolbarActionSeparator(): * source

      Returns the built in moveUp Action

      Return:

      *

      public getToolbarActionSort(): * source

      Returns the built in Edit Action

      Return:

      *

      public getTotalRecords(): * source

      The total number of records at the root level (needs to be set only in server mode, because there is no way for the grid to know how many records on the server match the filter criteria) In client mode, the count of the data provider is used instead.

      Return:

      *

      public getTraceRows(): * source

      Return:

      *

      public getUnSelectedKeys(): * source

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

      Return:

      *

      public getUseElements(): boolean source

      Whether to use addElement or addChild;

      Return:

      boolean

      public getUserSettingsController(): * source

      Return:

      *

      public getVerticalScrollBar(): * source

      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.

      Return:

      *

      public getVerticalScrollBarOffset(): * source

      Not used.

      Return:

      *

      public getVerticalScrollPosition(): * source

      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.

      Override:

      UIComponent#getVerticalScrollPosition

      Return:

      *

      public getVerticalSpill(): * source

      Return:

      *

      public getVirtualBodyContainer(): * source

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

      Specialized getter when enableVirtualScroll=true

      Return:

      *

      public getVirtualScrollDelay(): * source

      Delay in milliseconds before "virtualScroll" event is dispatched.

      Return:

      *

      public getVisibleColumns(): * source

      Returns the columns where visible=true

      Return:

      *

      public getWidth(): Number source

      Gets the height of this component

      Override:

      UIComponent#getWidth

      Return:

      Number

      public getprintExportData(): * source

      This is not used.

      Return:

      *

      public globalFilterFunction(item: *): * source

      A global filter function that matches against gloalSearchString

      Params:

      NameTypeAttributeDescription
      item *

      Item to match

      Return:

      *

      Whether or not the item exists in the dataprovider.

      public gotoHorizontalPosition(vsp: *) source

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

      Params:

      NameTypeAttributeDescription
      vsp *

      public gotoItem(item: *, highlight: *, level: *) source

      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.

      Params:

      NameTypeAttributeDescription
      item *
      highlight *
      level *

      public gotoKey(key: *, highlight: *, level: *) source

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

      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.

      Params:

      NameTypeAttributeDescription
      key *
      highlight *
      level *

      public gotoNextHighlight(backwards: *) source

      Handler for the next highlight

      Params:

      NameTypeAttributeDescription
      backwards *

      public gotoRow(rowIndex: *) source

      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.

      Params:

      NameTypeAttributeDescription
      rowIndex *

      public gotoVerticalPosition(vsp: *) source

      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.

      Params:

      NameTypeAttributeDescription
      vsp *

      public hideSpinner() source

      public hideTooltip() source

      Hides the current tooltip.

      public highlightRow(cell: *, row: *, highLight: *, highLightColor: *) source

      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.

      Params:

      NameTypeAttributeDescription
      cell *

      The IFlexDataGridCell to highligh or remove the highlight from
      row *

      The rowInfo object associated with this cell.
      highLight *

      Whether to add a highlight or remove the highlight
      highLightColor *

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

      public initialize() source

      Initializes the auto complete and watermark plugins

      Override:

      UIComponent#initialize

      public invalidateCells() source

      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.

      public invalidateDisplayList() source

      This method will queue the component so the display list will render it once the current frame of execution is over.

      Override:

      UIComponent#invalidateDisplayList

      public invalidateFiller() source

      Queues a call to drawFiller in the next validation cycle

      public invalidateHorizontalScroll() source

      Called when you scroll and expand collapse. When you do this, previously drawn rows may have been drawn with a different horizontal scroll position. So the cells that are currently in view may not have been drawn. This method will ensure that a pass at the horizontal recycle runs at the next update and we render the correct cells.

      public invalidateList() source

      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.

      public invalidateSelection() source

      public isCtrlKeyDownOrSticky(event: *): * source

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

      Params:

      NameTypeAttributeDescription
      event *

      Return:

      *

      public isInVisibleHorizontalRange(x: *, wwidth: *): Boolean source

      Returns true if the passed in cordinates are in the visible ViewPort

      Params:

      NameTypeAttributeDescription
      x *
      wwidth *

      Return:

      Boolean

      public isToolbarActionValid(action: *, currentTarget: *, extendedPager: *): boolean source

      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.

      Params:

      NameTypeAttributeDescription
      action *
      currentTarget *
      extendedPager *

      Return:

      boolean

      public itemsQuickFind(whatToFind: String, flat: Object, level: FlexDataGridColumnLevel, result: Array, searchCols: Array, breakAfterFind: Boolean, captureCols: Boolean, flatIndex: Number): * source

      Params:

      NameTypeAttributeDescription
      whatToFind String
      flat Object
      level FlexDataGridColumnLevel
      result Array
      searchCols Array
      breakAfterFind Boolean
      captureCols Boolean
      flatIndex Number

      Return:

      *

      public keyDownHandler(event: *) source

      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

      Params:

      NameTypeAttributeDescription
      event *

      public keyUpOrDown(keyCode: *) source

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

      Params:

      NameTypeAttributeDescription
      keyCode *

      public kill() source

      Cleanup method

      Override:

      UIComponent#kill

      public loadPreferences() source

      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.

      public measure() source

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

      public measureCellHeight(col: *, paddingLeft: *, paddingRight: *, paddingTop: *, paddingBottom: *, itemRenderer: *, ht: *, txt: *, item: *, styl: *, isHeader: *): * source

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

      Params:

      NameTypeAttributeDescription
      col *

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

      The left padding to apply while calculating the height
      paddingRight *

      The right padding to apply while calculating the height
      paddingTop *

      The top padding to apply while calculating the height
      paddingBottom *

      The bottom padding to apply while calculating the height
      itemRenderer *

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

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

      The text to render.
      item *

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

      Apply style to the item
      isHeader *

      Return:

      *

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

      public multiColumnSortGetTooltip(cell: *): * source

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

      Params:

      NameTypeAttributeDescription
      cell *

      Return:

      *

      public multiColumnSortShowPopup() source

      Creates an instance of the multiSortRenderer and pushes it into view

      public onCellContextMenuItemClick(event: *) source

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

      Params:

      NameTypeAttributeDescription
      event *

      public onContainerScroll(evt: *) source

      Params:

      NameTypeAttributeDescription
      evt *

      public onContextMenuSelect(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public onCreationComplete(event: *) source

      Override:

      NdgBase#onCreationComplete

      Params:

      NameTypeAttributeDescription
      event *

      public onDoubleClick(event: *) source

      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.

      Params:

      NameTypeAttributeDescription
      event *

      public onDragEnd(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public onDragMove(evt: *) source

      Params:

      NameTypeAttributeDescription
      evt *

      public onGridMouseOut(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public onGridResized(event: *) source

      On grid resized, we reposition the cells.

      Override:

      NdgBase#onGridResized

      Params:

      NameTypeAttributeDescription
      event *

      public onMouseWheel(event: *) source

      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.

      Params:

      NameTypeAttributeDescription
      event *

      public onRootFilterChange(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public onRootPageChange(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public onRowContextMenuItemClick(event: *) source

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

      Params:

      NameTypeAttributeDescription
      event *

      public onScrollTimerComplete(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public onTableContextMenuItemClick(event: *) source

      Params:

      NameTypeAttributeDescription
      event *

      public parse(strXml: *, grid: *) source

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

      Params:

      NameTypeAttributeDescription
      strXml *
      grid *

      public pauseKeyboardListeners(filterRenderer: *) source

      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.

      Params:

      NameTypeAttributeDescription
      filterRenderer *

      public persistPreferences(name: *, isDefault: *) source

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

      Params:

      NameTypeAttributeDescription
      name *
      isDefault *

      public placeBottomBar() source

      When you have left or right locked sections, the scroll bar only covers the area occupied by the body container, or the unlocked columns section. So we do not show a blank whitespace in the area of the scroll bar in the locked sections, we place two sprites there, and this method is responsible for drawing and positioning these sprites.

      public placeChildComponents(components: *) source

      Params:

      NameTypeAttributeDescription
      components *

      public placeComponent(comp: *) source

      Params:

      NameTypeAttributeDescription
      comp *

      public placeComponents(row: *) source

      Params:

      NameTypeAttributeDescription
      row *

      public placeSections() source

      The grid is composed of the following sections:

      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.

      public processFilter() source

      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.

      public processRootFilter(triggerEvent: *) source

      Params:

      NameTypeAttributeDescription
      triggerEvent *

      public processSort(sorts: *) source

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

      Params:

      NameTypeAttributeDescription
      sorts *

      public quickFind(whatToFind: *): * source

      Iterates through the data provider to get a list of row positions that match the text provided.

      Params:

      NameTypeAttributeDescription
      whatToFind *

      Return:

      *

      public rebuildBody(vupdateTotalRecords: *) source

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

      Params:

      NameTypeAttributeDescription
      vupdateTotalRecords *

      public rebuildFilter() source

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

      public rebuildFooter() source

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

      public rebuildHeader() source

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

      public rebuildPager() source

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

      public recycleH(right: *) source

      Params:

      NameTypeAttributeDescription
      right *

      public redrawBody() source

      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.

      public refreshCells() source

      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.

        public refreshCheckBoxes() source

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

        public removeAllSorts() source

        Removes all the sorts and calls doInvalidate.

        public removeColumn(col: *) source

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

        Params:

        NameTypeAttributeDescription
        col *

        public removePopup(component: *) source

        Params:

        NameTypeAttributeDescription
        component *

        public removeToolbarAction(code: *) source

        Params:

        NameTypeAttributeDescription
        code *

        public runToolbarAction(action: *, currentTarget: *, extendedPager: *) source

        Runs the given toolbar action. Dispatches the toolbarActionExecuted event. If you call prevent default in this event, the default handling code does not execute.

        Params:

        NameTypeAttributeDescription
        action *
        currentTarget *
        extendedPager *

        public scrollToExistingRow(vsp: *, scrollDown: *) source

        Scrolls to the row that appears at the specified vertical position

        Params:

        NameTypeAttributeDescription
        vsp *

        Vertical Position to Scroll to
        scrollDown *

        Whether you are scrolling up or down

        public selectText(txt: *) source

        Selects the provided text in the currently visible cells that have the default item renderer, or if the item renderer has the selection property

        Params:

        NameTypeAttributeDescription
        txt *

        public setAdditionalFilterArgumentsFunction(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setCellBorderFunction(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setCellCustomBackgroundDrawFunction(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setChildData(item: *, children: *, level: *, totalRecords: *, useSelectedKeyField: *) source

        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.

        Params:

        NameTypeAttributeDescription
        item *

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

        The list of items to add to the children collection of the item being expanded
        level *

        The parent level (the level at which the item object is located).
        totalRecords *

        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
        useSelectedKeyField *

        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.

        public setChildrenCountField(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setChildrenField(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setColSpanFunction(value: *) source

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

        Since this function is defined on the grid, it will get a IFlexDataGridCell object that you should use to return a rowSpan or colSpan.

        Params:

        NameTypeAttributeDescription
        value *

        public setColumnLevel(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setColumns(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setContextMenuShownFalse() source

        public setCurrentPreferenceInfo(val: *, applyPreferences: *) source

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

        Params:

        NameTypeAttributeDescription
        val *
        applyPreferences *

        public setDataProvider(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setDisabledField(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setDisplayOrder(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setDragDropCompleteFunction(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setEditedItemPosition(rowIndex: *, colIndex: *) source

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

        Params:

        NameTypeAttributeDescription
        rowIndex *
        colIndex *

        public setEnableFilters(enabled: *) source

        Params:

        NameTypeAttributeDescription
        enabled *

        public setEnableFooters(enabled: *) source

        Params:

        NameTypeAttributeDescription
        enabled *

        public setEnablePaging(enabled: *) source

        Params:

        NameTypeAttributeDescription
        enabled *

        public setEnablePdf(enabled: *) source

        Params:

        NameTypeAttributeDescription
        enabled *

        public setEnablePrint(enabled: *) source

        Params:

        NameTypeAttributeDescription
        enabled *

        public setEnableRowNumbers(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setEnableSplitHeader(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setEnabled(value: *) source

        Sets the enabled flag

        Override:

        UIComponent#setEnabled

        Params:

        NameTypeAttributeDescription
        value *

        public setErrorByKey(key: *, fld: *, errorMsg: *) source

        On grids that allow for tracking errors, call this method to highlight the error using the errorRowStyle, errorContainerRowStyle, and errorMessageStyle.

        Pass in the key of the object (that is matched using the selectedKeyField) the dataField of the column that is supposed to show the error, and the error message text.

        Params:

        NameTypeAttributeDescription
        key *
        fld *
        errorMsg *

        public setErrorByObject(item: *, fld: *, errorMsg: *) source

        Similar to setErrorByKey, except takes the actual object that the key represents. On grids that allow for tracking errors, call this method to highlight the error using the errorRowStyle, errorContainerRowStyle, and errorMessageStyle.

        Pass in the key of the object (that is matched using the selectedKeyField) the dataField of the column that is supposed to show the error, and the error message text.

        Params:

        NameTypeAttributeDescription
        item *
        fld *
        errorMsg *

        public setExpandCollapseCellRenderer(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setExpandCollapseHeaderCellRenderer(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setFilterFocus(fld: *): * source

        Sets the filter at the top level.

        Params:

        NameTypeAttributeDescription
        fld *

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

        Return:

        *

        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.

        public setFilterFunction(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setFilterPageSortMode(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setFilterRowHeight(val: *) source

        Sets the filter row height at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setFilterValue(col: *, val: *, triggerEvent: *) source

        Used to set the initial value of the filter at the top level for the specified field.

        Params:

        NameTypeAttributeDescription
        col *

        The column to set filter for
        val *

        The value to set
        triggerEvent *

        Whether or not to fire the filterPageSortChange event. Defaults to true.

        public setFilterVisible(val: *) source

        Sets the filter row to visible at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setFooterRowHeight(val: *) source

        Sets the footer row height at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setFooterVisible(val: *) source

        Sets the footer row to visible at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setForcePagerRow(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setGridPreferencesInfo(val: *, applyPreferences: *) source

        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.

        Params:

        NameTypeAttributeDescription
        val *
        applyPreferences *

        public setGroupedColumns(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setHeaderRowHeight(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setHeaderSeperatorWidth(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setHeaderVisible(val: *) source

        Sets the filter row to visible at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setHeight(val: Number): * source

        Sets the height of this component

        Override:

        NdgBase#setHeight

        Params:

        NameTypeAttributeDescription
        val Number

        Return:

        *

        public setHorizontalScrollPolicy(value: *) source

        Override:

        UIComponent#setHorizontalScrollPolicy

        Params:

        NameTypeAttributeDescription
        value *

        public setHorizontalScrollPosition(val: *) source

        Override:

        UIComponent#setHorizontalScrollPosition

        Params:

        NameTypeAttributeDescription
        val *

        public setInitialSortAscending(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setInitialSortField(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setItemLoadMode(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setLevelRendererHeight(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setNestIndent(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setNestIndentPaddingCellRenderer(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setNextLevelRenderer(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setOpenItems(valCollection: *) source

        Params:

        NameTypeAttributeDescription
        valCollection *

        public setOpenKeys(keys: *) source

        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.

        Params:

        NameTypeAttributeDescription
        keys *

        public setPageIndex(val: *) source

        Page index at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setPageSize(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setPagerCellRenderer(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setPagerRenderer(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setPagerRowHeight(val: *) source

        Sets the pager row height at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setPagerVisible(val: *) source

        Sets the pager row to visible at the top level.

        Params:

        NameTypeAttributeDescription
        val *

        public setPredefinedFilters(filters: *) source

        Adds to built in filters and refreshes the toolbar.

        Params:

        NameTypeAttributeDescription
        filters *

        public setPreferencePersistenceKey(val: *): * source

        • String value that uniquely identifies this grid across the application. If you have multiple grids' with enablePreferencePersistence, and they happen to share the same value for the id field, e.g. id="grid1" they might overwrite each others' preferences. To combat this situation, we provide a property, which defaults to the id of the grid, but you can override to provide a globally unique key.

        Params:

        NameTypeAttributeDescription
        val *

        Return:

        *

        public setPreferences(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setPreferencesFromSettings(arrayCollection: *) source

        Takes an array collection of preferences and applies them to the grid.

        Params:

        NameTypeAttributeDescription
        arrayCollection *

        public setPreservePager(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setResponsiveBehaviorMode(mode: *): string source

        Responsive mode for this grid. There are there modes.

        <b><i> scrollBarMode </i></b> - The base HTMLTreeGrid will be extended to provide a Bootstrap-like API to show or hide the scroll bar on basis of the screen width. Below a certain pre-configured screen width, a scroll bar shall appear, and allow the user to scroll through all the columns. Above this screen width, there shall be no scrollbar.

        <b><i> columnPriorityMode </i></b> - The base HTMLTreeGrid will be extended to expose and API for a priority model, where each column can be assigned a priority and the columns shall appear or be hidden on basis of screen width.

        <b><i> transposedColumnMode </i></b> - A new column type, TransposedColumn will be added to accommodate smaller screens, below a certain pre-configured width, all the columns in the grid shall be replaced by the Transposed Column which shall contain, within a single cell, all the information that was held in the previous cells in a transposed manner

        Params:

        NameTypeAttributeDescription
        mode *

        public setRowDisabledFunction(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setRowHeight(o: *) source

        Params:

        NameTypeAttributeDescription
        o *

        public setRowSelectableFunction(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setRowSpanFunction(value: *) source

        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.

        Params:

        NameTypeAttributeDescription
        value *

        public setSelectAllState(val: *) source

        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.

        Params:

        NameTypeAttributeDescription
        val *

        public setSelectableField(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setSelectedField(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setSelectedIndex(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setSelectedItem(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setSelectedItemsBasedOnSelectedField(rebuild: *, openItems: *) source

        Sets the open items on basis of the selectedField.

        Params:

        NameTypeAttributeDescription
        rebuild *
        • optional

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

        public setSelectedKeyField(val: *) source

        Params:

        NameTypeAttributeDescription
        val *

        public setSelectedKeys(objects: *, openItems: *) source

        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.

        Params:

        NameTypeAttributeDescription
        objects *
        openItems *

        public setSelectedObjects(objects: *, openItems: *) source

        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.

        Params:

        NameTypeAttributeDescription
        objects *
        openItems *

        public setToolbarActionButtonProperty(toolbarActionCode: *, property: *, value: *) source

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

        Params:

        NameTypeAttributeDescription
        toolbarActionCode *
        property *
        value *

        public setToolbarActions(actions: *) source

        Adds to toolbar actions, and refreshes the toolbar.

        Params:

        NameTypeAttributeDescription
        actions *

        public setVerticalScrollPolicy(value: *) source

        Override:

        UIComponent#setVerticalScrollPolicy

        Params:

        NameTypeAttributeDescription
        value *

        public setVerticalScrollPosition(val: *) source

        Override:

        UIComponent#setVerticalScrollPosition

        Params:

        NameTypeAttributeDescription
        val *

        public setVirtualScrollDelay(value: *) source

        Params:

        NameTypeAttributeDescription
        value *

        public setWidth(val: *): * source

        Sets the width of this component

        Override:

        NdgBase#setWidth

        Params:

        NameTypeAttributeDescription
        val *

        Return:

        *

        public setupScrollTimer() source

        public shiftColumns(columnToInsert: *, insertBefore: *, level: *, movingCg: *) source

        Inserts the column specified column before the specified column

        Params:

        NameTypeAttributeDescription
        columnToInsert *
        insertBefore *
        level *
        movingCg *

        public showColumns(colsToShow: *) source

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

        Params:

        NameTypeAttributeDescription
        colsToShow *

        public showDropIndicator(cell: *) source

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

        Params:

        NameTypeAttributeDescription
        cell *

        public showMessage(msg: *) source

        Displays a message without the spinner label.

        Params:

        NameTypeAttributeDescription
        msg *

        public showPrintableColumns() source

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

        public showSpinner(msg: *) source

        Params:

        NameTypeAttributeDescription
        msg *

        public showToaster(message: *, toasterPosition: *, toasterRenderer: *, animationDuration: *, visibleDuration: *, moveAnimate: *, fadeAnimate: *): * source

        Shows the given toaster message

        Override:

        NdgBase#showToaster

        Params:

        NameTypeAttributeDescription
        message *

        The message to display in the toaster notification
        toasterPosition *

        The position for the toaster. One of the Toaster.POSITION_XXXX constants. Defaults to Toaster.POSITION_BOTTOM_RIGHT
        toasterRenderer *

        A classfactory for the actual renderer control. Defaults to DefaultToasterRenderer.
        animationDuration *

        Number of milli seconds to animate the move or the fade animation for the toaster to appear and disappear. Defaults to 1000
        visibleDuration *

        Number of milli seconds to keep the toaster visible. Defaults to 5000
        moveAnimate *

        Whether to use the move animation.
        fadeAnimate *

        Whether to use the fade animation.

        Return:

        *

        The toaster instance used to show the toaster.

        public showTooltip(relativeTo: *, tooltip: *, dataContext: *, point: *, leftOffset: *, topOffset: *, offScreenMath: *, where: *, container: *) source

        Displays a tooltip for the control in question. The tooltip will disappear if the mouse moves over an area that is not the 'relativeTo' component or the tooltip component..

        Params:

        NameTypeAttributeDescription
        relativeTo *

        Which component to position the popup relative to
        tooltip *

        The popup to display
        dataContext *

        If the popup has a data property, it will be set to this value
        point *

        If you specify this, the relativeTo is ignored, and the popup appears at the exact point you specify. Please ensure that the X and Y are relative to the Grid.
        leftOffset *

        Whether to shift the popup left after calculating the positions, for customizing the actual position
        topOffset *

        Whether to shift the popup top after calculating the positions, for customizing the actual position
        offScreenMath *

        Whether or not to adjust the popup if it appears off screen
        where *

        One of three values, left, right or none. If left, positions to bottom left, if right, positions to bottom right, if none, positions right below the relativeTo component.
        container *

        The holder for the tooltip, defaults to UIUtils.getTopLevelApplication(). You may need to override in multi window Air apps. By default, the tooltip will go away once you hover the mouse out of the trigger cell or the tooltip and stayed that way for tooltipWatcherTimeout. You may also manually remove the tooltip by calling the hideToolTip() function.

        public snapToColumnWidths() source

        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.

        public synchronizeHorizontalScroll() source

        Synchronizes the vertical scroll positions of the three locked sections

        public synchronizeLockedVerticalScroll() source

        Synchronizes the vertical scroll positions of the three locked sections

        public trackChange(changedItem: *, changeType: *, changeLevel: *, changedProperty: *, previousValue: *, newValue: *) source

        Method to track a change, called by track change API to keep track of additions, deletions and modifications to the data provider.

        Params:

        NameTypeAttributeDescription
        changedItem *

        Item being changed
        changeType *

        Type of the change
        changeLevel *
        • optional

        Nest Level of the level being changed
        changedProperty *
        • optional

        The property being changed
        previousValue *
        • optional

        The value prior to the change
        newValue *
        • optional

        The new value.

        public updateDisplayList(unscaledWidth: *, unscaledHeight: *) source

        Called as a part of render phase.

        Override:

        NdgBase#updateDisplayList

        Params:

        NameTypeAttributeDescription
        unscaledWidth *
        unscaledHeight *