FlexDataGridCell

Override:

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.

Override:

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

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.

This property stores the temporary value of a cells background color when the user hovers over it. The background colors of each cell are calculated using a series of rules as defined in the documentation for the getBackgroundColors method of the CellUtils class.

This property stores the temporary value of a cells text color when the user hovers over it. The text colors of each cell are calculated using a series of rules as defined in the documentation for the getTextColors method of the CellUtils class.

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

See:

• com.flexicious.nestedtreedatagrid.cells.ExpandCollapseIcon class. This property will return the current instance of this class associated with this cell.

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

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

The rowInfo object associated with this cell. This cell should be within the cells collection of this rowInfo object. Each cell has a corresponding rowinfo object. The rowInfo, in turn has a rowPositionInfo object. The key difference between these two objects is that there are only as many rowInfo objects as there visible rows on the page. RowPositionInfo objects on the other hand, there are as many of these as there are total items in the data provider.

If there is a value for the prefix parameter, capitalizes the first word of the val parameter and returns it

destroy function.

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.

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

Draws the right border for this cell. There are a few rules on basis of which a right (or a left) border is drawn on a cell.

• First, if the cell is a Pager cell, no right border is drawn, since the pager shares its left and right border with the grid.
• Second, if the cell has no vertical gridlines, no border is drawn.
• Else, if the cell has a column and its right locked, then a left border is drawn.

If the cell.backgroundColors is an array, returns a string join using a comma. Else, returns the result of ExtendedUIUtils.getColorName on it.

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

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

Override:

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.

Calculated property that controls whether or not to draw the top border. Each cell in Ultimate will draw its own background and border. In order to prevent cells from drawing double borders (cell above me drew bottom border, so I should not need to draw my top border), this flag evaluates to false. But in certain cases, you may want to draw both top and bottom border. The bottom border is always controlled by the horizontalGridLines style property. The top border is controlled by the drawTopBorder style property. In order to provide fine grained control over border drawing functionality, there are the following style properties available.

• drawTopBorder
• headerDrawTopBorder
• footerDrawTopBorder
• pagerDrawTopBorder
• filterDrawTopBorder
• columnGroupDrawTopBorder

• horizontalGridLines
• headerHorizontalGridLines
• footerHorizontalGridLines
• pagerHorizontalGridLines
• filterHorizontalGridLines
• columnGroupHorizontalGridLines

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

What color to use to draw the horizontal grid lines for this cell. The value is used to draw the bottom border. Similar to the drawTopBorder, this is a calculated property which is derived from the associated rowInfo object's row type. The result is the value of one of the following based on the rowInfo.rowPositionInfo.rowType:

• horizontalGridLineColor
• headerHorizontalGridLineColor
• footerHorizontalGridLineColor
• pagerHorizontalGridLineColor
• filterHorizontalGridLineColor
• columnHorizontalGridLineColor

What thickness to use to draw the horizontal grid lines for this cell. The value is used to draw the bottom border. drawTopBorder Similar to the drawTopBorder, this is a calculated property which is derived from the associated rowInfo object's row type. The result is the value of one of the following based on the rowInfo.rowPositionInfo.rowType:

• horizontalGridLineThickness
• headerHorizontalGridLineThickness
• footerHorizontalGridLineThickness
• pagerHorizontalGridLineThickness
• filterHorizontalGridLineThickness
• columnGroupHorizontalGridLineThickness

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.

Returns true if the column associated with this cell has columnLockMode="left"

Returns true if the column associated with this cell has columnLockMode="left" or columnLockMode="right"

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.

Returns true if the column associated with this cell has columnLockMode="right"

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

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

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 actual renderer component that displays the value of the cell. For all but the FlexDataGridDataCell2 and FlexDataGridDataCell3 there is a separate component that does the rendering. For FlexDataGridDataCell2 and FlexDataGridDataCell3, the cell itself becomes the renderer. This is why both FlexDataGridDataCell2 and FlexDataGridDataCell3 are more performant and optimized than the others. These are also more numerous, since they display data values. The header, filters and footers are relatively smaller in number.

The factory class used for initializing the cell. This is arrived at by calling the deriveRenderer method of the associated column.

See:

• com.flexicious.nestedtreedatagrid.FlexDataGridColumn#deriveRenderer

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:

Returns the value of the textRollOverColor style property.

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.

Override:

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

What color to use to draw the vertical grid lines for this cell. The value is used to draw the right border. drawTopBorder Similar to the drawTopBorder, this is a calculated property which is derived from the associated rowInfo object's row type. The result is the value of one of the following based on the rowInfo.rowPositionInfo.rowType:

