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

FlexDataGridColumnLevel

Extends:

react~React.Component → EventDispatcher → FlexDataGridColumnLevel

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 Summary

Public Constructor
public

constructor(grid: *)

Member Summary

Public Members
public

[prp]: *

public

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

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

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

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

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

A function that lets you control the border drawing mechanism for each cell.
public

A property on the object that identifies if the object has children.
public

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

color: uint

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

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

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

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

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

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

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

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

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

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

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

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

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

Childs groups, if any.
public

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

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

Not Yet Implemented.
public

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

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

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

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

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

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

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

Flag to indicate whether or not to enable paging functionality
public

Not Yet Implemented.
public

For inner level grids that have their own headers, when the header row scrolls out of view, there is no easy way to determine columns for each row.
public

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

Container for the expand collapse cell.
public

Container for the expand collapse cell.
public

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

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

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

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

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

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

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

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

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

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

The Filter/Page/Sort Mode.
public

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Use this flag to show the pager control even if the enablePaging is set to false.
public

The owner grid.
public

Flag to set if column groups exist
public

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

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

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

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

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

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

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

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

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

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

Width to show the resize indicator between columns.
public

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

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

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

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

Whether or not to show the header row
public

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

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

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

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

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

The Item Load Mode.
public
public

Height to assign to the renderer for each level.
public

minimu header height Not Yet Implemented.
public

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

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

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

The indentation to apply to each progressive nest level.
public

Container for the nest indent padding cell.
public

nestIndentPaddingRenderer: flexiciousNmsp.ClassFactory

The inner content of the padding cell.
public

nextLevel: flexiciousNmsp.FlexDataGridColumnLevel

Declaration of the next level of columns
public

nextLevelRenderer: flexiciousNmsp.ClassFactory

A renderer that displays this level.
public

openItems: *[]

public

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

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

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

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

The number of records to display per page
public

Container for the footer renderer.
public

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

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

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

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

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

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

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

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

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

@deprecated.
public

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A function that can be used to control the enabled flag of each cell in this level.
public

A function that can be used to control whether clicking on any cell in this level will select it.
public
this member was deprecated. Use the grid.cellTextColorFunction

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

scrollbarPadRenderer: flexiciousNmsp.ClassFactory

The inner content of the scroll bar pad cell.
public

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

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

A property on the object that identifies the object uniquely.
public

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

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

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

The alpha to apply to sticky header row.
public

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

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

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

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

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

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

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

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

Method Summary

Public Methods
public

addColumn(col: flexiciousNmsp.FlexDataGridColumn)

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

addSort(sort: *)

For multi column sort support.
public
public

adjustColumnWidths(widestWidth: number, equally: boolean)

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

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
public

areAllSelected(items: Object, checkLength: Boolean): Boolean

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

areAnySelected(itemsToCheck: object, recursive: boolean): boolean

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

areItemsEqual(itemA: object, itemB: object): boolean

public
public
public
public

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

cascadeProperty(prp: *, value: *)

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

checkRowDisabled(cell: *, item: *): *

Checks disabled flag.
public

checkRowSelectable(cell: *, obj: *): *

IF rowSelectableFunction is specified, returns result of that.
public

clearColumns(rebuild: boolean)

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

clearFilter(recursive: boolean)

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

clearSelection(dispatch: *)

Clears the selected rows and cells.
public

clone(transferCols: *): *

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

cloneColumn(col: *): *

public
public
public

createFilter(parentObject: object, inFilter: flexiciousNmsp.Filter): flexiciousNmsp.Filter

Returns the filter for this level
public

createSortArrow(d: *): *

public

dispatchEvent(event: *): *

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

Modifies the columns so the width is distributed equally.
public
public
public

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

A function that lets you control the background drawing mechanism for each cell.
public

getCheckBoxStateBasedOnExclusion(item: object, useBubble: boolean, checkDisabled: boolean): *

public

getChildren(object: object, filter: boolean, page: boolean, sort: boolean): object

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

getChildrenLength(object: object, filter: boolean, page: boolean, sort: boolean): number

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

getColumnByDataField(fld: String, by: String): flexiciousNmsp.FlexDataGridColumn

Returns the column with the specified datafield
public

getColumnByUniqueIdentifier(fld: String): flexiciousNmsp.FlexDataGridColumnLevel

Returns the column with the specified UniqueIdentifier
public

getColumnGroupsAtLevel(cgLevel: number, groups: Array, result: Array, start: number): Array

Returns the column groups specified at the level cgLevel.
public

getColumnOwnerLevel(): flexiciousNmsp.FlexDataGridColumnLevel

Gets the level that is the ultimate column owner.
public

FlexDataGrid.columns
public

List of visible columns of the specified lock modes.
public
public

Gets nestindent recursively
public

Flag that indicates whether or not to show the filter
public

Flag that indicates whether or not to show the footer
public

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

getExportableColumns(lockModes: *, deep: *, options: *): Array

All visible columns where excludeFromExport=false
public

getFilterArguments(): ArrayCollection

Gets the list of filter arguments at this level.
public

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

Height of the filter for this level.
public

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

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

Height of the footer for this level.
public

Grouped columns - only supported at the top level.
public
public

Height of the header for this level.
public

Returns true if filterPageSortMode==client.
public

Returns true if itemLoadMode==client.
public

getItemFromKey(itemKey: *, flat: object): object

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

getItemKey(item: object, saveLevel: boolean): object

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

getItemsInSelectionHierarchy(parent: object, recurse: boolean, inNestDepth: Number, returnValue: Array, clear: boolean, getUnSelected: boolean): Array

public

Gets all left locked columns
public

Gets the sum of left lock column widths
public
public

Get the maximum depth of column groups.
public

getMaxColumnGroupDepthOrHeight(soFar: *, children: *, what: *): *

Get the maximum depth or height of column groups.
public

Gets the max disclosure cell width.
public

Gets the width of the padding cell.
public

How deep in the nesting hierarchy is this item.
public
public
public

