API Docs for:
Show:

flexiciousNmsp.FlexDataGridColumnLevel Class

Extends EventDispatcher

A class that contains information about a nest level of grid. This includes the columns at this level, information about whether or not to enable paging, footers, filters, the row sizes of each, the property of the dataprovider to be used as the key for selection, the property of the data provider to be used as the children field, the renderers for each of the cells, etc.The Grid always contains at least one level. This is the top level, and is accessible via the columnLevel property of the grid.

One of the most important concepts behind the Architecture of Flexicious Ultimate arose from the fundamental requirement that the product was created for - that is display of Heterogeneous Hierarchical Data.

The notion of nested levels is baked in to the grid via the "columnLevel" property. This is a property of type "FlexDataGridColumnLevel". The grid always has at least one column level. This is also referred to as the top level, or the root level. In flat grids (non hierarchical), this is the only level. But in nested grids, you could have any number of nested levels.

The columns collection actually belongs to the columnLevel, and since there is one root level, the columns collection of the grid basically points to the columns collection of this root level. The FlexDataGridColumnLevel class has a "nextLevel" property, which is a pointer to another instance of the same class, or a "nextLevelRenderer" property, which is a reference to a ClassFactory the next level. Please note, currently, if you specify nextLevelRenderer, the nextLevel is ignored. This means, at the same level, you cannot have both a nested sub grid as well as a level renderer. Bottom line - use nextLevelRenderer only at the innermost level. Our examples demonstrate this.

Constructor

flexiciousNmsp.FlexDataGridColumnLevel

()

Item Index

Methods

Properties

Events

Methods

addColumn

()

Adds the column to the collection of columns at this level. Deprecated. Use columns setter instead.
var cols:Array=level.columns;
//manipulate cols
level.columns=cols;

addSelectedItem

()

addSort

()

For multi column sort support.

addUnSelectedItem

()

adjustColumnWidths

()

Once we have the widest width, since we don't want the grid to appear jagged in multi levels Adjust all columns where the widths are same so it looks like a contiguous rectangle.

If the equally parameter is set to true, it will sum up the total column widths, and resize them all equally.

applyColumnWidthFromContent

(
  • col
  • provider
)

Given a column and a dataprovider, measures the width required to render the text in the column, and if such width is greater than the minwidth of the column, applies that width to the column

Parameters:

  • col Object

    The FlexDataGridColumn object

  • provider Object

    The provider used to figure out the text width. You may use the grid.flatten(this.getNestDepth(),false,true,true,true,columnWidthModeFitToContentSampleSize);

areAllSelected

()

For header checkbox state, returns if all items in the grid are selected.

areAnySelected

()

Returns true if there is at least one item in the selected keys collection for this level, or if the next level uses this levels columns, then the selected keys collection for the next level.

areItemsEqual

()

bubbleSelection

()

calculateChromeBottomHeight

()

calculateChromeTopHeight

()

calculateHeaderHeights

()

For columns with headerWordWrap, calculates the height required to display text in full.

cascadeProperty

(
  • prp
  • value
)

Applies the passed in value to the provided property and cascades that value down to the next level, if one exists.

Parameters:

  • prp Object

    The property to apply

  • value Object

    The value to apply

checkRowDisabled

()

Checks disabled flag.

checkRowSelectable

()

IF rowSelectableFunction is specified, returns result of that. If selectableField is specified, returns value of that on the obj object Else returns true

clearColumns

()

Clears out all the columns of the grid If the parameter to rebuild is true, the grid will be rebuilt. Otherwise, just the columns will be cleared, and the consumer code should rebuild the grid.

clearFilter

()

Removes the filter at this level, and all of this child levels, if specified.

clearSelection

()

Clears the selected rows and cells.

clone

()

Creates a new instance of this level, transfers all its primitive and factory properties to the new instance, creates a clone collection of all its columns, transfers the non primitive and factory properties of the columns to the cloned columns and returns the new instance.