• verticalGridLineColor
• headerVerticalGridLineColor
• footerVerticalGridLineColor
• pagerVerticalGridLineColor
• filterVerticalGridLineColor
• columnGroupVerticalGridLineColor

What thickness to use to draw the horizontal grid lines for this cell. The value is used to draw the bottom border. drawTopBorder Similar to the drawTopBorder, this is a calculated property which is derived from the associated rowInfo object's row type. The result is the value of one of the following based on the rowInfo.rowPositionInfo.rowType:

• verticalGridLineThickness
• headerVerticalGridLineThickness
• footerVerticalGridLineThickness
• pagerVerticalGridLineThickness
• filterVerticalGridLineThickness
• columnGroupVerticalGridLineThickness

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.

Converts the given global Point to local co-ordinates.

Override:

Returns true if the style property for horizontalGridLines is defined for the type of the row. Based upon the rowInfo.rowPositionInfo.rowType, one of the following properties are inspected:

• horizontalGridLines
• headerHorizontalGridLines
• footerHorizontalGridLines
• pagerHorizontalGridLines
• filterHorizontalGridLines
• columnGroupHorizontalGridLines

Returns true if the style property for verticalGridLines is defined for the type of the row. Based upon the rowInfo.rowPositionInfo.rowType, one of the following properties are inspected:

This method is responsible for initializing the checkbox renderer for both the header and data cells. It performns the following tasks

• First, it will set the radio button mode of the associated TriStateCheckBox to true if col.radioButtonMode or level.enableSingleSelect is set to true
• Next, if the grid.enableSelectionExclusion flag is set to true, it will set the selected state of the associated TriStateCheckBox to the result of the getCheckBoxStateBasedOnExclusion method of the level
• Next, if the grid.enableSelectionExclusion flag is set to false (default), it will set the selected state of the associated TriStateCheckBox based upon the following logic (if enableTriStateCheckBox=true):
  • If the associated rowData object is in the selected objects collection of the level, sets it to checked
  • If any of the children the associated rowData object are selected, sets it to middle
  • Else sets it to unchecked
• Finally, if the enableLabelAndCheckBox flag is set to true on the column, this method will apply the result of the columns itemToLabel function to the label property of the checkbox

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.

Clean up this cell

Override:

when the icon is enables, handles the mouse click event of the icon.

when the icon is enables, handles the mouse out event of the icon.

when the icon is enables, handles the mouse over event of the icon.

Once the timer completed its time, the final result will be renderered such as showing shooltips or dispatching some events.

This method will size and place the renderer within the bounds of this cell. The renderer of the cell gets a width of cell.width - paddingLeft - paddingRight. It gets a height of cell.height - paddingTop - paddingBottom. It then gets placed at x position of paddingLeft and y position of paddingTop. The padding is only applied if usePadding is set to true (default).

The padding is calculated on basis of what type of cell this is. The following style properties are used to figure out padding:

• paddingLeft
• paddingRight
• paddingTop
• paddingBottom
• headerPaddingLeft
• headerPaddingRight
• headerPaddingTop
• headerPaddingBottom
• footerPaddingLeft
• footerPaddingRight
• footerPaddingTop
• filterPaddingBottom
• filterPaddingLeft
• filterPaddingRight
• filterPaddingTop
• filterPaddingBottom
• columnGroupPaddingBottom
• columnGroupPaddingLeft
• columnGroupPaddingRight
• columnGroupPaddingTop
• columnGroupPaddingBottom

This method is also used by the edit code, to place the editor. When placing the editor, usePadding is set to falst, so the editor occupies the entire cell to prevent the text of the cells from showing.

setting the position of ExpandCollapseIcon.

setting the correct position of the Icon.

Used to refresh the contents of a Cell.

To set the actualsize value using width and height values.

Override:

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

Is this enabled cell

Override:

Override:

The factory class used for initializing the cell. This is arrived at by calling the deriveRenderer method of the associated column.

See:

• com.flexicious.nestedtreedatagrid.FlexDataGridColumn#deriveRenderer

Given a renderer, sets the size on basis of whether or not there are vertical and horizotnal gridlines . If there are vertical gridlines, sets the width to width minus verticalGridLineThickness If there are vertical gridlines, sets the height to width minus horizontalGridLineThickness

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.

Override:

Setting the width.

Override:

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.

Called as a part of render phase.

Override: