If column is a checkbox column, returns the current state of the checkbox renderer

A number of operations can cause the cells text and background colors to change. Resizing, mouse interactions, scrolling, hovering, etc. In order to make sure we're not calling the painting and color calculating routines unnecessarily, all these operations simply mark the background as dirty. The is done by calling the invalidateBackground() method. This method will set the backgroundDirty flag to true and call invalidateDisplayList. In the next validation cycle the cell get's its color calculation code executed and painting code will then use the calculated color values to paint the cell.

If column is a checkbox column, returns the current state of the checkbox renderer

When column.enableIcon=true, this is the icon that will be associated with the cell.

The FlexDataGridColumn associated with this cell. Can be null for cells that do not have a column (e.g. ExpandCollapse Cells). For Cells that span multiple columns, it is still the column that this cell starts on.

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

The component info that holds this cell in the cells collection of the associated rowInfo object. When a row is rendered in the FlexDataGrid, the memory structure used to hold each row is the RowInfo object. If you look at grid.bodyContainer.rows, each item in this collection is an object of type RowInfo. These are the rows in the dataprovider that are currently rendered, which is different than the list of items in the dataprovider. In the cells collection of the rowInfo object, we have a list of ComponentInfo objects. The componentInfo object stores a bunch of additional information and provides a number of handy methods to interact with the cell object. It is basically a wrapper around the IFlexDataGridCell object.

Once a grid is rendered, each cell in the grid is shown in the UI. After being shown, if the user performs operations like filtering, or paging, that result in the cell being taken out of view and no longer being rendered on the UI, instead of removing the cell from memory, we store it in the renderer cache of the grid. Prior to decommissioning the cell, we call the destroy method on the cell. This method will set the destroyed flag to true.

In 2.7, ability was added to have any cell be a expand collapse cell. If you set enableExpandCollapse=true on the column the cells that belong to that column are provided with an iExpandCollapseComponent, which defaults to an instance of

In 2.7, ability was added to have any cell be a expand collapse cell. If you set enableExpandCollapse=true on the column the cells that belong to that column are provided with an iExpandCollapseComponent, which defaults to an instance of

The "Chrome" is defined as header,footer,pager,filter sections. This method returns true if this cell belongs to either of these containers.

Returns true if we are a data cell or if we area a chrome cell at a nest depth of greater than 1. These cells are all drawn in the content area, hence have to scroll. The "Chrome" is defined as header,footer,pager,filter sections. This method returns true if this cell belongs to either of these containers.

Returns true if the rowInfo object associated with this cell is of type RowPositionInfo.ROW_TYPE_DATA.

Returns true if this cell is not right locked or not fixed width.

Calcualted property that returns if this cell is a expand collapse cell.

When a cell is created for the first time, this flag is set to true. After the cell is no longer needed the cell is put back into the renderer cache. If after being put in the renderer cache, the cell gets called back into action and is added to the display list, this flag will be set to false.

The FlexDataGridColumnLevel associated with this cell. This set on initialize. This is usually never null.

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

Used by header cells and column group cells for drag drop move. This property should not be set by your code.

Returns the nestpDepth property of the associated level, if it is not null. If it is null, returns 1. The top level column has nestDepth=1;

The X Position of this cell, as the user sees it. Since the Left, Right and Unlocked containers are measuremment frames in themselves, each cell's X is relative to its container. This method converts the measurement of the x value relative to the corresponding parent container to the measurement of X relative to the grid. This is used mainly by keyboard navigation to figure out which cell is to the right or left of the given cell.

Returns one of the following values on basis of what type of cell this is:

• Blank string for data cells
• header
• footer
• filter
• columnGroup
• pager

The rowInfo object associated with this cell. This cell should be within the cells collection of this rowInfo object.

This is the actual text to display in the cell. This is just a placeholder for the text. Ultimately this value is applied to the renderers text property. This is why, if you specify a custom renderer that exposes a text property, the grid automatically applies the result of the column.itemToLabel method on the associated rowInfo.data object to the text property of the itemRenderer.