Returns:

cloneColumn

()

createAscendingSortIcon

()

createDescendingSortIcon

()

createFilter

()

Returns the filter for this level

createSortArrow

()

dispatchEvent

()

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

distributeColumnWidthsEqually

()

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

ensureRowNumberColumn

()

existsInCursor

()

getAvailableWidth

()

If the grid's horizontal scroll policy is off, then returns the width of the unlocked section minus the width of the scroll bar else returns the sum of all column widths.

getCellCustomBackgroundDrawFunction

()

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.

getCheckBoxStateBasedOnExclusion

()

getChildren

()

If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object. Else returns the value of the level.childrenField property on the object being passed in

getChildrenLength

()

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

getColumnByDataField

()

Returns the column with the specified datafield

getColumnByUniqueIdentifier

()

Returns the column with the specified UniqueIdentifier

getColumnGroupsAtLevel

()

Returns the column groups specified at the level cgLevel.

getColumnOwnerLevel

()

Gets the level that is the ultimate column owner.

getColumns

()

FlexDataGrid.columns

getColumnsByLockMode

()

List of visible columns of the specified lock modes.

getColumnsByWidthMode

()

getDeepNestIndent

()

Gets nestindent recursively

Returns:

getEnableFilters

()

Flag that indicates whether or not to show the filter

getEnableFooters

()

Flag that indicates whether or not to show the footer

getEnableMultiColumnSort

()

Returns true if the nest depth is 1 and grid as the enableMultiColumnSort field enabled.

Returns:

getExportableColumns

()

All visible columns where excludeFromExport=false

getFilterArguments

()

Gets the list of filter arguments at this level.

getFilterHeight

()

Same as filterRowHeight, except no built in logic to handle enableFilters and filterVisible.

Returns:

getFilterRowHeight

()

Height of the filter for this level. Defaults to 25

getFlowColumns

()

Columns where wordWrap=true || variableRowHeightUseRendererForCalculation and itemRenderer not null

Returns:

getFlowHeaderColumns

()

Columns where wordWrap=true || variableRowHeightUseRendererForCalculation and headerRenderer is not null

Returns:

getFooterRowHeight

()

Height of the footer for this level. Defaults to 25

getGroupedColumns

()

Grouped columns - only supported at the top level.

getHasFilterFunction

()

getHeaderHeight

()

Height of the header for this level. Defaults to 25

getIsClientFilterPageSortMode

()

Returns true if filterPageSortMode==client.

getIsClientItemLoadMode

()

Returns true if itemLoadMode==client.

getItemFromKey

()

Provided an item key, loops through the data provider, and finds the item with the provided key.

getItemKey

()

If there is a selected key field (usually a field that uniquely identifies an object) returns the value of the selectedKeyField property of the item else returns the item itself. If saveLevel is set to true, returns a string in the format key|levelNestDepth. Use this in cases where you wish to refresh the grid with new data from the server and open items should only refer to the keys so the open state can be persisted across server roundtrips.

getItemsInSelectionHierarchy

()

getLeftLockedColumns

()

Gets all left locked columns

getLeftLockedWidth

()

Gets the sum of left lock column widths

getLevelRendererHeight

()

getMaxColumnGroupDepth

()

Get the maximum depth of column groups.

getMaxColumnGroupDepthOrHeight

()

Get the maximum depth or height of column groups.

()

getMaxDisclosureCellWidth

()

Gets the max disclosure cell width.

Returns:

getMaxPaddingCellWidth

()

Gets the width of the padding cell.

Returns:

getNestDepth

()

How deep in the nesting hierarchy is this item. Starts at 1 for the columnLevel that belongs to the grid.

Returns:

getNestIndent

()

getNumChildren

()

getOpenKeys

()

A list of ID values, based on the selectedKeyField property. For hierarchical datagrids, used to get all open(expanded) records at all levels. Please NOTE - this is a read only collection. Adding to this does nothing.

