flexiciousNmsp.FlexDataGridColumn Class

Extends CSSStyleDeclaration

The FlexDataGridColumn class describes a column in a FlexDataGrid Column control.

Constructor

`flexiciousNmsp.FlexDataGridColumn`

()

Index
Methods
Properties
Events

Item Index

Methods

`defaultIconFunction`

()

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

`defaultIconTooltipFunction`

()

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

`deriveRenderer`

()

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.

`dispatchEvent`

()

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

`doFormat`

(

retVal

)

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.

Based on the formatter created above, the value will be returned.

Parameters:

retVal Object

String to format

Returns:

Formatted string.

`getAdjacentColumn`

()

`getClickBehavior`

()

Unused, for legacy purposes only

`getColIndex`

()

`getColumnLockMode`

()

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.

`getColumnLockMode`

()

`getDataCellRenderer`

()

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

Returns:

`getDataField`

()

The name of the field or property in the data provider item associated with the column. Each DataGridColumn control requires this property and/or the labelFunction property to be set in order to calculate the displayable text for the item renderer. If the dataField and labelFunction properties are set, the data is displayed using the labelFunction and sorted using the dataField. If the property named in the dataField does not exist, the sortCompareFunction must be set for the sort to work correctly.

This value of this property is not necessarily the String that is displayed in the column header. This property is used only to access the data in the data provider. For more information, see the headerText property.

If you specify a complex property ,the grid takes over the sortCompareFunction, and the sortField property is ignored.

`getDistinctValues`

()

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

`getEditable`

()

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

`getFilterControl`

()

A control that implements IFilterControl

Returns:

`getFilterRenderer`

()

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

Returns:

`getHeaderText`

()

If you specify a complex property ,the grid takes over the sortCompareFunction, and the sortField property is ignored.

`getIconField`

()

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.

`getIndex`

()

`getIsElastic`

()

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

`getIsFirstRightLocked`

()

`getIsFirstUnLocked`

()

`getIsLastLeftLocked`

()

`getIsLastleftLocked`

()

`getIsLastrightLocked`

()

`getIsLastUnLocked`

()

`getIsLeftLocked`

()

Returns true if the column is left locked.

`getIsLocked`

()

Returns true if the column is left or right locked.

`getIsRightLocked`

()

Returns true if the column is right locked.

`getIsSortable`

()

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

`getLabel`

()

For support in pickers

Returns:

`getLabelFunction`

()

A function that determines the text to display in this column. By default the column displays the text for the field in the data that matches the column name. However, sometimes you want to display text based on more than one field in the data, or display something that does not have the format that you want. In such a case you specify a callback function using labelFunction.

For the DataGrid control, the method signature has the following form:

labelFunction(item:Object, column:DataGridColumn):String

Where item contains the DataGrid item object, and column specifies the DataGrid column.

A callback function might concatenate the firstName and lastName fields in the data, or do some custom formatting on a Date, or convert a number for the month into the string for the month.

`getLabelFunction2`

()

A specialized function that determines the text to display in this column, and takes the actual cell being (a) evaluated parameter.

As opposed to the regular label function, this actually takes a FlexDataGridCell (a) object 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 String myLabelFunc(Object item, FlexDataGridColumn col, FlexDataGridCell cell ){ }

`getLevel`

()

`getNestDepth`

()

Gets the nest depth of the associated level.

Returns:

`getNestedSortCompareFunction`

()

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

`getOwner`

()

`getPersistenceKey`

() deprecated

Deprecated: - now defaults to the uniqueIdentifier.

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.

`getSearchField`

()

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

`getSortField`

()

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

`getSortFieldName`

()

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

`getStyleValue`

()

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.

`getUniqueIdentifier`

()

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

Returns:

`getVisible`

()

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

`getWidth`

()

The width of the column, in pixels.

`getX`

()

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

`hasCustomItemRenderer`

()

`isValidStyleValue`

()

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

`itemToLabel`

()

Returns the String that the item renderer displays for the given data object. If the DataGridColumn or its DataGrid control has a non-null labelFunction property, it applies the function to the data object. Otherwise, the method extracts the contents of the field specified by the dataField property, or gets the string value of the data object. If the method cannot convert the parameter to a String, it returns a single space.

Returns:

Displayable String based on the data.

`itemToLabelCommon`

()

