Value for the blank item in multi select combobox filter control Please note, there is a space in the front of this string so it shows up right below the "All" option.

The height on basis of the data to be displayed. If there is a header renderer, or if there is headerWordWrap we calulate this, otherwise, it is set to what ever the levels.rowHeight is.

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

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

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

A function that can be used to control the enabled flag of each cell in this column. If this function is null or returns null, the cell will be enabled, selectable, and rollovers will work. If this function returns false, the cell will not be selectable, the item renderers will be disabled and it will have no rollovers. This function should take a IFlexDataGridDataCell object, which has a pointer to the row data (data) as well as other related information found in the documentation of the FlexDataGridDataCell class. This function should true or false.

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

For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear the text on icon click. Used for a "clear" icon.

Unused, for legacy purposes only

The group, if any that this column belongs to.

In addition to the left locked and unlocked columns supported by the regular Flex DataGrid, Flexicious Ultimate supports right locked columns. The grid supports the following selection modes: 1) LOCK_MODE_LEFT 2) LOCK_MODE_RIGHT 3) LOCK_MODE_NONE If set to left, the column will be locked to the left and not scroll horizontally. If set to right, the column will be locked to the right, and not scroll horizontally. Please note, column lock modes only make sense if the horizontalScrollPolicy of the grid is set to "on" or "auto", since if there is no horizontal scrollbar, locked columns behave like unlocked columns, because there is no horizontal scroll. This horizontal scroll policy of the grid defaults to "off", and changing this to "on" or "auto" affects the calculations that we perform in deciding the optimal column widths, in that columns are no longer "squished" or "expanded" to fit the visible width of the grid. The left and right locked section for grids with flat data are wide enough to accommodate the left and right locked columns respectively. For nested grids, both left and right locked sections are wide enough to accommodate the widest left and right locked columns at each level, and for the leftLocked section, we add the width of the disclosure cells which is set via the nestIndent property for each level (it gets multiplied by the nestDepth for a tree look). There are a few restrictions with left and right locked columns. They cannot be re-ordered. Resizing them results in resizing the section that they are in. Finally, resizing them is very slightly slower than resizing the unlocked columns, because we have to redraw the grid on basis of updated section widths.

The columnWidthMode property on the column specifies how the column widths are applied. This property defaults to "none". Flexicious Ultimate provides a rich mechanism to control column widths. Column widths are a complicated topic because there are a number of scenarios and rules that we need to account for

• When there is a horizontal scroll (horizontalScrollPolicy=on or auto): In this case, the columns are free to take as much width as they need. Below is how the column widths should handle in this case:
  • When columnWidthMode=none or fixed: The column will basically take the width specified by the width property
  • When columnWidthMode=fitToContent The column will take the width calculated by its contents. The grid identifies the longest string to be displayed in this column, and sets the width of the column to this value.
  • When columnWidthMode=percent. This is not a valid setting when horizontalScrollPolicy is on or auto. The setting will be ignored and the column will take the width specified by the width property. When horizontalScrollPolicy is set to auto or on, columnWidthMode=percent holds no meaning, since there are no fixed bounds to squish the columns within.
• When there is no horizontal scroll (horizontalScrollPolicy=off - this is the default):
  • When columnWidthMode=none: The column will take the width specified by the width property, and adjust for width (see sum of Column Widths exceeds Grid Width below).
  • When columnWidthMode=fixed: The column will take the width specified by the width property, and not adjust for width.
  • When columnWidthMode=fitToContent: The column will take the width calculated by its contents, and adjust for width (see sum of Column Widths exceeds Grid Width below).
  • When columnWidthMode=percent: For these columns, the grid divides the remaining width after allocating all fixed and fitToContent columns, on a percentage basis among all columns that have columnWidthMode set to percent. PLEASE NOTE : If you set columnWidthMode='percent', also set percentWidth. Also, ensure that the percentWidth of the columns adds up to a 100.

• Grid Width exceeds Sum of Column Widths: The situation where the calcualted column widths do not add upto the grid with is also handled on basis of the horizontalScrollPolicy.
  • When there is a horizontal scroll (horizontalScrollPolicy=on or auto): The last column extends to fill up all the remaining space. If you do not want your last column to resize, add a dummy column that has the following property (order is important) minWidth="1" width="1" paddingLeft="0" paddingRight="0"
  • When there is no horizontal scroll (horizontalScrollPolicy=off - this is the default): The extra width is divided proportionally between all the columns where columnWidthMode does not equal fixed.

• Sum of Column Widths exceeds Grid Width: Similarly, The situation where the allocated column widths exceed the width of the grid with is also handled on basis of the horizontalScrollPolicy.
  • When there is a horizontal scroll (horizontalScrollPolicy=on or auto): We simply show a scroll bar, and no column widths are changed.
  • When there is no horizontal scroll (horizontalScrollPolicy=off - this is the default): This excess width is reduced proportionally between columns where columnWidthMode does not equal fixed.