getOpenKeys(keys: Array, provider: object)

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

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

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

The height of the pager row.
public

getParentLevel(): flexiciousNmsp.FlexDataGridColumnLevel

The parent level for this level.
public

getPrintableColumns(lockModes: Array, deep: boolean): Array

All visible columns where excludeFromPrint=false
public

Gets all right locked columns
public
public

Height of the row for this level.
public

getRowHeightFromType(chromeLevel: *): *

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

A list of CellInfo objects.
public

Returns the first item from the selectedObjects collection, if one exists at this level.
public

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

If all items are selected, returns TriStateCheckBox.STATE_CHECKED.
public

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

getSelectedObjectsDeep(soFar: Array, getKey: boolean, unSelected: boolean)

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

getShowableColumns(lockModes: Array, deep: Boolean): Array

All columns that can be "hidden"
public

getSortIndex(fld: *, return1: *, returnSortObject: *): *

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

All visible columns where sortable=true
public

getStyleValue(styleProp: String): *

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

getSumOfColumnWidths(modes: *): *

Gets the sum of all column widths.
public

getTraceCols(): str

public

Gets all unlocked columns
public

Gets the sum of left lock column widths
public

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

getValue(val: *): *

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

getVisibleColumns(lockModes: *): *

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

getWidestLeftLockedWidth(widestLeftLockedWidth: number): number

public

getWidestRightLockedWidth(widestRightLockedWidth: number): number

Returns the widest right locked width.
public

getWidestWidth(widestWidth: number, deep: boolean): number

At each level, get the sum of column widths, and return the width at the level with the widest width.
public

hasSort(fld: *): *

Returns true if the given column is already in the sort
public

initializeLevel(grid: *)

public
public
public
public

isCellSelected(item: object, col: flexiciousNmsp.FlexDataGridColumn): flexiciousNmsp.FlexDataGridCell

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

isItemEqual(itemOrKeyToCompare: object, rowData: object, useItemKeyForCompare: boolean): boolean

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

isItemSelected(item: object, useExclusion: boolean): boolean

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

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

kill()

public
public

pushIntoChain(chain: Array, item: Object)

public

Removes all the sorts and calls doInvalidate.
public

removeColumn(col: flexiciousNmsp.FlexDataGridColumn)

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

selectAll(select: boolean, dispatch: boolean, provider: *, subset: Array, useKeys: boolean, openItems: boolean): *

public

selectCell(cell: flexiciousNmsp.FlexDataGridColumn, selected: boolean)

Selects or un selects a cell
public

selectRow(item: object, selected: boolean, dispatch: boolean, recurse: boolean, bubble: boolean, parent: object)

Selects or un selects a row
public

selectRowExclusion(item: object, selected: boolean)

public
public
public

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

setColumns(value: Array)

public

setCurrentSort(fld: *, asc: *)

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

setDepth(nestLevel: *)

public

setEnableFilters(value: *)

Sets whether or not to show the filter
public

Sets whether or not to show the footer
public

setEnablePaging(val: *)

public

setFilterHeight(value: *)

public
public
public

setGrid(grid: *)

public

Grouped columns - only supported at the top level.
public
public

setOpenKeys(keys: Array, provider: object)

Sets the open keys at this level.
public
public

setPagerRenderer(value: *)

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

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

setSelectedKeys(objects: Array, openItems: boolean)

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

Sets the selected state at this level.
public

setSelectedObjects(objects: Array, openItems: boolean)

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

shiftColumns(columnToInsert: flexiciousNmsp.FlexDataGridColumn, insertBefore: flexiciousNmsp.FlexDataGridColumn, movingCg: boolean)

Inserts the column specified column before the specified column
public

showColumns(colsToShow: Array)

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

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

swapColumns(cg: flexiciousNmsp.FlexDataGridColumnGroup, columnToInsert: flexiciousNmsp.FlexDataGridColumn, insertBefore: flexiciousNmsp.FlexDataGridColumn)

public

transferProps(from: *, to: *, checkForChanges: *)

Inherited Summary

From class EventDispatcher
public

[prop]: *

public
public

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

typeCache: {}

public

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

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

dispatchEvent(event: *): boolean

Dispatches an event into the event flow.
public
public

getStyle(prop: *): *

Gets the value of the prop property on this object
public

Returns true if an event listener exists
public

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

kill()

Removes all event listeners
public

killArray(arr: *)

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

removeEventListener(type: *, listener: *)

Removes a listener from the EventDispatcher object.
public

setStyle(prop: *, val: *)

Sets the value of the prop property on this object

Public Constructors

public constructor(grid: *) source

Override:

EventDispatcher#constructor

Params:

NameTypeAttributeDescription
grid *

Public Members

public [prp]: * source

public activeCellColor: * source

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

Properties:

NameTypeAttributeDescription
activeCellColor *

public additionalFilterArgumentsFunction: Function source

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.

Properties:

NameTypeAttributeDescription
additionalFilterArgumentsFunction *

public alternatingItemColors: * source

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

Properties:

NameTypeAttributeDescription
alternatingItemColors *

public alternatingTextColors: * source

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

Properties:

NameTypeAttributeDescription
alternatingTextColors *

public backgroundColor: Array source

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

Properties:

NameTypeAttributeDescription
backgroundColor *

public cellBorderFunction: Function source

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.

Properties:

NameTypeAttributeDescription
cellBorderFunction *

public childrenCountField: String source

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.

Properties:

NameTypeAttributeDescription
childrenCountField *

See:

public childrenField: String source

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

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

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

Properties:

NameTypeAttributeDescription
childrenField *

See:

public color: uint source

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

Properties:

NameTypeAttributeDescription
color *

public columnGroupClosedIcon: * source

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

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

Properties:

NameTypeAttributeDescription
columnGroupClosedIcon *

public columnGroupColors: * source

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

Properties:

NameTypeAttributeDescription
columnGroupColors *

public columnGroupDrawTopBorder: * source

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