`kill`

()

`labelFunctionSortCompare`

()

`setColumnLockMode`

(

val

)

Parameters:

val Object

`setColumnLockMode`

(

val

)

Parameters:

val Object

`setColumnWidthMode`

(

val

)

Parameters:

val Object

`setDataCellRenderer`

()

`setDataField`

()

`setEditable`

()

`setFilterControl`

()

The filter control to associate with this column. There are a number of built in filter controls, and you can even write your own by implementing the IFilterControl interface. To be implemented by any control that can participate in the filtering mechanism.

There are the following controls available out of the box:

TextInput

TriStateCheckBox

ComboBox

MultiSelectComboBox

DateComboBox

DateRangeBox

NumericRangeBox

NumericTextInput

You can write your own custom text input controls by extending any of these, or by implementing the IFilterControl, ICustomMatchFilterControl, or IDynamicFilterControl. For an example of this, please look at http://blog.flexicious.com/post/ICustomMatchFilterControl-example.aspx

`setFilterRenderer`

(

value

)

Parameters:

value Object

`setFooterFormatter`

()

Formatter for the footer label

`setHeaderText`

()

`setIconField`

()

`setLabelFunction2`

()

`setPersistenceKey`

(

val

)

Parameters:

val Object

`setSearchField`

(

val

)

Parameters:

val Object

`setSortField`

(

val

)

Parameters:

val Object

`setStyle`

()

`setUniqueIdentifier`

()

`setVisible`

()

`setWidth`

()

`setX`

()

Properties

`activeCellColor`

Uint

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

Default: #000000

`alternatingItemColors`

Array