The default value is auto.

Whether or not to include the header text in the calculation of the column width.

The default value is false.

A value in pixels, that may be used to add/remove width that gets calculated when you use the columnWidthMode property Use if you have custom renderers or icons.

Container for the item renderer. Needs to implement IFlexDataGridDataCell. Defaults to FlexDataGridDataCell

The property to display in this column. If you specify a complex property ,the grid takes over the sortCompareFunction, and the sortField property is ignored.

Flag that indicates whether the user is allowed to resize the width of the column. Please note, left and right locked columns are not resizable

The default value is true.

Flag that indicates whether the items in the column are editable.

The name of the property of the item editor that contains the new data for the list item.

Flag to enable selection of a row when a cell within that row is clicked. You may choose to set this to false when you set selectable =true. When the user clicks on a cell, the row is automatically selected when the selection mode is either single row or multiple rows. When you have cells that are selectable, the user may wish to select the text in the cell as opposed to selecting the row. Setting this flag to false will disable the row selection when any cell within this column is clicked.

The default value is true.

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

For hierarchical datagrids, instead of having a separate column for icons, this flag will be used to embed an icon based on disclosureOpenIcon and disclosureClosedIcon within this column that will control the expand collapse of the row.

When filterControl=textInput, setting this flag to true will set the enableAutoComplete flag on the associated TextInput control

For grouped datagrids, when a single column represents entities from various nest levels, its nice to visually indent them. Set this parameter to true for such columns If you wish to programatically control the padding, you could do so via the rendererInitialized event on the grid.

The default value is true.

Flag to enable/disable icons within this cell. For columns that have icons (with or without text), you can

• Set enableIcons=true.
• If it will be the same icon for each cell, just set the "icon" style property on the column.
• If it will be different icons based on some logic, you can either provide that via the iconField property, or specify an iconFunction.
• If the cell will contain just an icon and no text, then set hideText/hideHeaderText to true.
• If the header also needs an icon, use the headerIconUrl property.
• Specify (iconLeft or iconRight) and (iconTop or iconBottom). If not specified, icon will be placed to the right middle of the cell.
• If needed, Wire up the iconClick or iconMouseOver (delay)/iconMouseOut, and specify iconMouseOverDelay (default 250 msec).
• Set enableIconHandCursor if needed.
• Set the iconTooltip, iconTooltipFunction, iconTooltipRenderer (for custom interactive popovers) as needed.
• Set the showIconOnRowHover and showIconOnCellHover as needed (If you only wish to show the icon when the user hovers over the cell or the row.

Added to avoid flicker

For Grouped datagrids, searching on this column will cause match current item, as well as any of its children. If any children match, this item matches as well.

If set to true, this column wont be included in the export mechanism by default.

If set to true, this column wont be included in the print mechanism by default.

If set to true, this column wont be included in the settings popup by default.

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

Flag, if set to true, will automatically build this collection on basis of distinct values in the grid.

Used in conjunction with the

Dataprovider to use to build the list of values to dipsplay in the filter control, only applicable if the filterControl is a

See also

Used in conjunction with the

Returns the width of the dropdown. Applicable only when the filter controls are comboboxes

A function that takes an item, and a filterExpression, and returns true or false on basis of whether the provided item matches the filterExpression. Please note, the filterExpression has a pointer to the iFilterControl that it was created from.

This is usually automatically set, you dont have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion. Values : auto,string,number,boolean,date

The default value is auto.

A control that implements

See also

A function that takes an item, and returns a processed value for comparison. For example, if your backend sends down strings that represents a date, wire this function up and return a date object for comparison purposes.

Applicable only when the filtercontrol is a

See also

The operator to apply when doing the conversion. See FILTER_OPERATION_TYPE constant values from com.flexicious.grids.filters.FilterExpression

The actual control to render inside the header column. This control must implement the com.flexicious.controls.interfaces.filters.IFilterControl interface.

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

The event that the filter triggers on. Defaults to "change", or if the filterRenderer supports com.flexicious.controls.interfaces.IDelayedChange, then the delayedChange event.

See also

Applicable only if the filter control is TextInput. If set, sets the watermark of the TextInput filter to the value specified.

The alignment of the footer label

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

Formatter for the footer label

The label of the footer

A function that will return the footer label

Similar to footerLabelFunction, but takes the footer cell instead of the column. The footer label function is present for backwards compatibility

The operation to apply to the footer

Precision for the footer label

A renderer for the footer

The alignment of the header label

Used by the doFormat method.

Used by the doFormat method. Formatter to use when format not equals none. On basis of format, a new formatter is initialized. If you wish to override the format of the default formatter, you can provide your own formatter here.

For currency formatter, the currency symbol. Defaults to blank value.

For date formatters, the date format. Defaults to blank value. Initialized on basis of date format. If you wish to override the default format, you can use this string.

For number and currency formatters, the default number of digits after the decimal point. Defaults to 2

Performance optimization, is set to true if there is a complex fieldname or a labelFunction or labelFunction2

The alignment of the header label

Container for the header renderer. Needs to inherit from FlexDataGridHeaderCell. Defaults to FlexDataGridHeaderCell

A list of ToolbarActions to show when the user hovers their mouse over the header cell of this column. Defaults to ColumnHeaderOperationBehavior.DEFAULT_COLUMN_HEADER_OPERATIONS.

The class factory for item renderer instances that display the column header for the column.

Text for the header of this column. By default, the DataGrid control uses the value of the dataField property as the header text.

Tooltip to apply to the header. Setting this at runtime has no effect, need to set it before init. If you set it after, call rebuild.

The alignment of the header label

The header text is used in the column picker, export, etc. However, if you do not wish for it to be displayed in the view, set this to true. Used for IconColumns.

In scenarios where you only want to display the icon, set enableIcon=true, and hideText=true;

The property on the model object that returns the url to the icon, if you wish to show different icons for each cell. Defaults to data field. If there are scenarios where you wish to show both the icon as well as the text, you can specify the iconField and the dataField. Otherwise, where you show just the icon, you can leave the iconField blank and have the data field specify the value of the icon url.

If enableIcon=true, icon function for the icon. Default implementation has the following logic: 1) If this is a header cell, returns the value of the headerIcon style property 2) Else if this is a data cell, and the value of either the icon,overIcon or disabledIcon style property on basis of the passed in state is available, returns it. 3) Else if this is a data cell, and the iconField is not empty, returns the value of the iconField for the row data Should take an IFlexDataGridCell object.

If enableIcon=true, enables hand cursor on the icon

The delay to wait until dispatching the iconMouseOver event when the user mouse the mouse over the icon. Defaults to 500

If enableIcon=true, tooltip for the icon

If enableIcon=true, tooltip function for the icon. Default implementation returns the value of the iconToolTip. Should take an IFlexDataGridCell object.

The renderer factory for the icon tooltip. Defaults to null. If null, we simply show a string tooltip, else we call the showtooltip function on the grid passing in an instance of the class factory specified here.

A function that takes a IFlexDataGridCell, and returns true if this cell is editable. Use this in scenarios where some cells out of a column are not editable.

Returns true if the column is not right locked or IFixedWidth.

Returns true if the column is left locked.

Returns true if the column is left or right locked.

Returns true if the column is right locked.

MX and Spark Grids implement the sortable differently, so to match the interface.

A class factory for the instances of the item editor to use for the column, when it is editable.

The default value is new ClassFactory(mx.controls.TextInput).

In Edit mode, we only apply the new value to the model object when the user either hits the enter key or the tab key after typing input. This works fine for most cases, but for ItemEditors like date fields or Select Boxes, you may wish to apply the value on Change. In this case, set this flag to true.

Indicates that the item editors manage their own persitence and populating the dataprovider back with their changes, so the editorDataField is ignored and the DataGrid does not write back the value from the editor into the data provider. When you set itemEditorManagesPersistence, the itemEditorValidatorFunction or itemEditorApplyValueOnCommit are ignored, since we completely handover the responsibility of validating and persisting the data from the editor back into the dataprovider to the editor

Function to call before committing the value of the item editor to the data provider. Should take a UIComponent with is the item editor, and return a true or a false. If false, value is not committed If true, value is committed.

Each Cell in the grid is contains an instance of this class.

For support in pickers

A function that determines the text to display in this column.

A specialized function that determines the text to display in this column, and takes the actual cell being evaluated as a parameter. As opposed to the regular label function, this actually takes a FlexDataGridCell object as a parameter, which contains the level information if you need to perform additonal logic. Please note, the cell parameter will be null in certain cases, like from the quickFind() method, where the cell is not currently drawn. Example: labelFunction="myLabelFunc" private function myLabelFunc(item:Object,col:FlexDataGridColumn, cell:FlexDataGridCell=null):String{ }

Deprecated. Use cell text instead.

The mininum width that a column can receive. After all calculations are made, it could result in some columns being squished beyond a certain value, where they're hardly visible. Setting a value for this property ensure this does not happen.

Gets the nest depth of the associated level.

On creation complete, will use this to distribute the width of the grid among the visible columns in the specified ratio.