Properties:

NameTypeAttributeDescription
columnGroupDrawTopBorder *

public columnGroupHorizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
columnGroupHorizontalGridLineColor *

public columnGroupHorizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
columnGroupHorizontalGridLineThickness *

public columnGroupHorizontalGridLines: * source

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

Properties:

NameTypeAttributeDescription
columnGroupHorizontalGridLines *

public columnGroupOpenIcon: * source

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

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

Properties:

NameTypeAttributeDescription
columnGroupOpenIcon *

public columnGroupRollOverColors: * source

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

The default value is [0xE6E6E6,0xFFFFFF]

Properties:

NameTypeAttributeDescription
columnGroupRollOverColors *

public columnGroupStyleName: String source

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

Properties:

NameTypeAttributeDescription
columnGroupStyleName *

public columnGroupVerticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
columnGroupVerticalGridLineColor *

public columnGroupVerticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
columnGroupVerticalGridLineThickness *

public columnGroupVerticalGridLines: * source

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

Properties:

NameTypeAttributeDescription
columnGroupVerticalGridLines *

[Style(name="columnGroupVerticalGridLines", type="Boolean", inherit="no")]

public columnGroups: Array source

Childs groups, if any. FlexDataGridColumnGroup

Properties:

NameTypeAttributeDescription
columnGroups *

public columnWidthModeFitToContentSampleSize: Number source

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.

Properties:

NameTypeAttributeDescription
columnWidthModeFitToContentSampleSize *

public currentSorts: Array source

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

Properties:

NameTypeAttributeDescription
currentSorts *

public defaultSelectionField: string source

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.

Properties:

NameTypeAttributeDescription
defaultSelectionField *

public disabledColor: uint source

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

Properties:

NameTypeAttributeDescription
disabledColor *

public disabledField: String source

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

Properties:

NameTypeAttributeDescription
disabledField *

public disclosureClosedIcon: * source

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

Properties:

NameTypeAttributeDescription
disclosureClosedIcon *

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

public disclosureOpenIcon: * source

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

Properties:

NameTypeAttributeDescription
disclosureOpenIcon *

public displayOrder: String source

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

Properties:

NameTypeAttributeDescription
displayOrder *

public editItemColor: * source

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

Properties:

NameTypeAttributeDescription
editItemColor *

public editTextColor: * source

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

Properties:

NameTypeAttributeDescription
editItemColor *

public enablePaging: Boolean source

Flag to indicate whether or not to enable paging functionality

Properties:

NameTypeAttributeDescription
enablePaging *

See:

public enableSingleSelect: boolean source

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

Properties:

NameTypeAttributeDescription
enableSingleSelect *

public enableStickyHeaders: boolean source

For inner level grids that have their own headers, when the header row scrolls out of view, there is no easy way to determine columns for each row. This flag will make the header row "sticky". For the 3.2 release, this is a beta feature.

Properties:

NameTypeAttributeDescription
enableStickyHeaders *

public excludeFromQuickFind: boolean source

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

Properties:

NameTypeAttributeDescription
excludeFromQuickFind *

public expandCollapseCellRenderer: * source

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

Properties:

NameTypeAttributeDescription
expandCollapseCellRenderer *

public expandCollapseHeaderCellRenderer: * source

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

Properties:

NameTypeAttributeDescription
expandCollapseHeaderCellRenderer *

public filterColors: * source

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

Properties:

NameTypeAttributeDescription
filterColors *

public filterDrawTopBorder: * source

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

Properties:

NameTypeAttributeDescription
filterDrawTopBorder *

public filterFunction: Function source

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

Properties:

NameTypeAttributeDescription
filterFunction *

See:

public filterHorizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
filterHorizontalGridLineColor *

public filterHorizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
filterHorizontalGridLineThickness *

public filterHorizontalGridLines: * source

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

Properties:

NameTypeAttributeDescription
filterHorizontalGridLines *

public filterPaddingBottom: * source

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

Properties:

NameTypeAttributeDescription
filterPaddingBottom *

public filterPaddingLeft: * source

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

Properties:

NameTypeAttributeDescription
filterPaddingLeft *

public filterPaddingRight: * source

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

Properties:

NameTypeAttributeDescription
filterPaddingRight *

public filterPaddingTop: * source

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

Properties:

NameTypeAttributeDescription
filterPaddingTop *

public filterPageSortMode: String source

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

Properties:

NameTypeAttributeDescription
filterPageSortMode *

See:

public filterRollOverColors: * source

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

Properties:

NameTypeAttributeDescription
filterRollOverColors *

public filterVerticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
filterVerticalGridLineColor *

public filterVerticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
filterVerticalGridLineThickness *

public filterVerticalGridLines: * source

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

Properties:

NameTypeAttributeDescription
filterVerticalGridLines *

public filterVisible: Boolean source

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

Properties:

NameTypeAttributeDescription
filterVisible *

public footerColors: * source

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

Properties:

NameTypeAttributeDescription
footerColors *

public footerDrawTopBorder: * source

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

Properties:

NameTypeAttributeDescription
footerDrawTopBorder *

public footerHorizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
footerHorizontalGridLineColor *

public footerHorizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
footerHorizontalGridLineThickness *

public footerHorizontalGridLines: * source

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

Properties:

NameTypeAttributeDescription
footerHorizontalGridLines *

public footerPaddingBottom: * source

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

Properties:

NameTypeAttributeDescription
footerPaddingBottom *

public footerPaddingLeft: * source

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

Properties:

NameTypeAttributeDescription
footerPaddingLeft *

public footerPaddingRight: * source

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

Properties:

NameTypeAttributeDescription
footerPaddingRight *

public footerPaddingTop: * source

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

Properties:

NameTypeAttributeDescription
footerPaddingTop *

public footerRollOverColors: * source

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

Properties:

NameTypeAttributeDescription
footerRollOverColors *

public footerStyleName: String source

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

Properties:

NameTypeAttributeDescription
footerStyleName *

public footerVerticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
footerVerticalGridLineColor *

public footerVerticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
footerVerticalGridLineThickness *

public footerVerticalGridLines: * source

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

Properties:

NameTypeAttributeDescription
footerVerticalGridLines *

public footerVisible: Boolean source

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

Properties:

NameTypeAttributeDescription
footerVisible *

public forcePagerRow: Boolean source

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.

Properties:

NameTypeAttributeDescription
forcePagerRow *

public grid: FlexDataGrid source

The owner grid.

Properties:

NameTypeAttributeDescription
grid *

See:

public hasGroupedColumns: boolean source

Flag to set if column groups exist

Properties:

NameTypeAttributeDescription
hasGroupedColumns *

public headerColors: * source

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

Properties:

NameTypeAttributeDescription
headerColors *

public headerDrawTopBorder: * source

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

Properties:

NameTypeAttributeDescription
headerDrawTopBorder *

public headerHorizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
headerHorizontalGridLineColor *

public headerHorizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
headerHorizontalGridLineThickness *

public headerHorizontalGridLines: * source

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

Properties:

NameTypeAttributeDescription
headerHorizontalGridLines *

public headerPaddingBottom: * source

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

Properties:

NameTypeAttributeDescription
headerPaddingBottom *

public headerPaddingLeft: * source

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

Properties:

NameTypeAttributeDescription
headerPaddingLeft *

public headerPaddingRight: * source

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

Properties:

NameTypeAttributeDescription
headerPaddingRight *

public headerPaddingTop: * source

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

Properties:

NameTypeAttributeDescription
headerPaddingTop *

See:

public headerRollOverColors: * source

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

The default value is [0xE6E6E6,0xFFFFFF]

Properties:

NameTypeAttributeDescription
headerRollOverColors *

public headerSeperatorWidth: Number source

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

Properties:

NameTypeAttributeDescription
headerSeperatorWidth *

public headerStyleName: String source

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

Properties:

NameTypeAttributeDescription
headerStyleName *

public headerVerticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
headerVerticalGridLineColor *

public headerVerticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
headerVerticalGridLineThickness *

See:

public headerVerticalGridLines: * source

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

Properties:

NameTypeAttributeDescription
headerVerticalGridLines *

public headerVisible: Boolean source

Whether or not to show the header row

Properties:

NameTypeAttributeDescription
headerVisible *

public horizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
horizontalGridLineColor *

See:

public horizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
horizontalGridLineThickness *

See:

public horizontalGridLines: Boolean source

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

Properties:

NameTypeAttributeDescription
horizontalGridLines *

public initialSortAscending: Boolean source

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

Properties:

NameTypeAttributeDescription
initialSortAscending *

See:

public initialSortField: String source

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

Properties:

NameTypeAttributeDescription
initialSortField *

See:

public itemLoadMode: String source

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.

Properties:

NameTypeAttributeDescription
itemLoadMode *

See:

public levelName: String source

Properties:

NameTypeAttributeDescription
levelName *

public levelRendererHeight: Number source

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.

Properties:

NameTypeAttributeDescription
levelRendererHeight *

See:

public minHeaderHeight: Number source

minimu header height Not Yet Implemented.

Properties:

NameTypeAttributeDescription
minHeaderHeight *

public multiColumnSortNumberHeight: Number source

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

Properties:

NameTypeAttributeDescription
multiColumnSortNumberHeight *

public multiColumnSortNumberStyleName: String source

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

Properties:

NameTypeAttributeDescription
multiColumnSortNumberStyleName *

public multiColumnSortNumberWidth: Number source

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

Properties:

NameTypeAttributeDescription
multiColumnSortNumberWidth *

public nestIndent: Number source

The indentation to apply to each progressive nest level.

Properties:

NameTypeAttributeDescription
nestIndent *

See:

public nestIndentPaddingCellRenderer: * source

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

Properties:

NameTypeAttributeDescription
nestIndentPaddingCellRenderer *

public nestIndentPaddingRenderer: flexiciousNmsp.ClassFactory source

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

Properties:

NameTypeAttributeDescription
nestIndentPaddingRenderer *

public nextLevel: flexiciousNmsp.FlexDataGridColumnLevel source

Declaration of the next level of columns

Properties:

NameTypeAttributeDescription
nextLevel *

See:

public nextLevelRenderer: flexiciousNmsp.ClassFactory source

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.

Properties:

NameTypeAttributeDescription
nextLevelRenderer *

See:

public openItems: *[] source

public paddingBottom: * source

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

Properties:

NameTypeAttributeDescription
paddingBottom *

public paddingLeft: * source

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

Properties:

NameTypeAttributeDescription
paddingLeft *

See:

public paddingRight: * source

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

Properties:

NameTypeAttributeDescription
paddingRight *

See:

public paddingTop: * source

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

Properties:

NameTypeAttributeDescription
paddingTop *

See:

public pageSize: Number source

The number of records to display per page

Properties:

NameTypeAttributeDescription
pageSize *

See:

public pagerCellRenderer: * source

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

Properties:

NameTypeAttributeDescription
pagerCellRenderer *

public pagerColors: * source

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

Properties:

NameTypeAttributeDescription
pagerColors *

public pagerDrawTopBorder: * source

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

Properties:

NameTypeAttributeDescription
pagerDrawTopBorder *

public pagerHorizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
pagerHorizontalGridLineColor *

public pagerHorizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
pagerHorizontalGridLineThickness *

public pagerHorizontalGridLines: * source

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

Properties:

NameTypeAttributeDescription
pagerHorizontalGridLines *

public pagerPaddingBottom: * source

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

Properties:

NameTypeAttributeDescription
pagerPaddingBottom *

public pagerPaddingLeft: * source

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

Properties:

NameTypeAttributeDescription
pagerPaddingLeft *

public pagerPaddingRight: * source

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

Properties:

NameTypeAttributeDescription
pagerPaddingRight *