If you want to programatically modify the collapse expand, use the setOpenKeys instead, or add directly to the open items.

getPagerHeight

()

Same as pagerRowHeight, except no built in logic to handle enableFilters and filterVisible.

Returns:

getPagerRenderer

()

A Class that implements com.flexicious.controls.interfaces.IPager. Defaults to a built in implementation

Returns:

getPagerRowHeight

()

The height of the pager row. If not set, defaults to the value of the rowHeight property

getParentLevel

()

The parent level for this level. For the root level, this is null.

getPrintableColumns

()

All visible columns where excludeFromPrint=false

getRightLockedColumns

()

Gets all right locked columns

getRightLockedWidth

()

getRowHeight

()

Height of the row for this level. Defaults to 25

getRowHeightFromType

()

Gets the height of the header, footer, pager if visible.

getSelectedCells

()

A list of CellInfo objects. When grid.selectionMode=SINGLE_CELL, this collection contains only one item

getSelectedItem

()

Returns the first item from the selectedObjects collection, if one exists at this level. If there is none, then returns the selectedItem collection of the next level.

getSelectedKeys

()

A list of ID values, based on the selectedKeyField property. When a row is selected in the grid, we store the selectedKeyField property of the selected object in this array collection. This allows for multiple pages of data that comes down from the server and not maintained in memory to still keep track of the ids that were selected on other pages.

getSelectedKeysState

()

If all items are selected, returns TriStateCheckBox.STATE_CHECKED. If none are selected, returns TriStateCheckBox.STATE_UNCHECKED else returns TriStateCheckBox.STATE_MIDDLE

getSelectedObjects

()

This array is a list of all items that are have been selected by the user or programmatically, at this level.

Please note, for hierarchical grids, each level has its own collection of selected keys. The grid.selectedObjects returns the selectedKeys at the top level. To access the selected keys at a lower level, you may navigate to that level using grid.getColumnLevel().nextLevel...nextLevel.selectedKeys You can also call grid.getSelectedObjects to get selected objects at all levels.

getSelectedObjectsDeep

()

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

getShowableColumns

()

All columns that can be "hidden"

getSortableColumns

()

All visible columns where sortable=true

getSortIndex

()

Gets the index at which the given column appears in the sort list.

Returns:

getStyleValue

()

If a value exists for a style property at the level return it, else return the value of the property at the grid level.

getSumOfColumnWidths

()

Gets the sum of all column widths.

getTraceCols

()

getUnLockedColumns

()

Gets all unlocked columns

getUnLockedWidth

()

Gets the sum of left lock column widths

getUnSelectedObjects

()

When grid.enableSelectionExclusion is set to true, a list of items that the user explicitly unselected is stored here.

Returns:

getValue

(
  • val
)

If value is primitive, does a to string, if XMLList, returns the text.

Parameters:

  • val Object

Returns:

getVisibleColumns

()

All columns where visible=true and lock modes match the specified lock modes.

getWidestLeftLockedWidth

()

getWidestRightLockedWidth

()

Returns the widest right locked width.

getWidestWidth

()

At each level, get the sum of column widths, and return the width at the level with the widest width. Only includes locked columns by default.

hasSort

(
  • fld
)

Returns true if the given column is already in the sort

Parameters:

  • fld Object

initializeLevel

(
  • grid
)

Parameters:

  • grid Object

invalidateCache

()

invalidateCalculationsDown

()

invalidateList

()

isCellSelected

()

Returns true if the CellInfo for the specified item and column exists in the selectedCells collection.

isItemEqual

()

Provided an item or a key, and a flag that indicates what it is, returns true if the item matches the respective comparison.

isItemOpen

()

Returns true if the getItemKey for the specified item exists in the selectedKeys collection.

isItemSelected

()

Returns true if the getItemKey for the specified item exists in the selectedKeys collection.

isItemUnSelected

()

Returns true if the getItemKey for the specified item exists in the selectedKeys collection.

kill

()

onSelectedKeysChange

()

pushIntoChain

(
  • chain
)

Parameters:

  • chain Object

removeAllSorts

()

Removes all the sorts and calls doInvalidate.

removeColumn

()

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

removeSelectedItem

()

removeUnSelectedItem

()

selectAll

()

Selects or un selects everything

selectCell

()

Selects or un selects a cell

selectRow

()

Selects or un selects a row

selectRowExclusion

()

setCellCustomBackgroundDrawFunction

()

setColumnLevel

()

setColumns

()

setColumnWidthsUsingWidthMode

()

Goes through the unlocked columns, figures out the widest width needed by each of the columns by going through the data provider, and sets the width accordingly.

If the equally parameter is set to true, all column settings are ignored, and the grid's width is distributed equally across all columns

Below is a description of the logic used:

setCurrentSort

(
  • fld
  • asc
)

Clears out the current sort collection and sets it to the passed in values

Parameters:

  • fld Object
  • asc Object

setDepth

()

setEnableFilters

(
  • value
)

Sets whether or not to show the filter

Parameters:

  • value Object

setEnableFooters

(
  • value
)

Sets whether or not to show the footer

Parameters:

  • value Object

setEnablePaging

()

setFilterHeight

()

setFilterRowHeight

()

setGrid

()

setGroupedColumns

()

Grouped columns - only supported at the top level.

setHeaderHeight

()

setOpenKeys

()

Sets the open keys at this level.

setPagerHeight

()

setPagerRenderer

(
  • value
)

A Class that implements com.flexicious.controls.interfaces.IPager. Defaults to a built in implementation

Parameters:

  • value Object

setPagerRowHeight

()

setParentLevel

()

setRowHeight

()

setSelectedItemsBasedOnSelectedField

()

Iterates through items, checks to see if the selected bit is on, and if so, adds it to the open list.

setSelectedKeys

()

For nested/grouped hierarchical datagrids, used to select records. Iterates through the data provider, matching each object, and if matches, adds the object to the selectedObjects for the level

setSelectedKeysState

(
  • val
)

Sets the selected state at this level. If you specify checked, adds all rows to the selected keys collection.

Parameters:

  • val Object

setSelectedObjects

()

For nested/grouped hierarchical datagrids, used to select records. Iterates through the data provider, matching each object, and if matches, adds the object to the selectedObjects for the level

shiftColumns

()

Inserts the column specified column before the specified column

showColumns

()

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

showPrintableColumns

()

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

storeChain

()

swapColumns

()

transferProps

()

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

additionalFilterArgumentsFunction

Null

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

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.

Default: null

cellBorderFunction

Null

A function that lets you control the border drawing mechanism for each cell. By default, each cell will draw a 1px wide line to its right and bottom ends.

This function offers you the opportunity to hook into this mechanism, and draw your own border using the graphics property of the FlexDataGridCell object, that is passed in as a parameter to this function. If this function returns false, the default border is not drawn.

childrenCountField

String

A property on the object that identifies if the object has children. Only needed in filterPageSortMode=server

In lazy loaded (filterPageSortMode=server) hierarchical grids levels, the child level items are loaded when the user actually expands this level for the first time.

In scenarios where it is known initially that there are children, set this property to the value of the object that identifies whether there are children. If this property is set, the expand collapse icon will be drawn only when the value of this property on the object returns an integer greater than zero. Otherwise, the level will always draw the expand collapse icon.

childrenField

Unknown

The property of the parent level object, that identifies the children that should be displayed on the next level. This is only required if the collection is not a hierarchical view.

Please note, in server mode, this property is also the "storage" for the lazy loaded children.

See the Partially and Lazy Loaded Server Grid examples for more details

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

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: null

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]

columnGroups

Unknown

Childs groups, if any. FlexDataGridColumnGroup

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 [Style(name="columnGroupVerticalGridLines", type="Boolean", inherit="no")]

Boolean

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

Default: true

columnGroupVerticalGridLineThickness

Number

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

Default: 1

columnWidthModeFitToContentSampleSize

Number

The number of records to inspect to identify the max size of the data in the column when columnWidthMode=fitToContent.

When you have very large datasets, it will be very slow if you inspect every row to identify the largest string to come up with the column width. So we inspect only the first columnWidthModeFitToContentSampleSize rows.

Default: 100

currentSorts

Array

A List of FilterSort objects, for multi column sort support.

defaultSelectionField Not Yet Implemented. Support for use case where inner level is single select. For use where inner level is single select and we need to cascade selection from the parent. When parent is chosen, one child needs to be the default selection. This field should point to a property on the model object that returns a true false determining which field to choose by default.

Unknown

disabledColor

Uint

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

Default: 0xAAB3B3

disabledField

String

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

disclosureClosedIcon The default value is <code>TreeDisclosureClosed</code> in the assets.swf file.

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.

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

displayOrder

String

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

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

Defaults to pager,filter,body,footer

editItemColor

Null

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

Default: null

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

enablePaging

Boolean

Flag to indicate whether or not to enable paging functionality

enableSingleSelect Not Yet Implemented. Support for use case where inner level is single select. Sets this levels selection mode to be single select.

Unknown

expandCollapseCellRenderer

Container for the expand collapse cell. Needs to inherit from FlexDataGridExpandCollapseCell. Defaults to FlexDataGridExpandCollapseCell

expandCollapseHeaderCellRenderer

Container for the expand collapse cell. Needs to inherit from FlexDataGridExpandCollapseHeaderCell. Defaults to FlexDataGridExpandCollapseHeaderCell

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

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

filterFunction

Null

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. Works just like ListCollectionView.filterFunction

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

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

filterPageSortMode

String

The Filter/Page/Sort Mode. Can be either "server" or "client". In client mode, the grid will take care of paging, sorting and filtering once the dataprovider is set. In server mode, the grid will fire a com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent named filterPageSortChange that should be used to construct an appropriate query to be sent to the backend.

Default: "client"

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

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

filterVisible

Boolean

If you have enableFilters set to true but want the filter row to not appear, you can set this value.

fontAntiAliasType

String

[Style(name="fontAntiAliasType", type="String", enumeration="normal,advanced", inherit="yes")] Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables advanced anti-aliasing for the font. Set to "normal" to disable the advanced anti-aliasing.

This style has no effect for system fonts.

This style applies to all the text in a TextField sub control; you cannot apply it to some characters and not others.

Default: "advanced"

fontFamily

String

[Style(name="fontFamily", type="String", inherit="yes")] Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font.

The default font for the Halo theme is "Verdana". The default font for the Spark theme is "Arial".

Default: null

fontGridFitType

String

[Style(name="fontGridFitType", type="String", enumeration="none,pixel,subpixel", inherit="yes")] Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

Default: null

fontSharpness

Number

[Style(name="fontSharpness", type="Number", inherit="yes")] Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

Default: 0

fontSize

Number

[Style(name="fontSize", type="Number", format="Length", inherit="yes")] Height of the text, in pixels.

In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed ColorPicker control, the default value is 11.

Default: null

fontStyle

String

[Style(name="fontStyle", type="String", enumeration="normal,italic", inherit="yes")] Determines whether the text is italic font. Recognized values are "normal" and "italic".

Default: "normal"

fontThickness

Number

[Style(name="fontThickness", type="Number", inherit="yes")] Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

Default: 0

fontWeight

String

[Style(name="fontWeight", type="String", enumeration="normal,bold", inherit="yes")] Determines whether the text is boldface. Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.

Default: null

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

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

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

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

footerVisible

Boolean

If you have enableFooters set to true but want the footer row to not appear, you can set this value.

forcePagerRow

Boolean

Use this flag to show the pager control even if the enablePaging is set to false. This is used in a scenario where you wish to show buttons other than the paging buttons in the pager bar.

hasGroupedColumns

Unknown

Flag to set if column groups exist

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

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

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

headerSeperatorWidth

Number

Width to show the resize indicator between columns. Defaults to 4

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

headerVisible

Boolean

Whether or not to show the header row

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

initialSortAscending

Boolean

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

initialSortField

Null

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

itemLoadMode

String

The Item Load Mode. Can be either "server" or "client". In client mode, the grid will assume that the children of items at this level are prefreched.

In server mode, the grid will dispatch a ITEM_LOAD event (itemLoad) that should be used to construct an appropriate query to be sent to the backend, to retrieve the child objects at this level.

Once the results are retrieved, please call the "setChildData" method on the grid to set the results at this level. Please note, the "childrenField" is still required at this level, because that is where the setChildData method persists the loaded children. Future itemOpen events do not result in itemLoads because the data for this particular entity has already been loaded and persisted.

Default: "client"

kerning

Boolean

[Style(name="kerning", type="Boolean", inherit="yes")] A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning.

Default: false

letterSpacing

Number

[Style(name="letterSpacing", type="Number", inherit="yes")] The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it.

Default: 0

levelName

String

levelRendererHeight

Number

Height to assign to the renderer for each level. If not specified, a new instance of the level renderer is created, and the height is defaulted to the height of that one instance. The same height is then reused for subsequent renderers of the same type.

locale

String

[Style(name="locale", type="String", inherit="yes")] The locale of the text displayed by this component.

FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts.

Note: This style only applies when an MX component specifies UIFTETextField as its textFieldClass.

Default: "en"

minHeaderHeight Not Yet Implemented.

Unknown

minimu header height

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"

multiColumnSortNumberWidth

Number

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

Default: 10

nestIndent

Number

The indentation to apply to each progressive nest level.

nestIndentPaddingCellRenderer

Container for the nest indent padding cell. Needs to inherit from FlexDataGridExpandCollapseHeaderCell. Defaults to FlexDataGridExpandCollapseCell

nestIndentPaddingRenderer The inner content of the padding cell. Defaults to a plain old UI component

Unknown

The inner content of the padding cell. Defaults to a plain old UI component

nextLevel

Null

Declaration of the next level of columns

nextLevelRenderer

Null

A renderer that displays this level. If you specify a value for this, the columns are ignored, and instead of drawing a nested data grid at this level, an instance of the levelRenderer is displayed. All paging, footers, headers and other properties related to hierarchical display are also ignored.

A level that has a levelRenderer cannot have subsequent levels. So, this is usually the innermost level.

Please ensure that you explictly specify a levelRendererHeight so the vertical height of the grid can be correctly calculated.

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

pagerCellRenderer

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

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

pagerPosition

Null deprecated

Deprecated: . This does not appply to Ultimate. The horizontal positioning of the contents of the pager. <br/> Please use the displayOrder property to control the vertical positioning <br/> Handled by default if you use the built in pager (com.flexicious.grids.columns.footers.PagerControl) , but if you implement your own com.flexicious.controls.interfaces.IPager, then needs to be handled by you.

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: null

pagerVerticalGridLineColor

Uint

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

Default: 0x666666

pagerVerticalGridLines

Boolean

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

Default: true

pagerVerticalGridLineThickness

Number

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

Default: 1

pagerVisible

Boolean

If you have enablePaging set to true but want the pager row to not appear, you can set this value.

pageSize

Number

The number of records to display per page

parentField

String

A property that points to the parent object Used in conjunction with enableSelectionBubble property on the grid.

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

Uint

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

Default: null

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

Unknown

String

A property on the object that identifies the object uniquely.

