| Flexicious Library Documentation | All Packages | All Classes | Index | Frames | |
| OlapFlexDataGrid | Properties | Methods | Events | Styles | Constants | |
| Package | com.flexicious.nestedtreedatagrid.olap |
| Class | public class OlapFlexDataGrid |
| Inheritance | OlapFlexDataGrid  FlexDataGrid NdgBase mx.core.UIComponent |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Because of the way you pass data to the OLAPDataGrid control, it has several differences from the Flexicious Ultimate control:
You populate an OlapFlexDataGrid control with data by setting its data provider to an instance of the OLAPResult class, which contains the results of an OLAP query.
Unlike the OLAPDataGrid that ships with the SDK, the Ultimate OlapFlexDataGrid converts the incoming IOLAPResult to a hierarchical collection. It does not use renderer providers. Since it provides support for expand collapse and the row and column levels, it takes the IOLAPResult and iterates through its row positions to convert them into an array collection of objects that have a 'children' property. This is repeated for the number of dimensions in the row, for a multi level hierarchy. This collection is then provided to the base dataprovider with the enableDynamicLevels flag turned on, so that the grid will instantiate the appropriate number of nested levels. You can configure each level as it is created by wiring up the dynamicLevelCreated event or the dynamicAllLevelsCreated event. The Ultimate OlapFlexDataGrid will also dispatch the following events:See also
| Property | Defined By | ||
|---|---|---|---|
 | additionalFilterArgumentsFunction : Function
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. | FlexDataGrid | |
| allItemHeaderText : String = All
The text of the all item
| OlapFlexDataGrid | ||
| allowInteractivity : Boolean
A boolean flag that indicates whether to enable mouse interactions, like hover, click, etc. | NdgBase | |
| allowMultipleRowDrag : Boolean = false
Flag to enable dragging multiple rows. | FlexDataGrid | |
| autoLoadPreferences : Boolean = true | FlexDataGrid | |
| autoRefreshInterval : Number
The number of milliseconds to wait before issuing an autorefresh call. | FlexDataGrid | |
| bodyContainer : FlexDataGridBodyContainer [read-only]
The main scrollable area of the grid. | FlexDataGrid | |
| bottomBarLeft : UIComponent
A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns. | FlexDataGrid | |
| bottomBarRight : UIComponent
A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns. | FlexDataGrid | |
| builtInActions : String
Comma delimited string of the following words: edit,delete,moveTo,moveUp,moveDown,addRow,filter
| FlexDataGrid | |
| canExpandDown : Boolean [read-only]
Returns true of this is a nested grid, and we have not expanded to the lowest level
| FlexDataGrid | |
| canExpandUp : Boolean [read-only]
Returns true of this is a nested grid, and we have expanded to a level below 1. | FlexDataGrid | |
| cellBackgroundColorFunction : Function
A function that can be used to control the background color of each cell in this column. | FlexDataGrid | |
| cellBorderFunction : Function
Pointer to the TOP level cellBorderFunction
A function that lets you control the border drawing mechanism for each cell. | FlexDataGrid | |
| cellCustomBackgroundDrawFunction : Function
Pointer to the TOP level cellCustomBackgroundDrawFunction
A function that lets you control the background drawing mechanism for each cell. | FlexDataGrid | |
| cellEditableFunction : Function
If this is defined, in addition to checking if the column is editable, this call back is called
for each cell in this column to ensure that the cell is editable. | FlexDataGrid | |
| cellTextColorFunction : Function
A function that can be used to control the Text color of each cell in this column. | FlexDataGrid | |
| changes : Array [read-only]
An array of ChangeInfo objects that contains all the changes made to the data provider using the grid editing mechanism. | FlexDataGrid | |
| childrenCountField : String
Pointer to the TOP level childrenCountField
A property on the object that identifies if the object has children. | FlexDataGrid | |
| childrenField : String
Pointer to the TOP level childrenField
The property of the parent level object, that identifies the children that should be displayed on the next level. | FlexDataGrid | |
| clearChangesOnDataProviderChange : Boolean = true
Flag that controls whether or not to clear out changes when the data provider changes
Defaults to true, so if you are refreshing the grid prior to savign it, set this to false. | FlexDataGrid | |
| clearErrorsOnDataProviderChange : Boolean = true
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
| FlexDataGrid | |
| clearOpenItemsOnDataProviderChange : Boolean = true
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
| FlexDataGrid | |
| clearSelectionOnDataProviderChange : Boolean = true
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
| FlexDataGrid | |
| clearSelectionOnFilter : Boolean = false
Flag that controls whether or not to clear out selectedObjects and selectedKeys when the filter changes
Defaults to false
| FlexDataGrid | |
| collapseOnInitialize : Boolean = false
This will cause the column groups to collapse on initialize (when you set the data provider)
| OlapFlexDataGrid | ||
| collapseTooltip : String = Collapse
Tooltip to display when user hovers over collapse icon
| FlexDataGrid | |
| colSpanFunction : Function
A function that takes in a data object, and a column, and returns a number. | FlexDataGrid | |
| columnCount : int [read-only]
Returns the top level columnCount
| FlexDataGrid | |
| columnGroups : Array [read-only]
Returns the list of columns groups at the root level. | FlexDataGrid | |
| columnLevel : FlexDataGridColumnLevel
The Root Column Level. | FlexDataGrid | |
| columnNames : Object [read-only]
Returns the top level column names
| FlexDataGrid | |
| columns : Array
Returns the list of columns at the root level. | FlexDataGrid | |
| contextMenuShown : Boolean = false
Set to true when the context menu is shown. | FlexDataGrid | |
| convertToHierarchicalCollection : Boolean = true
By default, the OLAP set that is generated is a flat collection of RowAxisPositions. | OlapFlexDataGrid | ||
| copyAllRowsMenuText : String = Copy All Rows
Text for the Copy All Rows
| NdgBase | |
| copyCellMenuText : String = Copy Cell
ext for the Copy Cell Menu
| NdgBase | |
| copySelectedRowMenuText : String = Copy Row
Text for the Copy Selected Row
| NdgBase | |
| copySelectedRowsMenuText : String = Copy Selected Rows
Text for the Copy selected Rows
| NdgBase | |
| createRowNumberColumnFunction : Function
A function that takes a IFlexDataGridDataCell object and returns a Number. | FlexDataGrid | |
| currentCell : IFlexDataGridCell
The cell that is the current mouse over. | FlexDataGrid | |
| currentSorts : ArrayCollection [read-only]
Return the FilterSort objects at the top level
| FlexDataGrid | |
| currentTooltip : IUIComponent [read-only]
The current tooltip object. | FlexDataGrid | |
| currentTooltipTrigger : IUIComponent [read-only]
The current tooltip object trigger. | FlexDataGrid | |
| dataProvider : Object [override]
An OLAPDataGrid accepts only an IOLAPResult as dataProvider
other dataProviders are simply ignored. | OlapFlexDataGrid | ||
| dataProviderNoFilters : Object [read-only]
Returns the TOP level data without any filters. | FlexDataGrid | |
| dataProviderNoPaging : Object [read-only]
Returns the TOP level data without any paging, but with filters. | FlexDataGrid | |
| defaultCellString : String = No Value
String displayed in a cell when the data for that cell returned by
the IOLAPResult instance is null or NaN. | OlapFlexDataGrid | ||
| disabledField : String
A property on the object that identifies whether the object is disabled. | FlexDataGrid | |
| dispatchCellCreated : Boolean = false
Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.CELL_CREATED event
| FlexDataGrid | |
| dispatchCellRenderered : Boolean = false
Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.CELL_RENDERED event
| FlexDataGrid | |
| dispatchRendererInitialized : Boolean = false
Performance optimization, set this to true only if you are listening for the FlexDataGridEvent.RENDERER_INITIALIZED event
| FlexDataGrid | |
| displayOrder : String
A comma seperated list of the following strings:
filter,header,body,footer,pager. | FlexDataGrid | |
| dragAvailableFunction : Function
A function that determines whether drag should be initiated. | NdgBase | |
| dragColumn : FlexDataGridColumn [read-only]
The column that initiated the drag
| FlexDataGrid | |
| dragDropCompleteFunction : Function
A function that gets executed when the drag drop operation is complete. | NdgBase | |
| dragEnabled : Boolean
Flag that indicates whether or not to setup drag support. | NdgBase | |
| dragRowData : Object [read-only]
The row data that is currently being dragged
| NdgBase | |
| dropAcceptRejectFunction : Function
A function that determines whether drop should be shown. | NdgBase | |
| dropEnabled : Boolean
Flag that indicates whether or not to setup drop support. | NdgBase | |
| dropIndicator : Sprite [read-only]
The dropIndicator seperator Sprite. | NdgBase | |
| dynamicLevelHasChildrenFunction : Function
Function to determine if the given object has children. | FlexDataGrid | |
| editable : Boolean | FlexDataGrid | |
| editedItemPosition : Object [write-only]
Takes an object that has a rowIndex and a columnIndex property. | FlexDataGrid | |
| elementsToBlur : Array [read-only] | FlexDataGrid | |
| elementToCenter : IUIComponent [read-only] | FlexDataGrid | |
| enableActiveCellHighlight : Boolean = true
Flag to hightlight the active cell. | FlexDataGrid | |
| enableAutoRefresh : Boolean
If flag is set to true, grid will dispatch an AUTO_REFRESH event every autoRefreshInterval milliseconds. | FlexDataGrid | |
| enableColumnExpandCollapse : Boolean = false
If set to true, the column groups generated will have the expand collapse functionailty builtin
| OlapFlexDataGrid | ||
| enableColumnHeaderOperation : Boolean
Flag to enable column header operations. | FlexDataGrid | |
| enableColumnWidthUserOverride : Boolean = true
Added in 2.9 to force columns to take the widths that the user specified. | FlexDataGrid | |
| enableCopy : Boolean
Flag to enable the context menu copy items. | FlexDataGrid | |
| enableDataCellOptmization : Boolean = true
Flag to turn on the highly optimized FlexDataGridDataCell3. | FlexDataGrid | |
| enableDefaultDisclosureIcon : Boolean
By default, the grid draws a set of expand collapse icons on the left locked section. | FlexDataGrid | |
| enableDelayChange : Boolean = true
Added in 2.9 to avoid multiple change events from firing. | FlexDataGrid | |
| enableDoubleClickEdit : Boolean
Flag to enable edit on doubleclick as opposed to single click. | FlexDataGrid | |
| enableDoubleClickTimer : Boolean = true
A flag to disable the double click timer mechanism. | FlexDataGrid | |
| enableDrag : Boolean
Flag that indicates whether or not to setup drag support. | NdgBase | |
| enableDrawAsYouScroll : Boolean
When enableVirtualScroll=true, setting this to true will cause each scroll event to issue a server request.. | FlexDataGrid | |
| enableDrillDown : Boolean
Flag to control appearance of the drill in and drill out icons in the toolbar. | NdgBase | |
| enableDrop : Boolean
Flag that indicates whether or not to setup drop support. | NdgBase | |
| enableDynamicLevels : Boolean
Flag to enable creation of the next level dynamically as the hierarchy is set. | FlexDataGrid | |
| enableEagerDraw : Boolean
By default, the grid renders when the dataprovider is set. | FlexDataGrid | |
| enableEditRowHighlight : Boolean = true
Flag to hightlight the edit row. | FlexDataGrid | |
| enableExport : Boolean
Flag to enable export to word and excel. | FlexDataGrid | |
| enableFillerColumn : Boolean = false
When you set horizontal scroll policy = on, this will add a filler column so that the last column in the OLAP
set does not look oddly wide in case of scenarios where the sum of column widths does not add up to grid width. | OlapFlexDataGrid | ||
| enableFillerRows : Boolean
By default, for performance reasons, the grid will only draw one large row to fill up the bottom in case that the grid is taller than
the sum of the row heights. | FlexDataGrid | |
| enableFilters : Boolean
Flag that indicates whether or not to show the filter
| FlexDataGrid | |
| enableFooters : Boolean
Flag that indicates whether or not to show the footer
| FlexDataGrid | |
| enableHeightAutoAdjust : Boolean
Flag to size the grid on basis of the number of rows displayed. | FlexDataGrid | |
| enableHideBuiltInContextMenuItems : Boolean
Flag to control whether or not to show the built in context menu items. | FlexDataGrid | |
| enableHideIfNoChildren : Boolean
Flag to control whether or not an item that has no children is filtered out or not. | FlexDataGrid | |
| enableKeyboardNavigation : Boolean
Not applicable for Ultimate - only for Classic Interface compliance. | NdgBase | |
| enableLocalStyles : Boolean = true
Added in 2.9 to avoid flicker. | FlexDataGrid | |
| enableLockedSectionSeperators : Boolean
Flag to draw a line to the right of the left locked content and a line to the left of the right locked content. | NdgBase | |
| enableMultiColumnSort : Boolean
Flag that indicates whether or not to enable multi column sort. | NdgBase | |
| enableMultiplePreferences : Boolean
A Flag that will enable multiple named versions of preferences to be persisted. | FlexDataGrid | |
| enablePaging : Boolean
Flag to indicate whether or not to enable paging functionality
| FlexDataGrid | |
| enablePreferencePersistence : Boolean
When set to true, causes the grid to look for settings stored
previously in the local shared object store if
preferencePersistenceMode='client' or dispatch an event requesting
settings from the server in preferencePersistenceMode='server'
| FlexDataGrid | |
| enablePrint : Boolean
Enables the print operation. | FlexDataGrid | |
| enableRowEdit : Boolean
Flag to enable full row edit behavior. | FlexDataGrid | |
| enableRowSpan : Boolean = true
Flag to enable row span. | OlapFlexDataGrid | ||
| enableRunningTotals : Boolean = true
When the convertToHierarchicalCollection flag is set to true, as row positions are grouped into corresponding parents
the parent objects are just holder objects, with no properties. | OlapFlexDataGrid | ||
| enableSelectionBasedOnSelectedField : Boolean
Flag to enable dataprovider based preselection of data. | FlexDataGrid | |
| enableSelectionBubble : Boolean
A flag to bubble up selection from children to parents. | FlexDataGrid | |
| enableSelectionCascade : Boolean
Flag to cascade checkbox or row selection down from the selection level. | FlexDataGrid | |
| enableSelectionExclusion : Boolean = false
Support for selection based on exclusion. | FlexDataGrid | |
| enableSplitHeader : Boolean
When enableMultiColumnSort=true, setting this flag to on will enable AdvancedDataGrid like Split headers to enable multi column sort. | FlexDataGrid | |
| enableStickyControlKeySelection : Boolean = true
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. | FlexDataGrid | |
| enableToolbarActions : Boolean
Flag to control appearance of custom actions toolbar. | NdgBase | |
| enableTrackChanges : Boolean = false
Flag to enable change tracking
If set to true, each addition, update(via the grid) or deletion to the data provider will be tracked. | FlexDataGrid | |
| enableTriStateCheckbox : Boolean
Flag to enable tristate behavior for selection checkboxes. | FlexDataGrid | |
| enableVirtualScroll : Boolean
Flag to enable virtual scroll. | FlexDataGrid | |
| excelOptions : ExportOptions
The Export options object that is used to configure the excel export behavior - currently only supported in Ultimate
| FlexDataGrid | |
| expandCollapseCellRenderer : IFactory
Pointer to the TOP level expandCollapseCellRenderer
Container for the expand collapse cell. | FlexDataGrid | |
| expandCollapseHeaderCellRenderer : IFactory
Pointer to the TOP level expandCollapseHeaderCellRenderer
Container for the expand collapse cell. | FlexDataGrid | |
| expandCollapseTooltipFunction : Function
Default function will return the value of expandTooltip or collapseTooltip. | FlexDataGrid | |
| expandTooltip : String = Expand
Tooltip to display when user hovers over expand icon
| FlexDataGrid | |
| exportableColumns : Array [read-only]
eturns the columns where excludeFromExport=false
| FlexDataGrid | |
| filterContainer : FlexDataGridHeaderContainer [read-only]
The container for the filter cells. | FlexDataGrid | |
| filterExcludeObjectsWithoutMatchField : Boolean = false
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. | FlexDataGrid | |
| filterFunction : Function
Pointer to the TOP level filterFunction
In addition to the filter row, if you wish to apply external filters, or to apply filters at inner nested levels, you may use this property. | FlexDataGrid | |
| filterPageSortMode : String
The Filter/Page/Sort Mode. | FlexDataGrid | |
| filterRow : DataGridFilterRow [read-only]
Not supported. | FlexDataGrid | |
| filterRowHeight : Number
Sets the filter row height at the top level. | FlexDataGrid | |
| filterRows : Array [read-only]
Returns an array of RowInfo objects in the filter row. | FlexDataGrid | |
| filterVisible : Boolean
Returns true if the filter row is visible at the top level. | FlexDataGrid | |
| footerContainer : FlexDataGridHeaderContainer [read-only]
The container for the footer cells. | FlexDataGrid | |
| footerRowHeight : Number
Returns the sum of:
If enableFooters, then footerRowHeight else 0
| FlexDataGrid | |
| footerRows : Array [read-only]
Returns an array of RowInfo objects in the footer row. | FlexDataGrid | |
| footerVisible : Boolean
Returns true if the footer row is visible at the top level. | FlexDataGrid | |
| forcePagerRow : Boolean
Flag to force appearance of the pager row even with enablePaging=false. | FlexDataGrid | |
| generateColumns : Boolean = true
Flag to automatically generate columns. | FlexDataGrid | |
| getChildrenFunction : Function = null
This function basically gives you the opportunity to tie in to the grids hierarchy lookup mechanism. | FlexDataGrid | |
| getLabelForCell : Function | OlapFlexDataGrid | ||
| getRowHeightFunction : Function = null
When variableRowHeight =true, atleast one column needs to have the wordWrap flag set to true. | FlexDataGrid | |
| getRowIndexFunction : Function
A function that takes a IFlexDataGridDataCell object and returns a String. | FlexDataGrid | |
| globalFilterMatchFunction : Function = null
Function to control all the filtering at all levels. | FlexDataGrid | |
| groupedColumns : Array
Returns the list of groupedColumns at the root level. | FlexDataGrid | |
| hasErrors : Boolean = false
A Flag that indicates if there are any errors
| FlexDataGrid | |
| hasFilter : Boolean = false
By default, there is no filter applied. | FlexDataGrid | |
| hasFilterFunction : Boolean [read-only]
returns true if any of the levels have a filter function
| FlexDataGrid | |
| hasGroupedColumns : Boolean [read-only]
Added for Persistence support
| FlexDataGrid | |
| hasRowSpanOrColSpan : Boolean [read-only]
If rowSpanFunction!=null or colSpanFunction!=null
| FlexDataGrid | |
| headerContainer : FlexDataGridHeaderContainer [read-only]
The container for the header cells. | FlexDataGrid | |
| headerRowHeight : Number
Pointer to the TOP level headerHeight
Height of the header for this level. | FlexDataGrid | |
| headerSectionHeight : Number [read-only]
Returns the sum of:
If enableFilters, then filterRowHeight else 0 plus
headerHeight
| FlexDataGrid | |
| headerSeperatorWidth : Number
Pointer to the TOP level headerSeperatorWidth
Width to show the resize indicator between columns. | FlexDataGrid | |
| headerSortSeparatorRight : Number [read-only]
Gets the value of the headerSortSeparatorRight property
| FlexDataGrid | |
| headerVisible : Boolean
Returns true if the header row is visible at the top level. | FlexDataGrid | |
| horizontalScrollBar : ScrollBar [read-only]
The horizontal scrollbar associated with the bodyContainer. | FlexDataGrid | |
| horizontalScrollPolicy : String [override]
Whether or not to show the horizontal scroll bar. | FlexDataGrid | |
| horizontalScrollPosition : Number
he horizontal scroll position of the body container. | FlexDataGrid | |
| initialSortAscending : Boolean
If true, initial sort direction for this level is ascending. | FlexDataGrid | |
| initialSortField : String
The property of the object on this level that should be used in the default sort at the root level. | FlexDataGrid | |
| inMultiRowEdit : Boolean = false
When the grid is in a multirow edit mode, we ignore all keyboard interaction. | NdgBase | |
| isCellSelectionMode : Boolean [read-only]
Returns true if selectionMode=MULTIPLE_ROWS or SINGLE_ROW
| NdgBase | |
| isClientFilterPageSortMode : Boolean [read-only]
Returns true if the top column level filterPageSortMode is client. | FlexDataGrid | |
| isRowSelectionMode : Boolean [read-only]
Returns true if selectionMode=MULTIPLE_ROWS or SINGLE_ROW
| NdgBase | |
| itemFilters : Dictionary
A dictionary of all the filters. | FlexDataGrid | |
| itemLoadMode : String
Pointer to the TOP level itemLoadMode
The Item Load Mode. | FlexDataGrid | |
| keyboardListenersPaused : Boolean = false
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. | NdgBase | |
| lastAutoRefresh : Date
Last time the auto refresh timer was triggered
| FlexDataGrid | |
| leftLockedContent : ElasticContainer [read-only]
The container for the left locked data cells. | FlexDataGrid | |
| leftLockedFooter : LockedContent [read-only]
The container for the left locked footer cells. | FlexDataGrid | |
| leftLockedHeader : LockedContent [read-only]
The container for the left locked filter and header cells. | FlexDataGrid | |
| leftLockedVerticalSeperator : Sprite [read-only]
The left locked vertical seperator Sprite. | NdgBase | |
| levelRendererHeight : Number
Pointer to the TOP level levelRendererHeight
Height to assign to the renderer for each level. | FlexDataGrid | |
| lockDisclosureCell : Boolean
A boolean flag that indicates whether to lock the disclosure
cells so that they dont scroll horizontally. | NdgBase | |
| lockedColumnCount : int [read-only]
Unused/Not Applicable. | FlexDataGrid | |
| lockedColumnWidth : int [read-only]
Unused/Not Applicable. | FlexDataGrid | |
| lockedSectionSeperatorDrawFunction : Function
Function to draw a line to the right of the left locked content and a line to the left of the right locked content. | NdgBase | |
| maxAutoAdjustHeight : Number
The maximum height to adjust the grid when enableHeightAutoAdjust is set to true. | FlexDataGrid | |
| maxDepth : int [read-only]
Returns the max depth possible for nested datagrids
| FlexDataGrid | |
| maxHorizontalScrollPosition : Number [read-only]
The max horizontal scroll position of the bodyContainer
| FlexDataGrid | |
| multiColumnSortNumberFields : Number [read-only]
The number of field dropdowns to display in the multi column sort popup. | FlexDataGrid | |
| multiSortRenderer : IFactory
A Class that is responsible for the multi column sort view. | FlexDataGrid | |
| nativeExcelExporter : Exporter
The default exporter in flexicious is a pure CSV exporter. | FlexDataGrid | |
| nestIndent : Number
Pointer to the TOP level nestIndent
he indentation to apply to each progressive nest level. | FlexDataGrid | |
| nestIndentPaddingCellRenderer : IFactory
Pointer to the TOP level nestIndentPaddingCellRenderer
Container for the nest indent padding cell. | FlexDataGrid | |
| nextLevelRenderer : IFactory
Pointer to the TOP level nextLevelRenderer
A renderer that displays this level. | FlexDataGrid | |
| noDataMessage : String = No Records Found
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. | FlexDataGrid | |
| olapDataProvider : Object [read-only]
Returns the OLAPDataprovider that was used as the basis of the columns and the
hierarchical dataprovider. | OlapFlexDataGrid | ||
| openItems : ArrayCollection
A list of items that the user has opened. | FlexDataGrid | |
| pageIndex : int
Page index at the top level. | FlexDataGrid | |
| pager : IPager [read-only]
Returns the top level pager
| FlexDataGrid | |
| pagerCellRenderer : IFactory
Pointer to the TOP level pagerCellRenderer
Container for the footer renderer. | FlexDataGrid | |
| pagerContainer : FlexDataGridHeaderContainer [read-only]
The container for the pager cells. | FlexDataGrid | |
| pagerControl : IExtendedPager [read-only]
Returns the pager control at the root level. | FlexDataGrid | |
| pagerRenderer : IFactory | FlexDataGrid | |
| pagerRowHeight : Number
Gets the pager row height at the top level. | FlexDataGrid | |
| pagerVisible : Boolean
Returns true if the pager row is visible at the top level. | FlexDataGrid | |
| pageSize : int
The page size of the top(root) level. | FlexDataGrid | |
| pdfOptions : PrintOptions
The Print options object that is used to configure the pdf behavior - currently only supported in Ultimate
| FlexDataGrid | |
| pdfPrinter : IPDFPrinter
A class that takes the PDF Pages as they are generated. | FlexDataGrid | |
| popupFactoryExportOptions : IFactory
The renderer that shows up when the user clicks on the Word or Excel button - currently only supported in Ultimate
| FlexDataGrid | |
| popupFactoryOpenSettingsPopup : IFactory
The renderer that shows up when the user clicks on the Open Settings button - currently only supported in Ultimate
| FlexDataGrid | |
| popupFactoryPrintOptions : IFactory
The renderer that shows up when the user clicks on the Print or PDF button - currently only supported in Ultimate
| FlexDataGrid | |
| popupFactorySaveSettingsPopup : IFactory
The renderer that shows up when the user clicks on the Save Settings button - currently only supported in Ultimate
| FlexDataGrid | |
| popupFactorySettingsPopup : IFactory
The renderer that shows up when the user clicks on the Settings button - currently only supported in Ultimate
| FlexDataGrid | |
| predefinedFilters : ArrayCollection
A collection of toolbar actions. | NdgBase | |
| preferencePersistenceKey : String
String value that uniquely identifies this grid across the application. | FlexDataGrid | |
| preferencePersistenceMode : String
String value "server" or "client". | FlexDataGrid | |
| preferences : String
Returns an XML representation of the preferences specified in
the preferencesToPersist property and values being the actual
values. | FlexDataGrid | |
| preferencesLoaded : Boolean [read-only]
Returns true if the load preferences has been called. | FlexDataGrid | |
| preferencesSet : Boolean
A flag to indicate that the preferences for this grid
has been set. | FlexDataGrid | |
| preferencesToPersist : String
A comma delimited string of the following values:
columnOrder,columnVisiblity,columnWidth,filter,sort,verticalScroll,horizontalScroll
Each represents a setting that can potentially be persisted. | FlexDataGrid | |
| preservePager : Boolean
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. | FlexDataGrid | |
| printableColumns : Array [read-only]
Returns the columns where excludeFromPrint=false
| FlexDataGrid | |
| printComponentFactory : IFactory | FlexDataGrid | |
| printExportData : Object
This is not used. | FlexDataGrid | |
| printExportParameters : Object
Any custom data that you wish to pass into the print/export mechanism.
This will then be available on Print/Export Options
when the Print or Export is run. | NdgBase | |
| printOptions : PrintOptions
The Print options object that is used to configure the print behavior - currently only supported in Ultimate
| FlexDataGrid | |
| rebuildGridOnDataProviderChange : Boolean = true
Flag that controls whether or not to rebuild the entire grid on dataprovider change. | FlexDataGrid | |
| recalculateSeedOnEachScroll : Boolean = false
Flag should be set to true when you have large variable height based rows that are potentially
taller than the grid itself. | FlexDataGrid | |
| rightLockedContent : ElasticContainer [read-only]
The container for the right locked data cells. | FlexDataGrid | |
| rightLockedFooter : LockedContent [read-only]
The container for the right locked footer cells. | FlexDataGrid | |
| rightLockedHeader : LockedContent [read-only]
he container for the right locked filter and header cells. | FlexDataGrid | |
| rightLockedVerticalSeperator : Sprite [read-only]
The right locked vertical seperator Sprite. | NdgBase | |
| rightLockedWidth : int [read-only]
Returns the maximum width of right locked columns. | FlexDataGrid | |
| rowCount : int [read-only]
Returns the number of rows currently visible. | FlexDataGrid | |
| rowDisabledFunction : Function
A function that can be used to control the enabled flag of each cell in this level. | FlexDataGrid | |
| rowHeight : Number
Gets the height of the data rows at the top level
| FlexDataGrid | |
| rowSelectableFunction : Function
A function that can be used to control whether clicking on any cell in this level will select it. | FlexDataGrid | |
| rowSpanFunction : Function
A function that takes in a data object, and a column, and returns a number. | FlexDataGrid | |
| selectableField : String
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. | FlexDataGrid | |
| selectAllState : String
If all items from the top level are selected, returns TriStateCheckBox.STATE_CHECKED. | FlexDataGrid | |
| selectedCells : ArrayCollection [read-only]
A list of CellInfo objects. | NdgBase | |
| selectedField : String
A field on the dataprovider that indicates that this item should be selected
| FlexDataGrid | |
| selectedIndex : int
Only applicable for flat grids. | FlexDataGrid | |
| selectedIndices : Array [read-only]
Returns dataProvider.indexOf(selectedObjects(0))
| FlexDataGrid | |
| selectedItem : Object
Returns (selectedObjects(0)). | FlexDataGrid | |
| selectedItems : Array [read-only]
Returns the top level selectedObjects
| FlexDataGrid | |
| selectedKeyField : String
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. | FlexDataGrid | |
| selectedKeys : ArrayCollection [read-only]
A list of ID values, based on the selectedKeyField property. | FlexDataGrid | |
| selectedObjects : ArrayCollection [read-only]
A list of selected objects from the data provider. | FlexDataGrid | |
| selectionInfo : SelectionInfo [read-only]
Support for selection based on exclusion. | FlexDataGrid | |
| selectionMode : String
Selection mode for the grid. | NdgBase | |
| settingsColumns : Array [read-only]
Returns the columns where excludeFromSettings=false
| FlexDataGrid | |
| showSpinnerOnCreationComplete : Boolean [read-only]
Returns showSpinnerOnFilterPageSort
| FlexDataGrid | |
| showSpinnerOnFilterPageSort : Boolean
A flag when set, automatically shows the spinner on creation complete and
any filter page or sort operation. | NdgBase | |
| sortableColumns : Array [read-only]
eturns the columns where excludeFromExport=false
| FlexDataGrid | |
| spinner : ISpinner
The spinner component. | FlexDataGrid | |
| spinnerBehavior : SpinnerBehavior | FlexDataGrid | |
| spinnerFactory : IFactory
Factory responsible for instantiating a new spinner. | NdgBase | |
| spinnerLabel : String
The label of the spinner control, you can use styles
to control the appearance. | NdgBase | |
| spinnerParent : Object [read-only] | FlexDataGrid | |
| toolbarActionAddRow : ToolbarAction [read-only]
Returns the built in Add Row Action
| FlexDataGrid | |
| toolbarActionDelete : ToolbarAction [read-only]
Returns the built in Delete Action
| FlexDataGrid | |
| toolbarActionEdit : ToolbarAction [read-only]
Returns the built in Edit Action
| FlexDataGrid | |
| toolbarActionExecutedFunction : Function
A function that gets executed whenever a user clicks on a icon generated by a custom toolbar icon. | NdgBase | |
| toolbarActionFilter : ToolbarAction [read-only]
Returns the built in Filter Action
| FlexDataGrid | |
| toolbarActionMoveDown : ToolbarAction [read-only]
Returns the built in moveDown Action
| FlexDataGrid | |
| toolbarActionMoveTo : ToolbarAction [read-only]
Returns the built in Move to Action
| FlexDataGrid | |
| toolbarActionMoveUp : ToolbarAction [read-only]
Returns the built in moveUp Action
| FlexDataGrid | |
| toolbarActions : ArrayCollection
A collection of toolbar actions. | NdgBase | |
| toolbarActionSeparator : ToolbarAction [read-only]
Returns the built in moveUp Action
| FlexDataGrid | |
| toolbarActionSort : ToolbarAction [read-only]
Returns the built in Edit Action
| FlexDataGrid | |
| toolbarActionValidFunction : Function
A function that gets executed whenever the user selection changes. | NdgBase | |
| toolbarExcelHandlerFunction : Function
Function that actually runs the export to excel. | FlexDataGrid | |
| toolbarPdfHandlerFunction : Function
Function that actually runs the pdf. | FlexDataGrid | |
| toolbarPrintHandlerFunction : Function
Function that actually runs the print. | FlexDataGrid | |
| toolbarWordHandlerFunction : Function
Function that actually runs the export to word. | FlexDataGrid | |
| tooltipBehavior : TooltipBehavior | FlexDataGrid | |
| totalRecords : int
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. | FlexDataGrid | |
| useCompactPreferences : Boolean
If set to true, uses the newer preference persistence scheme introduced in
Flexicious 2.0, which stores the preferences as custom string as opposed to XML,
making it a lot less verbose. | FlexDataGrid | |
| useElements : Boolean [read-only]
Whether to use addElement or addChild;
| FlexDataGrid | |
| useModuleFactory : Boolean [read-only]
Flag that indicates to use the module factory of the grid to show popups. | FlexDataGrid | |
| useRollOver : Boolean
Flag that controls whether items are highlighted as the mouse rolls over them. | FlexDataGrid | |
| userSettingsOptionsFunction : Function
Hook for the client to plug in their own UserSettings. | FlexDataGrid | |
| variableHeaderHeight : Boolean = false
When you enable headerWordWrap=true, then we need to set this to true, because
we will dyamically adjust the height of the header row. | FlexDataGrid | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different height. | FlexDataGrid | |
| variableRowHeightOffset : Number = 0
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
| FlexDataGrid | |
| variableRowHeightUseRendererForCalculation : Boolean = false
By default, the flexicious Ultimate Grid does not instantiate and
measure each cell renderer when you set variable row heights. | FlexDataGrid | |
| verticalScrollBar : ScrollBar [read-only]
The vertical scrollbar associated with the bodyContainer. | FlexDataGrid | |
| verticalScrollBarOffset : int [read-only]
ot used. | FlexDataGrid | |
| verticalScrollPosition : Number
he vertical scroll position of the body container. | FlexDataGrid | |
| viewMetrics : EdgeMetrics [read-only]
Unused/Not applicable to the Nested DataGrid. | FlexDataGrid | |
| virtualBodyContainer : FlexDataGridVirtualBodyContainer [read-only] | FlexDataGrid | |
| virtualScrollDelay : uint
Delay in milliseconds before "virtualScroll" event is dispatched. | FlexDataGrid | |
| visibleColumns : Array [read-only]
eturns the columns where visible=true
| FlexDataGrid | |
| wordOptions : ExportOptions
The Export options object that is used to configure the word export behavior - currently only supported in Ultimate
| FlexDataGrid | |
| Method | Defined By | ||
|---|---|---|---|
| OlapFlexDataGrid | |||
| addColumn(col:FlexDataGridColumn):void
Adds the column to the collection of columns at the root level. | FlexDataGrid | |
| addSelectedItem(val:Object):void
Adds the provided item to the selection of the top (root) level. | FlexDataGrid | |
| alignColumnGroups():void
If you modify one or more column groups, calling this method is required so that
inter related column groups can update themselves. | FlexDataGrid | |
| checkIsGroupingCollection(val:Object):Boolean | FlexDataGrid | |
| checkNoDataMessage(force:Boolean = false):void
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. | FlexDataGrid | |
| clearAllCollections():void
Clears out the following collections
All Open Items
All Errors
Selection (only if clearSelectionOnDataProviderChange==true)
Some internal housekeeping collections
| FlexDataGrid | |
| clearAllErrors():void
Clears out all the errors
| FlexDataGrid | |
| clearAllFilters():void
Clears filters at all levels and rebuilds the grid. | FlexDataGrid | |
| clearChanges():void
Sets changes to an empty array. | FlexDataGrid | |
| clearColumns(rebuild:Boolean = true):void
Clears out all the columns of the grid
If the parameter to rebuild is true, the grid will be rebuilt. | FlexDataGrid | |
| clearErrorByKey(key:*, fld:String):void
Clears the errors for the specified key
| FlexDataGrid | |
| clearErrorByObject(item:Object, fld:String):void
Similar to clearErrorByKey, except takes the actual object that the key represents. | FlexDataGrid | |
| clearFilter():void
Clears the filters at all levels
| FlexDataGrid | |
| clearFilterByField(col:String = null):void
Clears the filters at all levels
| FlexDataGrid | |
| clearFlattenedCache():void
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. | FlexDataGrid | |
| clearPreferences():void | FlexDataGrid | |
| clearSelection():void [override]
Clears the selected rows and cells. | FlexDataGrid | |
| collapseAll():void
For nested datagrids, expands all items one level down
| FlexDataGrid | |
| collapseAllColumnGroups(lvl:int = 1):void
For grids with column groups, expands them all. | FlexDataGrid | |
convertDataProviderToHierarchicalCollection(rowAxis:IList, columnAxis:IList):void
Takes a rowAxis result from the IOLAPResult and turns it into a
hierarchical array collection that the Ultimate Grid can then render
in a nested manner. | OlapFlexDataGrid | ||
| copyCurrentCellToClipboard(event:ContextMenuEvent = null):void
Method to handle the click for the copy cell menu item
Copies the current cell in tab delimited format into the clipboard
| FlexDataGrid | |
| copyRowToClipboard(event:ContextMenuEvent = null):void
Method to handle the click for the copy row menu item
Copies the current row in tab delimited format into the clipboard
| FlexDataGrid | |
| copySelectedRowsToClipboard(event:ContextMenuEvent = null):void
Method to handle the click for the copy table menu item
Copies the entire dataprovider in tab delimited format into the clipboard
| FlexDataGrid | |
| copyTableToClipBoard(event:ContextMenuEvent = null):void
Method to handle the click for the copy table menu item
Copies the entire dataprovider in tab delimited format into the clipboard
| FlexDataGrid | |
| createBuiltinAction(lbl:String, code:String, requiresSelection:Boolean = false, requiresSingleSelection:Boolean = false):ToolbarAction
Creates a Toolbar Action
| FlexDataGrid | |
|
Not supported
| FlexDataGrid | |
|
Returns the top level filter. | FlexDataGrid | |
| createPrintComponentFactory():IFactory
Gets the class responsible for handling the PrintUI should be a IPrintDataGrid
| FlexDataGrid | |
| defaultExcelHandlerFunction():void
Default handler for the Word Export Button. | FlexDataGrid | |
| defaultExpandCollapseTooltipFunction(cell:IFlexDataGridCell):String
If grid.openItems.contains(getItemKey(cell.rowInfo.data)),
return the value of expandTooltip else collapseTooltip
| FlexDataGrid | |
The default handler for the cell values. | OlapFlexDataGrid | ||
| defaultPdfHandlerFunction():void
Default handler for the Print Button. | FlexDataGrid | |
| defaultPrintHandlerFunction():void
Default handler for the Print Button. | FlexDataGrid | |
| defaultWordHandlerFunction():void
Default handler for the Word Export Button. | FlexDataGrid | |
| destroyItemEditor():void
Destroys the current item editor, if there is one. | FlexDataGrid | |
| dispatchAutoRefreshEvent(event:Event):void
Handle for the auto refresh. | FlexDataGrid | |
| dispatchEvent(event:Event):Boolean [override] | FlexDataGrid | |
|
Modifies the columns so the width is distributed equally. | FlexDataGrid | |
| dragBegin(event:MouseEvent):void
Triggered when drag is starting. | FlexDataGrid | |
| dragComplete(cell:IFlexDataGridCell):void
Triggered when the drag is complete. | FlexDataGrid | |
| drawFiller():void
When enableFillerRows=true, wipes out and recreates the filler rows. | FlexDataGrid | |
| enableDisableToolbarAction(code:String, enable:Boolean):void
In addition to initial enable/disable of toolbar actions, this function
can be used to enable or disable toolbar actions at run time. | FlexDataGrid | |
| ensureLevelsCreated(item:Object = null, level:FlexDataGridColumnLevel = null):void
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. | FlexDataGrid | |
| expandAll():void
For nested datagrids, expands all items one level down
| FlexDataGrid | |
| expandAllColumnGroups(lvl:int = 1):void
For grids with column groups, expands them all. | FlexDataGrid | |
| expandChildrenOf(item:Object, open:Boolean, level:FlexDataGridColumnLevel = null):void
Opens or closes all the nodes of the navigation tree below the specified item. | FlexDataGrid | |
| expandDown():void
For nested datagrids, expands all items one level down
| FlexDataGrid | |
| expandToLevel(level:int):void
For nested datagrids, expands all items to the level specified. | FlexDataGrid | |
| expandUp():void
or nested datagrids, expands all items one level up
| FlexDataGrid | |
| flatten(depthRequested:int = 1, inclusive:Boolean = true, filter:Boolean = false, page:Boolean = false, sort:Boolean = false, max:Number = -1):Array
For hierarchical data grids, returns the data provider as a flat list that matches the
specified criteria. | FlexDataGrid | |
| generateImageForDrag(cell:IFlexDataGridCell):Image
Generates a snapshot of the row for the drag visual indicator
| FlexDataGrid | |
| getActionByCode(code:String):ToolbarAction
Given a code, loops through the toolbarActions, and gets the toolbar action with the given code. | FlexDataGrid | |
| getAllErrorString():String
Returns an object that has the error information for the passed in object. | FlexDataGrid | |
| getAutoLoadPreferences():Boolean
By default, when the grid's creation complete event is dispatched, the grid will go
in and load the saved preference. | FlexDataGrid | |
|
Given a data object and a colum, return the IFlexDataGridDataCell object for the combination
| FlexDataGrid | |
|
Gets the cell in the specified direction of the provided cell
| FlexDataGrid | |
| getChildren(object:Object, level:FlexDataGridColumnLevel, filter:Boolean = false, page:Boolean = false, sort:Boolean = false):Object
If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object. | FlexDataGrid | |
| getChildrenLength(object:Object, level:FlexDataGridColumnLevel, filter:Boolean = false, page:Boolean = false, sort:Boolean = false):Object
Calls getChildren, and if result is XML or XMLList, returns length() else returns length;
| FlexDataGrid | |
| getColumnByDataField(fld:String):FlexDataGridColumn
eturns the column with the specified datafield, only at the root level
| FlexDataGrid | |
| getColumnByUniqueIdentifier(fld:String):FlexDataGridColumn
eturns the column with the specified UniqueIdentifier, only at the root level
| FlexDataGrid | |
|
Given a IFlexDataGridCell, returns a container that holds that cell. | FlexDataGrid | |
| getContainerInDirection(container:String, up:Boolean):FlexDataGridContainerBase
Returns the section above or below the provided section. | FlexDataGrid | |
| getContainerName(container:FlexDataGridContainerBase):String
Given a container, returns its displayOrder string equivalent. | FlexDataGrid | |
|
Gets the cell that is currently being edited. | FlexDataGrid | |
| getCurrentEditor():UIComponent
Gets the editor that is currently being edited. | FlexDataGrid | |
|
When enableMultiplePreferences = true, this represents the currently applied preference
| FlexDataGrid | |
| getDataForPrintExport(printOptions:PrintExportOptions):Object
Called by PrintController and ExportController to get the data on basis of PrintOptions and ExportOptions
| FlexDataGrid | |
| getError(item:Object):Object
Returns an object that has the error information for the passed in object. | FlexDataGrid | |
| getExportableColumns(exportOptions:ExportOptions):Array
Returns all columns at all levels. | FlexDataGrid | |
| getFilterArguments():ArrayCollection
eturns the filter at the top level. | FlexDataGrid | |
| getFilterColumn(searchField:String):Object
Gets the column with the specified search field
| FlexDataGrid | |
| getFilteredPagedSortedData(dictionary:Dictionary, applyFilter:Boolean = true, applyPaging:Boolean = true, applySort:Boolean = true, pages:Array = null):Object
Returns the data provider, with filter, paging and sorting applied on basis
of the boolean flags specified. | FlexDataGrid | |
| getFilterValue(col:String):* | FlexDataGrid | |
| getFilterX(renderer:IFilterControl):Number
Used by filter to identify where relative position for each control for tabbing
| FlexDataGrid | |
|
When enableMultiplePreferences = true, this represents a list of all preferences saved for this
grid. | FlexDataGrid | |
| getItemAtPosition(position:Number):RowPositionInfo
eturns the RowPosition Info object for the item at the given vertical scroll position
| FlexDataGrid | |
| FlexDataGrid | ||
| getLength(arr:Object):int
If arr is XML or XMLList, returns length() else returns length;
| FlexDataGrid | |
| getLevel(levelDepth:int):FlexDataGridColumnLevel
Returns FlexDataGridColumnLevel object at the specified depth
| FlexDataGrid | |
| getLevelForItem(itemToFind:*, flat:Object = null, level:FlexDataGridColumnLevel = null):FlexDataGridColumnLevel
Provided an item, loops through the data provider, and finds
the level associated with the provided item. | FlexDataGrid | |
| getNamedContainer(name:String):FlexDataGridContainerBase
Given a displayOrder string , returns its container equivalent. | FlexDataGrid | |
| getOpenItemCount(cell:IFlexDataGridCell):int
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. | FlexDataGrid | |
| getOpenKeys():Array
A list of ID values, based on the selectedKeyField property. | FlexDataGrid | |
| getOpenObjects():Array
Returns a copy of the open items array. | FlexDataGrid | |
| getParent(object:Object, level:FlexDataGridColumnLevel):Object
Returns the parent object for the passed in object. | FlexDataGrid | |
|
eturns the container for the given cell
| FlexDataGrid | |
| getPrintableColumns(options:PrintOptions):Array | FlexDataGrid | |
|
ets the filter at the root level
| FlexDataGrid | |
| getRootFlat():Object
Returns a iterable representation of the dataprovider. | FlexDataGrid | |
| getRowHeight(item:Object, level:FlexDataGridColumnLevel, rowType:int):Number
If variableRowHeight returns the minimum height required to display text of each column without clipping. | FlexDataGrid | |
|
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. | FlexDataGrid | |
| getSelectedKeys():Array
For nested datagrids, used to get all records at all levels. | FlexDataGrid | |
| getSelectedObjects(getKey:Boolean = false, unSelected:Boolean = false):Array
For nested datagrids, used to get all items selected at all levels. | FlexDataGrid | |
| getToolbarActionButton(code:String):UIComponent
Gets the actual button object for the provided toolbar action. | FlexDataGrid | |
| getUIComponentBitmapData(target:IUIComponent):Image
Drag and Drop support, create a image representation of the row. | NdgBase | |
| getUnSelectedKeys():Array
When enableSelectionExclusion, returns a list of items that the user explicitly unselected. | FlexDataGrid | |
| FlexDataGrid | ||
| gotoHorizontalPosition(vsp:Number):void
Goes to the specified horizontal position. | FlexDataGrid | |
| gotoItem(item:Object, highlight:Boolean = true, level:FlexDataGridColumnLevel = null):void
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. | FlexDataGrid | |
| gotoKey(key:Object, highlight:Boolean = true, level:FlexDataGridColumnLevel = null):void
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. | FlexDataGrid | |
| gotoRow(rowIndex:int):void
Given a row index (less than the total number of rows, goes to the row in question). | FlexDataGrid | |
| gotoVerticalPosition(vsp:Number):void
Goes to the specified vertical position. | FlexDataGrid | |
| hasBorderSide(side:String):Boolean
Returns true if the grid defines the border style specified
| NdgBase | |
| hideSpinner():void
Removes the spinner and sets the bodyContainer.alpha back to 1
| FlexDataGrid | |
| hideTooltip():void
Hides the current tooltip. | FlexDataGrid | |
|
On basis of the highLight flag, removes or adds highlight to the row in question. | FlexDataGrid | |
| invalidateCells():void
Invalidates the display (Calls invalidateDisplayList of all the cells). | FlexDataGrid | |
| invalidateCellWidths():void
Invalidates the cell widths, so in the next commit properties, we snap to the new column widths. | NdgBase | |
| invalidateFiller():void
Queues a call to drawFiller in the next validation cycle
| FlexDataGrid | |
| invalidateHeight():void
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. | NdgBase | |
| invalidateHorizontalScroll():void
Called when you scroll and expand collapse. | FlexDataGrid | |
| invalidateList():void
Calls the rebuild function, which basically rebuild the entire grid. | FlexDataGrid | |
| invalidateWidth():void
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. | NdgBase | |
| isCellEditable(fdgCell:IFlexDataGridCell):Boolean
Is this cell editable? Returns true if:
1) The cell is an IFlexDataGridCell
2) The cells column is editable
3) The cellEditableFunction is null OR cellEditableFunction(fdgCell) returns true.
| FlexDataGrid | |
| isCtrlKeyDownOrSticky(event:Event):Boolean
Return true if enableStickyControlKeySelection Or (Control Key is down AND (selectionMode is MultipleRows or MultipleCells))
| FlexDataGrid | |
| isToolbarActionValid(action:ToolbarAction, currentTarget:Object, extendedPager:IExtendedPager):Boolean
Evaluates whether the given toolbar action is valid or not. | FlexDataGrid | |
| loadPreferences():void
Loads preference values from the Shared object, called automatically in
preferencePersistenceMode=client. | FlexDataGrid | |
| measureCellHeight(col:Object, paddingLeft:Number, paddingRight:Number, paddingTop:Number, paddingBottom:Number, itemRenderer:IFactory, ht:Number, txt:String, item:Object, styl:Object):Number
Given a column and padding values, calculate the height required to fully render the text
| FlexDataGrid | |
| multiColumnSortGetTooltip(cell:FlexDataGridHeaderCell):String
Gets the text of the tooltip to show to the user to prompt for the multi column sort. | FlexDataGrid | |
| multiColumnSortShowPopup():void
Creates an instance of the multiSortRenderer and pushes it into view
| FlexDataGrid | |
| pauseKeyboardListeners(filterRenderer:Object):void
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. | FlexDataGrid | |
| persistPreferences(name:String = Default, isDefault:Boolean = false):void
Persists the preferences as Shared Objects when preferencePersistenceMode=client
or dispatches an event with the preference information when preferencePersistenceMode=server
| FlexDataGrid | |
| placeBottomBar():void
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. | FlexDataGrid | |
| placeSections():void
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. | FlexDataGrid | |
| processFilter():void
Processes filters at the root level. | FlexDataGrid | |
| processSort(sorts:ArrayCollection):void
Used by state persistence to load sort settings that were
persisted previously. | FlexDataGrid | |
| quickFind(whatToFind:String, searchCols:Array = null, breakAfterFind:Boolean = true, captureCols:Boolean = false):Array
Iterates through the data provider to get a list of row positions
that match the text provided. | FlexDataGrid | |
| rebuild():void
Rebuild the entire grid. | NdgBase | |
| rebuildBody(vupdateTotalRecords:Boolean = false):void
A method that simply rebuilds the body as opposed to rebuilding the entire grid. | FlexDataGrid | |
| rebuildBodyDeferred():void
Same as rebuildBody, but ideal for scenarios where you have to call rebuildBody frequently (i.e. | FlexDataGrid | |
| rebuildFilter():void
A method that simply rebuilds the footer as opposed to rebuilding the entire grid. | FlexDataGrid | |
| rebuildFooter():void
A method that simply rebuilds the footer as opposed to rebuilding the entire grid. | FlexDataGrid | |
| rebuildHeader():void
A method that simply rebuilds the header as opposed to rebuilding the entire grid. | FlexDataGrid | |
| rebuildPager():void
A method that simply rebuilds the pager as opposed to rebuilding the entire grid. | FlexDataGrid | |
| reDraw():void
Redraws the grid, assuming the data provider is the same, we're just changing column widths or ordinals. | NdgBase | |
| redrawBody():void
A method that simply redraws the body as opposed to rebuilding the entire grid. | FlexDataGrid | |
| refreshCells():void
Calls the refresh cell method on all visible cells in the bodyContainer section. | FlexDataGrid | |
| refreshCheckBoxes():void
Updates the visible state of all row selection checkboxes and header checkboxes. | FlexDataGrid | |
| refreshLayout():void
Calls rebuild internally. | NdgBase | |
| removeAllSorts():void
Removes all the sorts and calls doInvalidate. | FlexDataGrid | |
| removeColumn(col:FlexDataGridColumn):void
Removes the column from the collection of columns at this level. | FlexDataGrid | |
replaceSpecials(str:String):String
Given a string, replaces all space, bracket, dash and dot characters from it. | OlapFlexDataGrid | ||
|
Runs the given toolbar action. | FlexDataGrid | |
| scrollToExistingRow(vsp:Number, scrollDown:Boolean):void
Scrolls to the row that appears at the specified vertical position
| FlexDataGrid | |
| selectText(txt:String):void
Selects the provided text in the currently visible cells
that have the default item renderer, or if the item renderer
has the selection property
| FlexDataGrid | |
| setChildData(item:Object, children:Object, level:FlexDataGridColumnLevel, totalRecords:int = -1, useSelectedKeyField:Boolean = true):void
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. | FlexDataGrid | |
| setCurrentPreferenceInfo(val:PreferenceInfo, applyPreferences:Boolean = true):void
When enableMultiplePreferences = true, applies the given preference as the current
preference. | FlexDataGrid | |
| setErrorByKey(key:*, fld:String, errorMsg:String):void
On grids that allow for tracking errors, call this method to highlight the error
using the errorRowStyle, errorContainerRowStyle, and errorMessageStyle. | FlexDataGrid | |
| setErrorByObject(item:Object, fld:String, errorMsg:String):void
Similar to setErrorByKey, except takes the actual object that the key represents. | FlexDataGrid | |
| setFilterFocus(fld:String):Boolean
Sets the filter at the top level. | FlexDataGrid | |
| setFilterValue(col:String, val:Object, triggerEvent:Boolean = true):void | FlexDataGrid | |
| setGridPreferencesInfo(val:GridPreferencesInfo, applyPreferences:Boolean = true):void
Sets the multiple preferences array. | FlexDataGrid | |
| setOpenKeys(keys:Array):void
For nested/grouped hierarchical datagrids, used to select records. | FlexDataGrid | |
| setPredefinedFilters(filters:Array):void
Adds to built in filters and refreshes the toolbar. | FlexDataGrid | |
| setSelectedItemsBasedOnSelectedField(rebuild:Boolean = false, openItems:Boolean = true):void
Sets the open items on basis of the selectedField. | FlexDataGrid | |
| setSelectedKeys(objects:Array, openItems:Boolean = true):void
For nested/grouped hierarchical datagrids, used to select records. | FlexDataGrid | |
| setSelectedObjects(objects:Array, openItems:Boolean = true):void
For nested/grouped hierarchical datagrids, used to select records. | FlexDataGrid | |
| setToolbarActionButtonProperty(toolbarActionCode:String, property:String, value:*):void
Sets a property or a style of the button object associated with the toolbar action
that has the given code. | FlexDataGrid | |
| setToolbarActions(actions:Array):void
Adds to toolbar actions, and refreshes the toolbar. | FlexDataGrid | |
| shiftColumns(columnToInsert:FlexDataGridColumn, insertBefore:FlexDataGridColumn, level:FlexDataGridColumnLevel, movingCg:Boolean = false):void
Inserts the column specified column before the specified column
| FlexDataGrid | |
| showColumns(colsToShow:ArrayCollection):void
Sets the visible flag on all columns except the ones speicified in the list to false. | FlexDataGrid | |
| showMessage(msg:String):void
Displays a message without the spinner label. | FlexDataGrid | |
| showPrintableColumns():void
Sets the visible flag on all columns except the ones where excludeFromPrint=true. | FlexDataGrid | |
| showSpinner(msg:String):void
Shows the spinner with default values defined below:
Label: "Loading please wait"
X Position : center X of the grid
Y Position : center Y of the grid
Grid Alpa when the spinner is active : 0.3
Spinner appearance can be modified using styles . | FlexDataGrid | |
| showToaster(message:String, toasterPosition:String, toasterRenderer:IFactory = null, animationDuration:Number = 1000, visibleDuration:Number = 5000, moveAnimate:Boolean = true, fadeAnimate:Boolean = true):void [override]
Shows the given toaster message
| FlexDataGrid | |
| showTooltip(relativeTo:IUIComponent, tooltip:IUIComponent, dataContext:Object, point:Point = null, leftOffset:Number = 0, topOffset:Number = 0, offScreenMath:Boolean = true, where:String = left, container:Object = null):void
Displays a tooltip for the control in question. | FlexDataGrid | |
| snapToColumnWidths():void
Goes through all the sections and resizes the cells to match the current column widths. | FlexDataGrid | |
| synchronizeHorizontalScroll():void
Synchronizes the vertical scroll positions of the three locked sections
| FlexDataGrid | |
|
Synchronizes the vertical scroll positions of the three locked sections
| FlexDataGrid | |
| trackChange(changedItem:Object, changeType:String, changeLevel:FlexDataGridColumnLevel = null, changedProperty:String = null, previousValue:* = null, newValue:* = null):void
Method to track a change, called by track change API to keep track of additions, deletions and modifications to the data provider. | FlexDataGrid | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the grid is finished exporting. | FlexDataGrid | ||
| Dispatched when the autorefresh interval is hit. | FlexDataGrid | ||
| Dispatched when the grid is about to be exported | FlexDataGrid | ||
| Dispatched when the grid is about to be generated for the print, or the preview. | FlexDataGrid | ||
| Dispatched before the beforePrint event, right prior to the data provider being set. | FlexDataGrid | ||
| Dispatched when the cell is rendered completely. | FlexDataGrid | ||
| Dispatched when row selection or cell selection changes. | FlexDataGrid | ||
| Fired when the grid needs to clear its preferences. | FlexDataGrid | ||
| Dispatched when the columns at this level are resized | FlexDataGrid | ||
| Dispatched when columns are dragged and dropped to change their position | FlexDataGrid | ||
| Dispatched when all the cells snap to the calculated column widths. | FlexDataGrid | ||
| Dispatched when the dataprovider dispatches a collection change event. | FlexDataGrid | ||
| When enableDynamicLevels=true, this event is dispatched whenever all the dynamic levels are created. | FlexDataGrid | ||
| When enableDynamicLevels=true, this event is dispatched whenever a new level is created. | FlexDataGrid | ||
| Dispatched when the grid's page, sort or filter state changes. | FlexDataGrid | ||
| Dispatched when any header cell is clicked | FlexDataGrid | ||
| Dispatched when user clicks on an icon enabled via the enableIcon flag on a column | FlexDataGrid | ||
| Dispatched when user mouse outs on an icon enabled via the enableIcon flag on a column | FlexDataGrid | ||
| Dispatched when user mouseovers on an icon enabled via the enableIcon flag on a column | FlexDataGrid | ||
| Dispatched when user clicks on a row in row selection mode or cell in cell selection mode | FlexDataGrid | ||
| Dispatched when the use clicks on the disclosure icon to collapse a previously opened item. | FlexDataGrid | ||
| Dispatched when an item is about to close. | FlexDataGrid | ||
| Dispatched when user double clicks on a row in row selection mode or cell in cell selection mode | FlexDataGrid | ||
| Dispatched when the editor is instantiated. | FlexDataGrid | ||
| Dispatched when the user attempts to edit an item. | FlexDataGrid | ||
| Dispatched when the edit session is cancelled. | FlexDataGrid | ||
| Dispatched when the edit session ends. | FlexDataGrid | ||
| Dispatched just before committing the value of the editorDataField property of the editor to the property specified by the datafield property of the column of the item being edited. | FlexDataGrid | ||
| Dispatched when the item editor receives focus. | FlexDataGrid | ||
| Dispatched only in server mode, when an item opens for the first time. | FlexDataGrid | ||
| Dispatched when the user clicks on the disclosure icon to expand a previously collapsed item. | FlexDataGrid | ||
| Dispatched when an item is about to open. | FlexDataGrid | ||
| Dispatched when user rolls out of a row in row selection mode or cell in cell selection mode (only if rollover on a different item) | FlexDataGrid | ||
| Dispatched when user rolls over a row in row selection mode or cell in cell selection mode (only if rollover on a different item) | FlexDataGrid | ||
| Fired In preferencePersistenceMode=server , when the grid needs to load its preferences. | FlexDataGrid | ||
| Dispatched when a column is created after introspecting the IOLAPResult Use this event to perform post processing of the columns after the grid has applied all its defaults | OlapFlexDataGrid | |||
| Dispatched when a grouped column is created after introspecting the IOLAPResult Use this event to perform post processing of the column group after the grid has applied all its defaults. | OlapFlexDataGrid | |||
| Dispatched when all the columns are created after introspecting the IOLAPResult Use this event to perform post processing of the columns after the grid has applied all its defaults. | OlapFlexDataGrid | |||
| Dispatched when the IOLAPREsult is converted to a nested array collection and is set as the dataprovider. | OlapFlexDataGrid | |||
| Dispatched whenever the page size is changed. | FlexDataGrid | ||
| Dispatched when the user clicks the 'Generate PDF' button on the Print Preview. | FlexDataGrid | ||
| Fired when the grid needs to persist its preferences. | FlexDataGrid | ||
| Dispatched prior to the widths, heights, x, and y of the various sections are calculated. | FlexDataGrid | ||
| Dispatched by the grid when a prebuilt filter is run. | FlexDataGrid | ||
| Fired right before preferences are being loaded and applied. | FlexDataGrid | ||
| Dispatched when the grid is sent to the printer. | FlexDataGrid | ||
| Dispatched only in server mode, when the grid needs to print or export more data than is currently loaded in memory. | FlexDataGrid | ||
| Dispatched when the renderer is initialized. | FlexDataGrid | ||
| When enableTrackChanges is set to true, this event is dispatched when any change (add,delete or update) is made to the grid. | FlexDataGrid | ||
| Dispatched when the content is scrolled. | FlexDataGrid | ||
| Dispatched when the top level select checkbox is changed | FlexDataGrid | ||
| Dispatched when any toolbarAction is executed. | FlexDataGrid | ||
| When enablevirtualScroll=true, this event is dispatched whenever the user scrolls. | FlexDataGrid | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes The color of the cell directly under the mouse or if using keyboard navigation, current keyboard seed. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The colors to use for the backgrounds of the items in the grid. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The colors to use for the text of the items in the grid. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: no Background color, the color of the fill area. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: no Color of the border. | FlexDataGrid | ||
| Type: String CSS Inheritance: no Bounding box sides. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | FlexDataGrid | ||
| Type: Class Format: EmbeddedFile CSS Inheritance: no The icon that is displayed next to a closed column group. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the Column Groups background gradient. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to force the top border. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the header horizontal grid lines. | FlexDataGrid | ||
| Type: Class Format: EmbeddedFile CSS Inheritance: no The icon that is displayed next to an open column group. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the Column Groups. | FlexDataGrid | ||
| Type: String CSS Inheritance: no The name of a CSS style declaration for controlling other aspects of the appearance of the column groups. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the header vertical grid lines. | FlexDataGrid | ||
| The style to apply to the column header menu. | FlexDataGrid | ||
| The alpha to apply to the glyph when moving the column. | FlexDataGrid | ||
| Format: Color The color of the line to draw when the user is moving or resizing the column. | FlexDataGrid | ||
| Type: Boolean Flag to indicate whether the data cells use embedded fonts. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | FlexDataGrid | ||
| Type: Class Format: EmbeddedFile CSS Inheritance: no The icon that is displayed next to a closed branch node of the navigation tree. | FlexDataGrid | ||
| Type: Class Format: EmbeddedFile CSS Inheritance: no The icon that is displayed next to an open branch node of the navigation tree. | FlexDataGrid | ||
| Type: Number Alpha for the drag operation. | FlexDataGrid | ||
| Type: String Border for the drag row for the drag operation. | FlexDataGrid | ||
| Type: Array Format: Color The colors to use for the backgrounds of the items in the grid in the editable mode. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes Background Colors for the edit row. | FlexDataGrid | ||
| Text Color for the edit row. | FlexDataGrid | ||
| Format: Color The colors to use for the text of the items in the editable grid. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The background color of the row that has the error . | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The border color of the cell that has the error . | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The color of the row background for the filter. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to force the top border, when horizontal gridlines are not drawn. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the filter horizontal grid lines. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the filter. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the filter vertical grid lines. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes A box to cover the space left behind by the horizontal scrollbar when horizontalScrollPolicy=on and there are left locked columns. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields.See also flash.text.TextField flash.text.AntiAliasType | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Name of the font to use. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.See also flash.text.TextField flash.text.GridFitType | FlexDataGrid | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | FlexDataGrid | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the footer background gradient. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to force the top border, when horizontal gridlines are not drawn. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the footer horizontal grid lines. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the footer. | FlexDataGrid | ||
| Type: String CSS Inheritance: no The name of a CSS style declaration for controlling other aspects of the appearance of the column headers. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the footer vertical grid lines. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the header background gradient. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to force the top border. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the header horizontal grid lines. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the header. | FlexDataGrid | ||
| Format: Color The color of the line between header and the sort section for multi column sort. | FlexDataGrid | ||
| Format: int The distance between the sort line and the right edge of the header cell. | FlexDataGrid | ||
| Type: String CSS Inheritance: no The name of a CSS style declaration for controlling other aspects of the appearance of the column headers. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the header vertical grid lines. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: yes Thickness of the horizontal grid lines. | FlexDataGrid | ||
| Type: String CSS Inheritance: no Style name for horizontal scrollbar. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | FlexDataGrid | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes The locale of the text displayed by this component. | FlexDataGrid | ||
lockedCellColor | Type: color CSS Inheritance: no Color for the left locked cells. These cells belong to the row axis, and are usually subject to row span (assuming you set enableRowSpan=true) | OlapFlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical seperators for the locked content. | FlexDataGrid | ||
| Type: Number CSS Inheritance: yes The width of the vertical seperators for the locked content. | FlexDataGrid | ||
| Type: Number CSS Inheritance: no The height of the numeric value representing the order of the column sort. | FlexDataGrid | ||
| Type: String CSS Inheritance: no 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. | FlexDataGrid | ||
| Type: Number CSS Inheritance: no The width of the numeric value representing the order of the column sort. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the pager background gradient. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to force the top border, when horizontal gridlines are not drawn. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the pager horizontal grid lines. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the pager. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the pager vertical grid lines. | FlexDataGrid | ||
| Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the renderer background gradient. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to force the top border, when horizontal gridlines are not drawn. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show horizontal grid lines between the rows. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the renderer horizontal grid lines. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the row background when the user rolls over a level renderer. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length Thickness of the renderer vertical grid lines. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the row. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the user selects it. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background for the row when the user selects an item renderer in the row. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the component is disabled. | FlexDataGrid | ||
| Type: Class CSS Inheritance: no The class to use as the skin for the arrow that indicates the column sort direction. | FlexDataGrid | ||
| Type: Array Format: Color Colors for the spinners as an array. | FlexDataGrid | ||
| Type: Number Format: Length Background color of the grid when the spinner is active. | FlexDataGrid | ||
| Type: uint Format: Color Bacground color for the box in which the label is displayed. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes Label color for the spinner. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Label font family. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: yes Label font size. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Label font style. | FlexDataGrid | ||
| Type: Number CSS Inheritance: yes Label font thinkcness. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Label font weight. | FlexDataGrid | ||
| Type: Number Format: Length Spinner radius , default value is 10. | FlexDataGrid | ||
| Type: Number Format: Length Spinner thickness , default value is 5. | FlexDataGrid | ||
| Type: Class CSS Inheritance: no The class to use as the skin for the cursor that indicates that a column can be resized. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | FlexDataGrid | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the text of a renderer when the component is disabled. | FlexDataGrid | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the text when the user rolls over a row. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the text when the user selects a row. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the AddRow action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the AddRow action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the edit action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the delete action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the edit action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the edit action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the Filter action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the Filter action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the Down action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the Down action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the mvoe To action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the moveTo action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the Up action, in disabled mode. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the Up action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the seperator action. | FlexDataGrid | ||
| CSS Inheritance: no The icon for the edit action. | FlexDataGrid | ||
| Type: Boolean A flag that asks the grid to use its module factory when instantiating popups. | FlexDataGrid | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Boolean CSS Inheritance: no Flag that indicates whether to show vertical grid lines between the columns. | FlexDataGrid | ||
| Type: Number Format: Length CSS Inheritance: yes Thickness of the vertical grid lines. | FlexDataGrid | ||
| Type: String CSS Inheritance: no Style name for vertical scrollbar. | FlexDataGrid | ||
| Constant | Defined By | ||
|---|---|---|---|
| COLUMN_AXIS : int = 0 [static]
A constant that corresponds to the column axis. | OlapFlexDataGrid | ||
| DRAG_FORMAT_KEY : String = NDG_DRAG_KEY
Constant to indicate that the drag was initiated by the grid
| NdgBase | |
| MOVE_BOTTOM : String = moveBottom [static] | FlexDataGrid | |
| MOVE_DOWN : String = moveDown [static] | FlexDataGrid | |
| MOVE_TOP : String = moveTop [static] | FlexDataGrid | |
| MOVE_UP : String = moveUp [static] | FlexDataGrid | |
| OLAP_DIMENSION : int = 3 [static]
A constant that corresponds to a member of an axis. | OlapFlexDataGrid | ||
| OLAP_HIERARCHY : int = 2 [static]
A constant that corresponds to a member of an axis. | OlapFlexDataGrid | ||
| OLAP_LEVEL : int = 1 [static]
A constant that corresponds to a level of an axis. | OlapFlexDataGrid | ||
| OLAP_MEMBER : int = 0 [static]
A constant that corresponds to a member of an axis. | OlapFlexDataGrid | ||
| ROW_AXIS : int = 1 [static]
A constant that corresponds to the row axis. | OlapFlexDataGrid | ||
| SLICER_AXIS : int = 2 [static]
A constant that corresponds to the slicer axis. | OlapFlexDataGrid | ||
| allItemHeaderText | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var allItemHeaderText:String = AllThe text of the all item
| collapseOnInitialize | property |
public var collapseOnInitialize:Boolean = falseThis will cause the column groups to collapse on initialize (when you set the data provider)
| convertToHierarchicalCollection | property |
public var convertToHierarchicalCollection:Boolean = trueBy default, the OLAP set that is generated is a flat collection of RowAxisPositions. If you set this flag to true, the flat array will be converted to a hierarchical array for the user to drill up and down on the hierarchy.
| dataProvider | property |
dataProvider:Object[override] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
An OLAPDataGrid accepts only an IOLAPResult as dataProvider other dataProviders are simply ignored. One can set dataProvider to null, to reset the control.
public function get dataProvider():Object public function set dataProvider(value:Object):void| defaultCellString | property |
public var defaultCellString:String = No Value| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
String displayed in a cell when the data for that cell returned by the IOLAPResult instance is null or NaN.
The default value is "NaN".
| enableColumnExpandCollapse | property |
public var enableColumnExpandCollapse:Boolean = falseIf set to true, the column groups generated will have the expand collapse functionailty builtin
| enableFillerColumn | property |
public var enableFillerColumn:Boolean = falseWhen you set horizontal scroll policy = on, this will add a filler column so that the last column in the OLAP set does not look oddly wide in case of scenarios where the sum of column widths does not add up to grid width.
| enableRowSpan | property |
public var enableRowSpan:Boolean = trueFlag to enable row span. When this is set to true, the members of the row dimension that contain multiple row positions will span across the multiple row positions that belong to them.
| enableRunningTotals | property |
public var enableRunningTotals:Boolean = trueWhen the convertToHierarchicalCollection flag is set to true, as row positions are grouped into corresponding parents the parent objects are just holder objects, with no properties. If you set this flag to true, the holder objects become full objects, with the same properties as the row positions that they contain, and the measures that form the unlocked columns get defined on these parent objects, with the values for these measures being calculated sums of the values for the measures of the children contained within the parent objects.
| getLabelForCell | property |
public var getLabelForCell:Function| olapDataProvider | property |
olapDataProvider:Object [read-only] Returns the OLAPDataprovider that was used as the basis of the columns and the hierarchical dataprovider.
public function get olapDataProvider():Object| OlapFlexDataGrid | () | Constructor |
public function OlapFlexDataGrid()| convertDataProviderToHierarchicalCollection | () | method |
public function convertDataProviderToHierarchicalCollection(rowAxis:IList, columnAxis:IList):voidTakes a rowAxis result from the IOLAPResult and turns it into a hierarchical array collection that the Ultimate Grid can then render in a nested manner.
Parameters
rowAxis:IList — The RowAxis arraycollection.
| |
columnAxis:IList — The Column Axis arraycollection.
|
| defaultLabelForCell | () | method |
public function defaultLabelForCell(data:Object, col:FlexDataGridColumn, cell:IFlexDataGridCell):StringThe default handler for the cell values. Checks to see if the column is left locked, which means we are in the row axis renderer. If so, returns IOLAPMember(data.members.getItemAt(col.colIndex))displayName Else, returns olapData.getCell(cell.rowInfo.rowPositionInfo.rowIndex, col.colIndex-col.level.leftLockedColumns.length).value;
Parameters
data:Object — Usually a IOLAPAxisPosition
| |
col:FlexDataGridColumn — The FlexDataGridColumn associated with the cell.
| |
cell:IFlexDataGridCell — The cell being renderered.
|
String — Result of the OLAP operation described above, or defaultCellString, if null.
|
| replaceSpecials | () | method |
public function replaceSpecials(str:String):StringGiven a string, replaces all space, bracket, dash and dot characters from it.
Parameters
str:String |
String |
| olapColumnCreated | Event |
com.flexicious.nestedtreedatagrid.events.OlapFlexDataGridEventDispatched when a column is created after introspecting the IOLAPResult Use this event to perform post processing of the columns after the grid has applied all its defaults
| olapColumnGroupCreated | Event |
com.flexicious.nestedtreedatagrid.events.OlapFlexDataGridEventDispatched when a grouped column is created after introspecting the IOLAPResult Use this event to perform post processing of the column group after the grid has applied all its defaults. Please note, this is dispatched after the initial column group is created, not after all the columns are added to the group. If you need that, you should use the columnsCreated event, which is dispatched after all columns and column groups are created. Please note, since the FlexDataGridEvent does not have a columnGroup property, the item property of the FlexDataGridEvent is used to store the column group that is created. Please do not modify the columns collection until AFTER olapDataProviderConverted is dispatched, because the column ordinal indexes are used in conversion of columns to hierarchical data.
| olapColumnsCreated | Event |
com.flexicious.nestedtreedatagrid.events.OlapFlexDataGridEventDispatched when all the columns are created after introspecting the IOLAPResult Use this event to perform post processing of the columns after the grid has applied all its defaults. Please do not modify the columns collection until AFTER olapDataProviderConverted is dispatched, because the column ordinal indexes are used in conversion of columns to hierarchical data.
| olapDataProviderConverted | Event |
com.flexicious.nestedtreedatagrid.events.OlapFlexDataGridEventDispatched when the IOLAPREsult is converted to a nested array collection and is set as the dataprovider. The OlapFlexDataGrid takes the IOLAPResult as a dataprovider and iterates through its row positions to convert them into an array collection of objects that have a 'children' property. This is repeated for the number of dimensions in the row, for a multi level hierarchy. This collection is then provided to the base dataprovider. You may modify the columns collection in this event.
| COLUMN_AXIS | Constant |
public static const COLUMN_AXIS:int = 0| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to the column axis.
| OLAP_DIMENSION | Constant |
public static const OLAP_DIMENSION:int = 3| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to a member of an axis.
| OLAP_HIERARCHY | Constant |
public static const OLAP_HIERARCHY:int = 2| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to a member of an axis.
| OLAP_LEVEL | Constant |
public static const OLAP_LEVEL:int = 1| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to a level of an axis.
| OLAP_MEMBER | Constant |
public static const OLAP_MEMBER:int = 0| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to a member of an axis.
| ROW_AXIS | Constant |
public static const ROW_AXIS:int = 1| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to the row axis.
| SLICER_AXIS | Constant |
public static const SLICER_AXIS:int = 2| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
A constant that corresponds to the slicer axis.