public pagerPaddingTop: * source

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

Properties:

NameTypeAttributeDescription
pagerPaddingTop *

public pagerPosition: String source

@deprecated. This does not appply to Ultimate.

The horizontal positioning of the contents of the pager.
Please use the displayOrder property to control the vertical positioning
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.

Properties:

NameTypeAttributeDescription
pagerPosition *

See:

public pagerRollOverColors: * source

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

Properties:

NameTypeAttributeDescription
pagerRollOverColors *

public pagerVerticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
pagerVerticalGridLineColor *

public pagerVerticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
pagerVerticalGridLineThickness *

public pagerVerticalGridLines: * source

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

Properties:

NameTypeAttributeDescription
pagerVerticalGridLines *

public pagerVisible: Boolean source

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

Properties:

NameTypeAttributeDescription
pagerVisible *

public parentField: String source

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

Properties:

NameTypeAttributeDescription
parentField *

See:

public rendererColors: * source

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

Properties:

NameTypeAttributeDescription
rendererColors *

public rendererDrawTopBorder: * source

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

Properties:

NameTypeAttributeDescription
rendererDrawTopBorder *

public rendererHorizontalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
rendererHorizontalGridLineColor *

public rendererHorizontalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
rendererHorizontalGridLineThickness *

public rendererHorizontalGridLines: * source

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

Properties:

NameTypeAttributeDescription
rendererHorizontalGridLines *

public rendererPaddingBottom: * source

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

Properties:

NameTypeAttributeDescription
rendererPaddingBottom *

public rendererPaddingLeft: * source

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

Properties:

NameTypeAttributeDescription
rendererPaddingLeft *

public rendererPaddingRight: * source

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

Properties:

NameTypeAttributeDescription
rendererPaddingRight *

public rendererPaddingTop: * source

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

Properties:

NameTypeAttributeDescription
rendererPaddingTop *

public rendererRollOverColors: * source

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

Properties:

NameTypeAttributeDescription
rendererRollOverColors *

public rendererVerticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
rendererVerticalGridLineColor *

public rendererVerticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
rendererVerticalGridLineThickness *

public rendererVerticalGridLines: * source

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

Properties:

NameTypeAttributeDescription
rendererVerticalGridLines *

public reusePreviousLevelColumns: Boolean source

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.

Properties:

NameTypeAttributeDescription
reusePreviousLevelColumns *

See:

public rollOverColor: * source

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

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

Properties:

NameTypeAttributeDescription
rollOverColor *

public rowDisabledFunction: Function source

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 }

Properties:

NameTypeAttributeDescription
rowDisabledFunction *

See:

public rowSelectableFunction: null source

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

For example:

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

Properties:

NameTypeAttributeDescription
rowSelectableFunction *

See:

public rowTextColorFunction: Function source

this member was 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).

Properties:

NameTypeAttributeDescription
rowTextColorFunction *

See:

public scrollbarPadRenderer: flexiciousNmsp.ClassFactory source

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

Properties:

NameTypeAttributeDescription
scrollbarPadRenderer *

public selectableField: String source

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

Properties:

NameTypeAttributeDescription
selectableField *

See:

public selectedField: String source

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

Properties:

NameTypeAttributeDescription
selectedField *

public selectedKeyField: String source

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.

Properties:

NameTypeAttributeDescription
selectedKeyField *

See:

public selectionColor: * source

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

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

Properties:

NameTypeAttributeDescription
selectionColor *

public selectionDisabledColor: * source

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

Properties:

NameTypeAttributeDescription
selectionDisabledColor *

public sortArrowSkin: * source

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

Properties:

NameTypeAttributeDescription
sortArrowSkin *

public stickyHeadersAlpha: number source

The alpha to apply to sticky header row. See enableStickyHeaders.

Properties:

NameTypeAttributeDescription
stickyHeadersAlpha *

public textAlign: String source

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

Properties:

NameTypeAttributeDescription
textAlign *

public textDecoration: String source

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

Properties:

NameTypeAttributeDescription
textDecoration *

public textDisabledColor: * source

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

Properties:

NameTypeAttributeDescription
textDisabledColor *

public textRollOverColor: * source

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

Properties:

NameTypeAttributeDescription
textRollOverColor *

public textSelectedColor: * source

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

Properties:

NameTypeAttributeDescription
textSelectedColor *

public verticalGridLineColor: * source

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

Properties:

NameTypeAttributeDescription
verticalGridLineColor *

public verticalGridLineThickness: * source

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

Properties:

NameTypeAttributeDescription
verticalGridLineThickness *

public verticalGridLines: Boolean source

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

Properties:

NameTypeAttributeDescription
verticalGridLines *

Public Methods

public addColumn(col: flexiciousNmsp.FlexDataGridColumn) source

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;

Params:

NameTypeAttributeDescription
col flexiciousNmsp.FlexDataGridColumn

public addSelectedItem(item: Object) source

Params:

NameTypeAttributeDescription
item Object

public addSort(sort: *) source

For multi column sort support.

Params:

NameTypeAttributeDescription
sort *

public addUnSelectedItem(item: object) source

Params:

NameTypeAttributeDescription
item object

public adjustColumnWidths(widestWidth: number, equally: boolean) source

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.

Params:

NameTypeAttributeDescription
widestWidth number
equally boolean

public applyColumnWidthFromContent(col: *, provider: *) source

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

Params:

NameTypeAttributeDescription
col *

The FlexDataGridColumn object
provider *

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

public areAllSelected(items: Object, checkLength: Boolean): Boolean source

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

Params:

NameTypeAttributeDescription
items Object
checkLength Boolean

Return:

Boolean

public areAnySelected(itemsToCheck: object, recursive: boolean): boolean source

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.

Params:

NameTypeAttributeDescription
itemsToCheck object
recursive boolean

Return:

boolean

public areItemsEqual(itemA: object, itemB: object): boolean source

Params:

NameTypeAttributeDescription
itemA object
itemB object

Return:

boolean