Similar to a surrogate key, or a business key, as long as it uniquely identifies the object. When this property is set, the selected keys returns the ID values of the objects that were selected.

When a row is selected in the grid, we store the selectedKeyField property of the selected object in this array collection. This allows for multiple pages of data that comes down from the server and not maintained in memory to still keep track of the ids that were selected on other pages.

String

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

The owner grid.

reusePreviousLevelColumns

Boolean

Setting this flag to true will resuse the columns from the previous level.

Set this flag to true if you want the grid to behave like the advanced datagrid, where there is one set of columns for hierarchical data.

Null

A function that can be used to control the enabled flag of each cell in this level. 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 has two parameters: 1) IFlexDataGridDataCell : Cell object which has a pointer to the row data (data) as well as other related information found in the documentation of the FlexDataGridDataCell class. This parameter can be null, when the function is called as a response to a higher level checkbox select. For example, when the user hits select all. In this case, we do not always have a cell, and it will be passed in as null 2) The actual data object bound to the row. This function should true or false.

For example:

private function rowDisabledFunction(cell:FlexDataGridCell,data:Object):Boolean{ return data.enabledl }

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

rowSelectableFunction

Null

A function that can be used to control whether clicking on any cell in this level will select it. If this function is null or returns false, clicking on the cell will not result in the row being selected. If this function returns true, clicking on the cell will result in the row being selected in row selection modes only. This function has two parameters: 1) IFlexDataGridDataCell : Cell object which has a pointer to the row data (data) as well as other related information found in the documentation of the IFlexDataGridDataCell class. This parameter can be null, when the function is called as a response to a higher level checkbox select. For example, when the user hits select all. In this case, we do not always have a cell, and it will be passed in as null 2) The actual data object bound to the row. This function should true or false.

For example:

private function rowSelectableFunction(cell:FlexDataGridCell,data:Object):Boolean{ return data.enabled; }

rowTextColorFunction

Null deprecated

Deprecated: Use the grid.cellTextColorFunction

A function that can be used to control the text color of each cell in this level. 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. This function should return a single color hex code (uint).

scrollbarPadRenderer The inner content of the scroll bar pad cell. Defaults to a plain old UI component

Unknown

The inner content of the scroll bar pad cell. Defaults to a plain old UI component

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

Unknown

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

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.

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

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

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

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.

Default: null

textDecoration

String

[Style(name="textDecoration", type="String", enumeration="none,underline", inherit="yes")] Determines whether the text is underlined. Possible values are "none" and "underline".

Default: "none"

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

textFieldClass

Class

[Style(name="textFieldClass", type="Class", inherit="no")] The class implementing IUITextField that is used by this component to render text.

It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout).

Default: null

textIndent

Number

[Style(name="textIndent", type="Number", format="Length", inherit="yes")] Offset of first line of text from the left side of the container, in pixels.

Default: 0

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

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

Events

change

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

columnsResized

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

filterPageSortChange

Dispatched when the grid's page, sort or filter state changes. Also Dispatched when an item, that was not previously opened is opened. Used in lazy loaded (filterPageSortMode=server) grids, to load a specific page of data from the backend. Event Type:com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent

headerClicked

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

itemClick

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

itemClose

Dispatched when an item opens, both in server and client mode Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

itemDoubleClick

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

itemEditBegin

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

itemEditBeginning

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

itemEditCancel

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

itemEditEnd

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

itemEditValueCommit

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

itemLoad

Dispatched only in server mode, when an item opens for the first time. Used to wire up an event handler to load the next level of data in lazy loaded grids. Event Type:com.flexicious.nestedtreedatagrid.events.ExtendedFilterPageSortChangeEvent

itemOpen

Dispatched when an item opens, both in server and client mode Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

itemOpening

Dispatched when an item opens, both in server and client mode Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

itemRollOut

Dispatched when user rolls out of a row in row selection mode or cell in cell selection mode Event Type:com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

itemRollOver

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