This flag is a used for enabling the wordWrap on the associated renderer. Please note, if you define an item renderer, setting wordWrap will only have an impact if you define a renderer that exposes a wordWrap property. When you specify wordWrap on the associated column, the grid will set this flag to true. It will also use a predefined item renderer that has a wordWrap property, unless you specify a custom renderer. If you specify a custom renderer, then this renderer must assume responsibility for exposing a wordWrap property and handling wordWrap appropriately.

Parameters

Draws the background as well as calls drawBorder on the given cell Each cell in Ultimate will draw its own background and border. This method will use the evaluated results of a number of properties on the cell object to calculate the color, width, and visibility of the background associated with this cell.

• First, this method will check to see if you have defined a cellCustomBackgroundDrawFunction for the associated column or level. If so, it will call this method, with the cell as a parameter. You can draw a custom background in this function. If you return false, from this function, this method will not execute any other code, and simply call the drawBorders method
• First, this method will check to see if you have defined a cellCustomBackgroundDrawFunction for the associated column or level. If so, it will call this method, with the cell as a parameter. You can draw a custom background in this function. If you return false, from this function, this method will not execute any other code, and simply call the drawBorders method

Parameters

Parameters

Parameters

The getBackgroundColors method is responsible for evaluating the background color of the cell.

• First, it checks to see if this is a filler row. If so, it will use the alternatingItemColors array and return its 0th or 1st index based upton the rowInfo.rowPositionInfo.rowIndex.
• Next, it checks to see if the cell is disabled. If so, it will return the value of the selectionDisabledColor style property
• Next, it checks to see if there is a custom cellBackgroundColorFunction on the column and if so, it returns the result of this function
• Next, it checks to see if there is a custom rowBackgroundColorFunction on the level and if so, it returns the result of this function
• Next, it checks to see if there rowInfo's data object is in the errors collection of the grid, and if so, it return the value of the errorBackgroundColor property.
• Next, it checks to see if there enableEditRowHighlight is true amd this row is in edit mode, then it returns the value of the editItemColors style property.
• Next, it checks to see if there is a value for the currentBackgroundColors property (based upon rollover) and if so returns that. The currentBackgroundColors property is a result of the grid.highlightRow method.
  • If enableActiveCellHighlight=true uses the value of the activeCellColor style.
  • Else, uses the value of the rollOverColor style property.
• Next, it checks to see if the row is selected (row selection mode) or cell is selected (cell selection mode) and if so, returns selectionColor property.
• Next, it checks to see if a backgroundColor property is specified on the associated column and if so, returns the value of this property.
• Finally, it uses the alternatingItemColors array and return its 0th or 1st index based upton the rowInfo.rowPositionInfo.rowIndex.

If this is a fillRow, returns the value of the color property. Else, returns the value of the "prop" property which is the value of one of the following style properties:

• rollOverColors
• headerRollOverColors
• footerRollOverColors
• filterRollOverColors
• pagerRollOverColors
• columnGroupRollOverColors

If this is a fillRow, returns the value of the color property. Else, returns the value of the "prop" property which is the value of one of the following style properties:

• rollOverColors
• headerRollOverColors
• footerRollOverColors
• filterRollOverColors
• pagerRollOverColors
• columnGroupRollOverColors

Parameters

The getTextColors method is responsible for evaluating the text color of the cell.

• First, it checks to see if the cell is disabled. If so, it will return the value of the textDisabledColor style property
• Next, it checks to see if there is a value for the currentTextColors property (based upon rollover) and if so returns that.
• Next, it checks to see if there is a custom cellTextColorFunction on the column and if so, it returns the result of this function
• Next, it checks to see if there is a custom rowTextColorFunction on the level and if so, it returns the result of this function
• Next, it checks to see if there enableEditRowHighlight is true amd this row is in edit mode, then it returns the value of the editTextColor style property.
• Next, it checks to see if the row is selected (row selection mode) or cell is selected (cell selection mode) and if so, returns textSelectedColor property.
• Next, it checks to see if a columnTextColor property is specified on the associated column and if so, returns the value of this property.
• Finally, it uses the alternatingTextColors array and return its 0th or 1st index based upton the rowInfo.rowPositionInfo.rowIndex.

Parameters

Marks the cell so that the background and borders are drawn in the next validation cycle. Please, note this does not update or re-evaluate the content of the cell, just the border and the background. To updated the content, call the refreshCell method instead.

Parameters

Parameters