public bubbleSelection(item: Object) source

Params:

NameTypeAttributeDescription
item Object

public calculateChromeBottomHeight(): * source

Return:

*

public calculateChromeTopHeight(): * source

Return:

*

public calculateHeaderHeights() source

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

public cascadeProperty(prp: *, value: *) source

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

Params:

NameTypeAttributeDescription
prp *

The property to apply
value *

The value to apply

public checkRowDisabled(cell: *, item: *): * source

Checks disabled flag.

Params:

NameTypeAttributeDescription
cell *
item *

Return:

*

public checkRowSelectable(cell: *, obj: *): * source

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

Params:

NameTypeAttributeDescription
cell *
obj *

Return:

*

public clearColumns(rebuild: boolean) source

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

Params:

NameTypeAttributeDescription
rebuild boolean

public clearFilter(recursive: boolean) source

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

Params:

NameTypeAttributeDescription
recursive boolean

public clearSelection(dispatch: *) source

Clears the selected rows and cells.

Params:

NameTypeAttributeDescription
dispatch *

public clone(transferCols: *): * source

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.

Params:

NameTypeAttributeDescription
transferCols *

Return:

*

public cloneColumn(col: *): * source

Params:

NameTypeAttributeDescription
col *

Return:

*

public createAscendingSortIcon(): * source

Return:

*

public createDescendingSortIcon(): * source

Return:

*

public createFilter(parentObject: object, inFilter: flexiciousNmsp.Filter): flexiciousNmsp.Filter source

Returns the filter for this level

Params:

NameTypeAttributeDescription
parentObject object
inFilter flexiciousNmsp.Filter

Return:

flexiciousNmsp.Filter

public createSortArrow(d: *): * source

Params:

NameTypeAttributeDescription
d *

Return:

*

public dispatchEvent(event: *): * source

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

Override:

EventDispatcher#dispatchEvent

Params:

NameTypeAttributeDescription
event *

Return:

*

public distributeColumnWidthsEqually() source

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

public ensureRowNumberColumn() source

public existsInCursor(item: Object): * source

Params:

NameTypeAttributeDescription
item Object

Return:

*

public getAvailableWidth(): number source

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.

Return:

number

availableWidth

public getCellCustomBackgroundDrawFunction(): Function source

A function that lets you control the background drawing mechanism for each cell. By default, each cell will draw a background on basis of the XXXXColors style property and XXXXRollOverColors style property, where XXXX= header,filter,pager,footer,renderer or blank.

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

Return:

Function

public getCheckBoxStateBasedOnExclusion(item: object, useBubble: boolean, checkDisabled: boolean): * source

Params:

NameTypeAttributeDescription
item object
useBubble boolean
checkDisabled boolean

Return:

*

public getChildren(object: object, filter: boolean, page: boolean, sort: boolean): object source

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

Params:

NameTypeAttributeDescription
object object
filter boolean
page boolean
sort boolean

Return:

object

public getChildrenLength(object: object, filter: boolean, page: boolean, sort: boolean): number source

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

Params:

NameTypeAttributeDescription
object object
filter boolean
page boolean
sort boolean

Return:

number

public getClassNames(): string[] source

Override:

EventDispatcher#getClassNames

Return:

string[]

public getColumnByDataField(fld: String, by: String): flexiciousNmsp.FlexDataGridColumn source

Returns the column with the specified datafield

Params:

NameTypeAttributeDescription
fld String
by String

Return:

flexiciousNmsp.FlexDataGridColumn

public getColumnByUniqueIdentifier(fld: String): flexiciousNmsp.FlexDataGridColumnLevel source

Returns the column with the specified UniqueIdentifier

Params:

NameTypeAttributeDescription
fld String

Return:

flexiciousNmsp.FlexDataGridColumnLevel

public getColumnGroupsAtLevel(cgLevel: number, groups: Array, result: Array, start: number): Array source

Returns the column groups specified at the level cgLevel.

Params:

NameTypeAttributeDescription
cgLevel number
groups Array
result Array
start number

Return:

Array

public getColumnOwnerLevel(): flexiciousNmsp.FlexDataGridColumnLevel source

Gets the level that is the ultimate column owner.

Return:

flexiciousNmsp.FlexDataGridColumnLevel

public getColumns(): Array source

FlexDataGrid.columns

Return:

Array

public getColumnsByLockMode(types: Array): Array source

List of visible columns of the specified lock modes.

Params:

NameTypeAttributeDescription
types Array

Return:

Array

public getColumnsByWidthMode(modes: Array): Array source

Params:

NameTypeAttributeDescription
modes Array

Return:

Array

public getDeepNestIndent(): number source

Gets nestindent recursively

Return:

number

public getEnableFilters(): boolean source

Flag that indicates whether or not to show the filter

Return:

boolean

public getEnableFooters(): boolean source

Flag that indicates whether or not to show the footer

Return:

boolean

public getEnableMultiColumnSort(): boolean source

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

Return:

boolean

public getExportableColumns(lockModes: *, deep: *, options: *): Array source

All visible columns where excludeFromExport=false

Params:

NameTypeAttributeDescription
lockModes *
deep *
options *

Return:

Array

public getFilterArguments(): ArrayCollection source

Gets the list of filter arguments at this level.

Return:

ArrayCollection

public getFilterHeight(): number source

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

Return:

number

public getFilterRowHeight(): number source

Height of the filter for this level. Defaults to 25

Return:

number

public getFlowColumns(): Array source

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

Return:

Array

public getFlowHeaderColumns(): Array source

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

Return:

Array

public getFooterRowHeight(): number source

Height of the footer for this level. Defaults to 25

Return:

number

row height

public getGroupedColumns(): Array source

Grouped columns - only supported at the top level.

Return:

Array

public getHasFilterFunction(): boolean source

Return:

boolean

public getHeaderHeight(): number source

Height of the header for this level. Defaults to 25

Return:

number

public getIsClientFilterPageSortMode(): boolean source