For datagrids where there are multiple columns with the same header text, this field may be specified so that the persistence mechanism does not overwrite it.

Flag that indicates whether the user is allowed to resize the width of the column. Please note, left and right locked columns are not resizable

The default value is true.

The field that the filter should search on. Defaults to the dataField property from mx.controls.dataGridClasses.DataGridColumn. But can be overridden if needed. For example, consider a grid bound to a list of Employee objects, with a departmentName and departmentId property. This column shows the departmentName, with a combobox filter or a multi-select filter using a list of departments as filterComboBoxDataProvider By default, the comparison will occur using the selected label of the filter control being compared to the departmentName property of each employee. This is allright if the filterPageSortMode property of the com.flexicious.grids.ExtendedDataGrid is set to "client", but if it is "server" , you would ideally want to have the ID of the selected department(s). In that case, you would set the searchField property to "departmentId", filterComboBoxDataField to "departmentId", filterComboBoxLabelField to "departmentName".

Flag that indicates whether the items in the column are selectable.

For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear show the icon only when there is text in the box.

If set to true, icon only shows when user hovers over the cell.

If set to true, icon only shows when user hovers over the row.

Flag that indicates whether the user can click on the header of this column to sort the data provider.

The default value is true.

To sort this column insensitive of case. Only set this to true for string data, if you set this to true for numeric or date data, the sort results will be incorrect.

A callback function that gets called when sorting the data in the column.

Similar to searchField, if you want to override what the database actually sorts when you sort this column

To sort this column numerically.

For 3.5 Compatibility

If this propery is true, the text that does not fit in the available size is truncated with "...".

A key used to uniquely identify a column. Defaults to the header text Used in print and preference persistence to identify columns.

Not supported

For list based item editors, setting this flag will use the dataprovider from the filter mechanism for the item editor.

Prior to dispatching the icon roll over, we use a timer so accidental roll over does not cause popups. But sometimes you need this behavior, for example for custom cursors overicons. set this to false in that case

Flag, that defaults to true, indicates that in client filter mode, use the label function to perform the search comparison as opposed to using the raw value of the "searchField" property of the column.

When you set to true, a custom sortCompareFunction is applied that uses the labelFunction instead of the dataField.

When true, if the renderer supports the text decoration style property, sets it to underline.

Flag that indicates whether the column is visible. If true, the column is visible.

The default value is true.

The width of the column, in pixels.

The default value is 100.

Flag to indicate that the text in this column can flow into multiple lines, based upon the width of the column. This flag is usually set in combination with the variableRowHeight flag on the grid. Below are the docs for the variableRowHeight tag:

Current X position of this column relative to the container for its cells.

Default Icon tooltip function. Returns value of the iconToolTip string.

Parameters

Default Icon tooltip function. Returns value of the iconToolTip string.

Parameters

Depending on the specified chrome type, gets the appropriate renderer. If truncateToFit or selectable is true, returns a label factory else returns a text field factory.

Parameters

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

Parameters

The doFormat method returns formatted value on basis of the format properties (See description below) If the input is null, returns null. If there is a formatter specified, uses the formatter's format method to return a formatted value. If the format property is specified and no formatter is specified, the column will instantiate a formatter on basis of the value of the format property. The property can be one of 5 constants.

• date (FORMAT_DATE) - Uses the DateUtils.MEDIUM_DATE_MASK format MMM D, YYYY - Can be customized using formatterDateString Property
• datetime (FORMAT_DATE_TIME) - Uses the DateUtils.LONG_DATE_MASK+ " " + DateUtils.MEDIUM_TIME_MASK format MMM D, YYYY L:NN:SS A - Can be customized using formatterDateString Property
• time (FORMAT_TIME) - Uses the DateUtils.LONG_TIME_MASK format. L:NN:SS A TZD - Can be customized using formatterDateString Property
• currency (FORMAT_CURRENCY) - Uses formatterCurrencySymbol and formatterPrecision properties for the currency formatter.
• number (FORMAT_NUMBER) - Uses formatterPrecision properties for the number formatter.

Parameters

Parameters

Returns this list of distinct values for this column, in a list of arraycollection which will have properties data and label.

Parameters

Gets the style value for the provided style property at the current level. If not defined at current level, gets the one defined at the grid level.

Parameters

Parameters

Returns the String that the item renderer displays for the given data object.

Parameters

function that is used when we have complex properties in the datafield.

Parameters

Unused, for legacy purposes only

Parameters

Dispatched when the column width changes for any reason, including programmatic recalculation of column widths

Dispatched when the column x changes for any reason, including programmatic recalculation of column x

Default width of the columns

Used by the doFormat method.

Used by the doFormat method.

Used by the doFormat method.

Used by the doFormat method.

Used by the doFormat method.

Used by the doFormat method.