[Style(name="alternatingItemColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the backgrounds of the items in the grid. The value is an array of two or more colors. The backgrounds of the list items alternate among the colors in the array.

Default: undefined

`alternatingTextColors`

Array

[Style(name="alternatingTextColors", type="Array", arrayType="uint", format="Color", inherit="yes")] The colors to use for the text of the items in the grid. The value is an array of two colors. The text color of the list items alternate among the colors in the array.

Default: [ #000000, #000000]

`backgroundColor`

Array

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

`blankValuesLabel`

Unknown

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.

`cellBackgroundColorFunction`

Unknown deprecated

Deprecated: Use the grid.cellBackgroundColorFunction instead.

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 ((well) data) 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.

`cellBorderFunction`

Unknown

A function that lets you control the border drawing mechanism for 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 (a) in parameter to this function. If this function returns false, the default border is not drawn.

`cellCustomDrawFunction`

Unknown

A function that lets you control the background drawing mechanism for 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 (a) in parameter to this function. If this function returns false, the default background is not drawn.

`cellDisabledFunction`

Unknown

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 ((well) data) as other related information found in the documentation of the FlexDataGridDataCell class. This function should true or false.

`cellTextColorFunction`

Unknown deprecated

Deprecated: . Use the grid.cellTextColorFunction instead.

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 ((well) data) as other related information found in the documentation of the FlexDataGridDataCell class. This function should return a single color hex code (uint).

`clearFilterOnIconClick`

Unknown

`color`

Uint

[Style(name="color", type="uint", format="Color", inherit="yes")] Color of text in the component, including the component label.

The default value for the Halo theme is 0x0B333C. The default value for the Spark theme is 0x000000.

`color`

Uint

[Style(name="color", type="uint", format="Color", inherit="yes")] Color of text in the component, including the component label.

The default value for the Halo theme is 0x0B333C. The default value for the Spark theme is 0x000000.

Default: null

`columnGroupClosedIcon`

Class

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

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

Default: null

`columnGroupColors`

Array

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

Default: [0xFFFFFF, 0xE6E6E6]

`columnGroupDrawTopBorder`

Boolean

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

Default: false

`columnGroupHorizontalGridLineColor`

Uint

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

Default: 0x666666

`columnGroupHorizontalGridLines`

Boolean

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

Default: false

`columnGroupHorizontalGridLineThickness`

Number

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

Default: 1

`columnGroupOpenIcon`

Class

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

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

Default: null

`columnGroupRollOverColors`

Array

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

The default value is [0xE6E6E6,0xFFFFFF]

Default: null

`columnGroupStyleName`

String

[Style(name="columnGroupStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the column groups.

Default: "columnGroupStyle"

`columnGroupVerticalGridLineColor`

Uint

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

Default: 0x666666

`columnGroupVerticalGridLines`

Boolean

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

Default: true

`columnGroupVerticalGridLineThickness`

Number

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

Default: 1

`columnTextColor`

Uint

[Style(name="columnTextColor", type="uint", format="Color", inherit="yes")] The color of the cell text of each cell in this column. Usually these colors are controlled via the alternatingTextColors style property of the level or the grid. In case you wish to have this column have a specific text color, you may use this property. The default value is null

Default: null

`columnWidthModeFitToContentExcludeHeader`

Unknown

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

Default: false

`columnWidthOffset`

Unknown

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.

`dataField`

Unknown

If you specify a complex property ,the grid takes over the sortCompareFunction, and the sortField property is ignored.

`disabledColor`

Uint

[Style(name="disabledColor", type="uint", format="Color", inherit="yes")] Color of text in the component if it is disabled.

Default: 0xAAB3B3

`disabledIcon`

Null

[Style(name="disabledIcon")] When enableIcon=true, this property specifies the icon to display when enabled=false. If the icon is dynamic, use the dataField to specify the url instead.

Default: null

`disclosureClosedIcon`

Class

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

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

Default: null

`disclosureOpenIcon`

Class

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

Default: null

`draggable`

Unknown

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

Default: true

`editItemColor`

Array

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

Default: undefined

`editorDataField`

Unknown

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

`editorStyleName`

String

[Style(name="editorStyleName", type="String")] Style to apply to the item editor.

Default: null

`editTextColor`

Null

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

Default: null

`enableCellClickRowSelect`

Unknown

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 (opposed) cell to selecting the row. Setting this flag to false will disable the row selection when any cell within this column is clicked.

`enableExpandCollapseIcon`

Unknown

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.

`enableFilterAutoComplete`

Unknown

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

`enableHierarchicalNestIndent`

Unknown

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.

Default: true

`enableIcon`

Unknown

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 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 (needed) popovers).
Set the showIconOnRowHover and (needed) showIconOnCellHover (If you only wish to show the icon when the user hovers over the cell or the row.

`enableLocalStyles`

Unknown

Added to avoid flicker

`enableRecursiveSearch`

Unknown

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.

`excludeFromExport`

Unknown

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

`excludeFromPrint`

Unknown

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

`excludeFromSettings`

Unknown

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

`expandCollapseIconBottom`

Number

[Style(name="expandCollapseIconBottom", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom

Default: null

`expandCollapseIconLeft`

Number

[Style(name="expandCollapseIconLeft", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom

Default: null

`expandCollapseIconRight`

Number

[Style(name="expandCollapseIconRight", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom

Default: null

`expandCollapseIconTop`

Number

[Style(name="expandCollapseIconTop", type="Number")] When enableExpandCollapseIcon=true, To position the icon correctly, you can set either expandCollapseIconLeft or expandCollapseIconRight, and expandCollapseIconTop or expandCollapseIconBottom

Default: null

`filterCellRenderer`

Unknown

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

`filterColors`

Array

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

Default: null

`filterComboBoxBuildFromGrid`

Unknown

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

`filterComboBoxDataField`

Unknown

Used in conjunction with the @filterComboBoxDataProvider field, used to set the value of the data field for the associated ISelectFilterControl

`filterComboBoxDataProvider`

Unknown

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

`filterComboBoxLabelField`

Unknown

Used in conjunction with the @filterComboBoxDataProvider field, used to set the value of the label field for the associated ISelectFilterControl

`filterComboBoxWidth`

Unknown

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

`filterCompareFunction`

Unknown

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.

`filterComparisionType`

Unknown

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

`filterConverterFunction`

Unknown

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.

`filterDateRangeOptions`

Unknown

Applicable only when the filtercontrol is a

`filterDrawTopBorder`

Boolean

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

Default: false

`filterDrawTopBorder`

Boolean

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

Default: false

`filterHorizontalGridLineColor`

Uint

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

Default: null

`filterHorizontalGridLines`

Boolean

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

Default: false

`filterHorizontalGridLineThickness`

Number

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

Default: 1

`filterIcon`

Null

[Style(name="filterIcon")] When filterControl=textInput, the icon that is displayed inside the textbox, based on the insideIconPosition property.

Default: null

`filterIconPosition`

String

[Style(name="filterIconPosition", type="String", enumeration="left,right")] When filterControl=textInput, the position of the icon that is displayed inside the textbox. Default 'right'

Default: null

`filterOperation`

Unknown

The operator to apply when doing the conversion. See FILTER_OPERATION_TYPE constant values from com.flexicious.grids.filters.FilterExpression. Here are a list of options:

Equals
NotEquals
BeginsWith
EndsWith
Contains
DoesNotContain
GreaterThan
LessThan
GreaterThanEquals
LessThanEquals
InList
NotInList
Between

`filterPaddingBottom`

Number

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

Default: 2

`filterPaddingLeft`

Number

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

Default: 1

`filterPaddingRight`

Number

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

Default: 0

`filterPaddingTop`

Number

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

Default: 2

`filterRollOverColors`

Array

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

Default: null

`filterTriggerEvent`

Unknown

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

`filterVerticalGridLineColor`

Uint

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

Default: 0x666666

`filterVerticalGridLines`

Boolean

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

Default: true

`filterVerticalGridLineThickness`

Number

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

Default: 1

`filterWaterMark`

Unknown

`footerAlign`

Unknown

The alignment of the footer label

`footerCellRenderer`

Unknown

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

`footerColors`

Array

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

Default: [0xCFCFCF, 0xCCCCCC]

`footerDrawTopBorder`

Boolean

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

Default: false

`footerDrawTopBorder`

Boolean

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

Default: false

`footerFormatter`

Unknown

Formatter for the footer label.

`footerHorizontalGridLineColor`

Uint

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

Default: null

`footerHorizontalGridLines`

Boolean

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

Default: false

`footerHorizontalGridLineThickness`

Number

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

Default: 1

`footerLabel`

Null

Label for the footer

`footerLabelFunction`

Unknown

A function that will return the footer label

`footerLabelFunction2`

Unknown

`footerOperation`

Unknown

The operation to apply to the footer. One of the following values:

average
sum
min
max
count

`footerOperationPrecision`

Unknown

Precision for the footer label

`footerPaddingBottom`

Number

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

Default: 2

`footerPaddingLeft`

Number

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

Default: 1

`footerPaddingRight`

Number

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

Default: 0

`footerPaddingTop`

Number

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

Default: 2

`footerRenderer`

ClassFactory

A renderer for the footer

`footerRollOverColors`

Array

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

Default: null

`footerStyleName`

String

[Style(name="footerStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.

Default: "dataGridStyles"

`footerVerticalGridLineColor`

Uint

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

Default: 0x666666

`footerVerticalGridLines`

Boolean

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

Default: true

`footerVerticalGridLineThickness`

Number

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

Default: 1

`footerWordWrap`

Unknown

Flag that controls whether or not to show variable sized footers. The height of the footer section is increased until the longest text is fully shown

`format`

Unknown

Used by the doFormat method. One of the following values: FlexDataGridColumn.FORMAT_NONE="none"; FlexDataGridColumn.FORMAT_DATE="date"; FlexDataGridColumn.FORMAT_DATE_TIME="datetime"; FlexDataGridColumn.FORMAT_TIME="time"; FlexDataGridColumn.FORMAT_CURRENCY="currency"; FlexDataGridColumn.FORMAT_NUMBER="number";

`formatter`

Unknown

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.

`formatterCurrencySymbol`

Unknown

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

`formatterDateFormatString`

Unknown

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.

`formatterPrecision`

Unknown

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

`hasComplexDisplay`

Unknown

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

`headerAlign`

Unknown

The alignment of the header label enumeration="left,right,center", defaultValue="left"

`headerCellRenderer`

Unknown

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

`headerColors`

Array

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

Default: [0xFFFFFF, 0xE6E6E6]

`headerDrawTopBorder`

Boolean

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

Default: false

`headerDrawTopBorder`

Boolean

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

Default: false

`headerHorizontalGridLineColor`

Uint

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

Default: null

`headerHorizontalGridLines`

Boolean

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

Default: false

`headerHorizontalGridLineThickness`

Number

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

Default: 1

`headerIcon`

Null

[Style(name="headerIcon")] When enableIcon=true, this property specifies the icon to display. If the icon is dynamic, use the dataField to specify the url instead.

Default: null

`headerPaddingBottom`

Number

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

Default: 2

`headerPaddingLeft`

Number

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

Default: 1

`headerPaddingRight`

Number

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

Default: 0

`headerPaddingTop`

Number

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

Default: 2

`headerRenderer`

Unknown

Storage for the headerRenderer property.

`headerRollOverColors`

Array

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

The default value is [0xE6E6E6,0xFFFFFF]

Default: null

`headerStyleName`

String

[Style(name="headerStyleName", type="String", inherit="no")] The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.

Default: "dataGridStyles"

`headerVerticalGridLineColor`

Uint

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

Default: 0x666666

`headerVerticalGridLines`

Boolean

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

Default: true

`headerVerticalGridLineThickness`

Number

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

Default: 1

`headerWordWrap`

Unknown

Flag that controls whether or not to show variable sized headers. The height of the header section is increased until the longest text is fully shown

`hideHeaderText`

Unknown

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.

`hideText`

Unknown

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

`horizontalGridLineColor`

Uint

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

Default: null

`horizontalGridLines`

Boolean

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

Default: false

`horizontalGridLineThickness`

Number

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

Default: 1

`icon`

Null

[Style(name="icon")] When enableIcon=true, this property specifies the icon to display. If the icon is dynamic, use the dataField to specify the url instead.

Default: null

`iconBottom`

Number

[Style(name="iconBottom", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom

Default: null

`iconFunction`

Unknown

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.

`iconHandCursor`

Unknown

If enableIcon=true, enables hand cursor on the icon

`iconHeight`

Number

[Style(name="iconHeight", type="Number")] When enableIcon=true, To position the icon correctly, we need to know the height and width of the icon Since the icon is not yet drawn, sometimes we do not know how big the icon will be. This property lets you specify that.

Default: null

`iconLeft`

Number

[Style(name="iconLeft", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom

Default: null

`iconMouseOverDelay`

Unknown

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

`iconRight`

Number

[Style(name="iconRight", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom

Default: null

`iconToolTip`

Unknown

If enableIcon=true, tooltip for the icon

`iconToolTipFunction`

Unknown

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

`iconTooltipRenderer`

Unknown

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.

`iconTop`

Number

[Style(name="iconTop", type="Number")] When enableIcon=true, To position the icon correctly, you can set either iconLeft or iconRight, and iconTop or iconBottom

Default: null

`iconWidth`

Number

[Style(name="iconWidth", type="Number")] When enableIcon=true, To position the icon correctly, we need to know the height and width of the icon Since the icon is not yet drawn, sometimes we do not know how big the icon will be. This property lets you specify that.

Default: null

`isEditableFunction`

Unknown deprecated

Deprecated: Use grid.cellEditableFunction

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.

`itemEditor`

Unknown

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

Default: FlexDataGridColumn.static_TextInput

`itemEditorApplyOnValueCommit`

Unknown

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.

`itemEditorManagesPersistence`

Unknown

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

`itemEditorValidatorFunction`

Unknown

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

`itemRenderer`

Unknown

The class factory for item renderer instances that display the data for each item in the column. You can specify a ClassFactory ustom item renderer component as the value of this property.

The default item renderer is a TextView class, which displays the item data as text.

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

`linkText`

Unknown deprecated

`minWidth`

Unknown

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.

`multiColumnSortNumberHeight`

Number

[Style(name="multiColumnSortNumberHeight", type="Number", inherit="no")] The height of the numeric value representing the order of the column sort.

Default: 15

`multiColumnSortNumberStyleName`

String

[Style(name="multiColumnSortNumberStyleName", type="String", inherit="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.

Default: "multiColumnSortNumberStyle"

`overIcon`

Null

[Style(name="overIcon")] When enableIcon=true, this property specifies the icon to display. If the icon is dynamic, use the dataField to specify the url instead.

Default: null

`paddingBottom`

Number

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

Default: 2

`paddingLeft`

Number

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

Default: 1

`paddingRight`

Number

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

Default: 0

`paddingTop`

Number

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

Default: 2

`pagerColors`

Array

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

Default: [0xCCCCCC, 0xCCCCCC]

`pagerDrawTopBorder`

Boolean

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

Default: false

`pagerDrawTopBorder`

Boolean

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

Default: false

`pagerHorizontalGridLineColor`

Uint

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

Default: null

`pagerHorizontalGridLines`

Boolean

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

Default: false

`pagerHorizontalGridLineThickness`

Number

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

Default: 1

`pagerPaddingBottom`

Number

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

Default: 2

`pagerPaddingLeft`

Number

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

Default: 1

`pagerPaddingRight`

Number

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

Default: 0

`pagerPaddingTop`

Number

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

Default: 2

`pagerRollOverColors`

Array

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

Default: [0xE6E6E6,0xFFFFFF]

`pagerVerticalGridLineColor`

Uint

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

Default: 0x666666

`pagerVerticalGridLines`

Boolean

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

Default: true

`pagerVerticalGridLineThickness`

Number

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

Default: 1

`percentWidth`

Unknown

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

`rendererColors`

Array

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

Default: [0xFFFFFF, 0xFFFFFF]

`rendererDrawTopBorder`

Boolean

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

Default: false

`rendererDrawTopBorder`

Boolean

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

Default: false

`rendererHorizontalGridLineColor`

Uint

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

Default: null

`rendererHorizontalGridLines`

Boolean

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

Default: false

`rendererHorizontalGridLineThickness`

Number

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

Default: 1

`rendererPaddingBottom`

Number

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

Default: 2

`rendererPaddingLeft`

Number

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

Default: 1

`rendererPaddingRight`

Number

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

Default: 0

`rendererPaddingTop`

Number

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

Default: 2

`rendererRollOverColors`

Array

[Style(name="rendererRollOverColors", type="uint", format="Color", inherit="yes")] The color of the row background when the user rolls over a level renderer. The default value is [0xFFFFFF,0xFFFFFF]

Default: [0xFFFFFF, 0xFFFFFF]

`rendererVerticalGridLineColor`

Uint

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

Default: 0x666666

`rendererVerticalGridLines`

Boolean

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

Default: true

`rendererVerticalGridLineThickness`

Number

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

Default: 1

`resizable`

Unknown

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

Default: true

`rollOverColor`

Uint

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

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

Default: null

`rowBackgroundColorFunction`

Unknown

`selectable`

Unknown

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

`selectionColor`

Uint

[Style(name="selectionColor", type="uint", format="Color", inherit="yes")] The color of the background of a renderer when the user selects it.

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

Default: null

`selectionColor The default value for the Halo theme is <code>0x7FCEFF</code>. The default value for the Spark theme is <code>0xA8C6EE</code>.`

Uint

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

Default: null

`selectionDisabledColor`

Uint

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

Default: null

`showClearIconWhenHasText`

Unknown

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.

`showIconOnCellHover`

Unknown

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

`showIconOnRowHover`

Unknown

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

`sortable`

Unknown

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

Default: true

`sortArrowSkin`

Class

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

Default: null

`sortCaseInsensitive`

Unknown

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.

`sortCompareFunction`

Unknown

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

`sortNumeric`

Unknown

To sort this column numerically.

`textAlign`

String

[Style(name="textAlign", type="String", enumeration="left,center,right", inherit="yes")] Alignment of text within a container. Possible values are "left", "right", or "center".

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

`textDisabledColor`

Uint

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

Default: 0xDDDDDD

`textRollOverColor`

Uint

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

Default: 0x000000

`textSelectedColor`

Uint

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

Default: 0x000000

`truncateToFit`

Unknown

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

`useCurrentDataProviderForFilterComboBoxValues`

Unknown

Not supported

`useFilterDataProviderForItemEditor`

Unknown

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

`useHandCursor`

Unknown

Uses a special itemrenderer, which causes the mouse to turn into a hand cursor on hover.

`useIconRollOverTimer`

Unknown

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 over icons. set this to false in that case

`useLabelFunctionForFilterCompare`

Unknown

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

`useLabelFunctionForSortCompare`

Unknown

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

`useUnderLine`

Unknown

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

`verticalGridLineColor`

Uint

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

Default: 0x666666

`verticalGridLines`

Boolean

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

Default: true

`verticalGridLineThickness`

Number

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

Default: 1

`wordWrap`

Unknown

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:

Events

`columnResized`

Dispatched when the column width changes for any reason, including programmatic recalculation of column widths Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

`columnXChanged`

Dispatched when the column x changes for any reason, including programmatic recalculation of column x Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

APIs

flexiciousNmsp.FlexDataGridColumn Class

Constructor