Returns true if filterPageSortMode==client.

Return:

boolean

public getIsClientItemLoadMode(): boolean source

Returns true if itemLoadMode==client.

Return:

boolean

public getItemFromKey(itemKey: *, flat: object): object source

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

Params:

NameTypeAttributeDescription
itemKey *
flat object

Return:

object

public getItemKey(item: object, saveLevel: boolean): object source

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.

Params:

NameTypeAttributeDescription
item object
saveLevel boolean

Return:

object

public getItemsInSelectionHierarchy(parent: object, recurse: boolean, inNestDepth: Number, returnValue: Array, clear: boolean, getUnSelected: boolean): Array source

Params:

NameTypeAttributeDescription
parent object
recurse boolean
inNestDepth Number
returnValue Array
clear boolean
getUnSelected boolean

Return:

Array

public getLeftLockedColumns(): Array source

Gets all left locked columns

Return:

Array

public getLeftLockedWidth(): number source

Gets the sum of left lock column widths

Return:

number

public getLevelRendererHeight(val: *): boolean source

Params:

NameTypeAttributeDescription
val *

Return:

boolean

public getMaxColumnGroupDepth(): * source

Get the maximum depth of column groups.

Return:

*

public getMaxColumnGroupDepthOrHeight(soFar: *, children: *, what: *): * source

Get the maximum depth or height of column groups.

Params:

NameTypeAttributeDescription
soFar *
children *
what *

Return:

*

public getMaxDisclosureCellWidth(): number source

Gets the max disclosure cell width.

Return:

number

public getMaxPaddingCellWidth(): number source

Gets the width of the padding cell.

Return:

number

public getNestDepth(): * source

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

Return:

*

public getNestIndent(): number source

Return:

number

public getNumChildren(item: object): number source

Params:

NameTypeAttributeDescription
item object

Return:

number

public getOpenKeys(keys: Array, provider: object) source

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

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

Params:

NameTypeAttributeDescription
keys Array
provider object

public getPagerHeight(): number source

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

Return:

number

public getPagerRenderer(): * source

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

Return:

*

See:

public getPagerRowHeight(): number source

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

Return:

number

public getParentLevel(): flexiciousNmsp.FlexDataGridColumnLevel source

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

Return:

flexiciousNmsp.FlexDataGridColumnLevel

public getPrintableColumns(lockModes: Array, deep: boolean): Array source

All visible columns where excludeFromPrint=false

Params:

NameTypeAttributeDescription
lockModes Array
deep boolean

Return:

Array

public getRightLockedColumns(): Array source

Gets all right locked columns

Return:

Array

public getRightLockedWidth(): number source

Return:

number

column Widths

public getRowHeight(): number source

Height of the row for this level. Defaults to 25

Return:

number

public getRowHeightFromType(chromeLevel: *): * source

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

Params:

NameTypeAttributeDescription
chromeLevel *

Return:

*

public getSelectedCells(): Array source

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

Return:

Array

public getSelectedItem(): Object source

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.

Return:

Object

public getSelectedKeys(): Array source

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.

Return:

Array

public getSelectedKeysState(allItems: object): String source

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

Params:

NameTypeAttributeDescription
allItems object

Return:

String

public getSelectedObjects(): Array source

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.

Return:

Array

public getSelectedObjectsDeep(soFar: Array, getKey: boolean, unSelected: boolean) source

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

Params:

NameTypeAttributeDescription
soFar Array
getKey boolean
unSelected boolean

public getShowableColumns(lockModes: Array, deep: Boolean): Array source

All columns that can be "hidden"

Params:

NameTypeAttributeDescription
lockModes Array
deep Boolean

Return:

Array

public getSortIndex(fld: *, return1: *, returnSortObject: *): * source

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

Params:

NameTypeAttributeDescription
fld *
return1 *
returnSortObject *

Return:

*

public getSortableColumns(): Array source

All visible columns where sortable=true

Return:

Array

columns

public getStyleValue(styleProp: String): * source

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

Params:

NameTypeAttributeDescription
styleProp String

Return:

*

public getSumOfColumnWidths(modes: *): * source

Gets the sum of all column widths.

Params:

NameTypeAttributeDescription
modes *

Return:

*

public getTraceCols(): str source

Return:

str

public getUnLockedColumns(): Array source

Gets all unlocked columns

Return:

Array

public getUnLockedWidth(): number source

Gets the sum of left lock column widths

Return:

number

public getUnSelectedObjects(): Array source

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

Return:

Array

public getValue(val: *): * source

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

Params:

NameTypeAttributeDescription
val *

Return:

*

public getVisibleColumns(lockModes: *): * source

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

Params:

NameTypeAttributeDescription
lockModes *

Return:

*

public getWidestLeftLockedWidth(widestLeftLockedWidth: number): number source

Params:

NameTypeAttributeDescription
widestLeftLockedWidth number

Return:

number

public getWidestRightLockedWidth(widestRightLockedWidth: number): number source

Returns the widest right locked width.

Params:

NameTypeAttributeDescription
widestRightLockedWidth number

Return:

number

public getWidestWidth(widestWidth: number, deep: boolean): number source

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.

Params:

NameTypeAttributeDescription
widestWidth number
deep boolean

Return:

number

public hasSort(fld: *): * source

Returns true if the given column is already in the sort

Params:

NameTypeAttributeDescription
fld *

Return:

*

public initializeLevel(grid: *) source

Params:

NameTypeAttributeDescription
grid *

public invalidateCache() source

public invalidateCalculationsDown() source

public invalidateList() source

public isCellSelected(item: object, col: flexiciousNmsp.FlexDataGridColumn): flexiciousNmsp.FlexDataGridCell source

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

Params:

NameTypeAttributeDescription
item object
col flexiciousNmsp.FlexDataGridColumn

Return:

flexiciousNmsp.FlexDataGridCell

public isItemEqual(itemOrKeyToCompare: object, rowData: object, useItemKeyForCompare: boolean): boolean source

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

Params:

NameTypeAttributeDescription
itemOrKeyToCompare object
rowData object
useItemKeyForCompare boolean

Return:

boolean

public isItemSelected(item: object, useExclusion: boolean): boolean source

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

Params:

NameTypeAttributeDescription
item object
useExclusion boolean

Return:

boolean

public isItemUnSelected(item: number): boolean source

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

Params:

NameTypeAttributeDescription
item number

Return:

boolean

public kill() source

Removes all event listeners

Override:

EventDispatcher#kill

public onSelectedKeysChange() source

public pushIntoChain(chain: Array, item: Object) source

Params:

NameTypeAttributeDescription
chain Array
item Object

public removeAllSorts() source

Removes all the sorts and calls doInvalidate.

public removeColumn(col: flexiciousNmsp.FlexDataGridColumn) source

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

Params:

NameTypeAttributeDescription
col flexiciousNmsp.FlexDataGridColumn

public removeSelectedItem(item: object) source

Params:

NameTypeAttributeDescription
item object

public removeUnSelectedItem(item: object) source

Params:

NameTypeAttributeDescription
item object

public selectAll(select: boolean, dispatch: boolean, provider: *, subset: Array, useKeys: boolean, openItems: boolean): * source

Params:

NameTypeAttributeDescription
select boolean
dispatch boolean
provider *
subset Array
useKeys boolean
openItems boolean

Return:

*

public selectCell(cell: flexiciousNmsp.FlexDataGridColumn, selected: boolean) source

Selects or un selects a cell

Params:

NameTypeAttributeDescription
cell flexiciousNmsp.FlexDataGridColumn
selected boolean

public selectRow(item: object, selected: boolean, dispatch: boolean, recurse: boolean, bubble: boolean, parent: object) source

Selects or un selects a row

Params:

NameTypeAttributeDescription
item object
selected boolean
dispatch boolean
recurse boolean
bubble boolean
parent object

public selectRowExclusion(item: object, selected: boolean) source

Params:

NameTypeAttributeDescription
item object
selected boolean

public setCellCustomBackgroundDrawFunction(value: Function) source

Params:

NameTypeAttributeDescription
value Function

public setColumnLevel() source

public setColumnWidthsUsingWidthMode(equally: boolean) source

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:

Params:

NameTypeAttributeDescription
equally boolean

public setColumns(value: Array) source

Params:

NameTypeAttributeDescription
value Array

public setCurrentSort(fld: *, asc: *) source

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

Params:

NameTypeAttributeDescription
fld *
asc *

public setDepth(nestLevel: *) source

Params:

NameTypeAttributeDescription
nestLevel *

public setEnableFilters(value: *) source

Sets whether or not to show the filter

Params:

NameTypeAttributeDescription
value *

public setEnableFooters(value: boolean) source

Sets whether or not to show the footer

Params:

NameTypeAttributeDescription
value boolean

public setEnablePaging(val: *) source

Params:

NameTypeAttributeDescription
val *

public setFilterHeight(value: *) source

Params:

NameTypeAttributeDescription
value *

public setFilterRowHeight(val: number) source

Params:

NameTypeAttributeDescription
val number

public setFooterRowHeight(val: number) source

Params:

NameTypeAttributeDescription
val number

public setGrid(grid: *) source

Params:

NameTypeAttributeDescription
grid *

public setGroupedColumns(value: Array) source

Grouped columns - only supported at the top level.

Params:

NameTypeAttributeDescription
value Array

public setHeaderHeight(o: number) source

Params:

NameTypeAttributeDescription
o number

public setOpenKeys(keys: Array, provider: object) source

Sets the open keys at this level.

Params:

NameTypeAttributeDescription
keys Array
provider object

public setPagerHeight(value: number) source

Params:

NameTypeAttributeDescription
value number

public setPagerRenderer(value: *) source

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

Params:

NameTypeAttributeDescription
value *

See:

public setPagerRowHeight(val: number) source

Params:

NameTypeAttributeDescription
val number

public setParentLevel() source

public setRowHeight(o: *): boolean source

Params:

NameTypeAttributeDescription
o *

Return:

boolean

o

public setSelectedItemsBasedOnSelectedField(items: Array, parent: object, openItems: Array): boolean source

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

Params:

NameTypeAttributeDescription
items Array
parent object
openItems Array

Return:

boolean

public setSelectedKeys(objects: Array, openItems: boolean) source

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

Params:

NameTypeAttributeDescription
objects Array
openItems boolean

public setSelectedKeysState(val: *) source

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

Params:

NameTypeAttributeDescription
val *

public setSelectedObjects(objects: Array, openItems: boolean) source

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

Params:

NameTypeAttributeDescription
objects Array
openItems boolean

public shiftColumns(columnToInsert: flexiciousNmsp.FlexDataGridColumn, insertBefore: flexiciousNmsp.FlexDataGridColumn, movingCg: boolean) source

Inserts the column specified column before the specified column

Params:

NameTypeAttributeDescription
columnToInsert flexiciousNmsp.FlexDataGridColumn
insertBefore flexiciousNmsp.FlexDataGridColumn
movingCg boolean

public showColumns(colsToShow: Array) source

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

Params:

NameTypeAttributeDescription
colsToShow Array

public showPrintableColumns() source

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

public storeChain(item: Object) source

Params:

NameTypeAttributeDescription
item Object

public swapColumns(cg: flexiciousNmsp.FlexDataGridColumnGroup, columnToInsert: flexiciousNmsp.FlexDataGridColumn, insertBefore: flexiciousNmsp.FlexDataGridColumn) source

Params:

NameTypeAttributeDescription
cg flexiciousNmsp.FlexDataGridColumnGroup
columnToInsert flexiciousNmsp.FlexDataGridColumn
insertBefore flexiciousNmsp.FlexDataGridColumn

public transferProps(from: *, to: *, checkForChanges: *) source

Params:

NameTypeAttributeDescription
from *
to *
checkForChanges *