Packagecom.flexicious.nestedtreedatagrid.cells
Classpublic class FlexDataGridFooterCell
InheritanceFlexDataGridFooterCell Inheritance FlexDataGridCell Inheritance mx.core.UIComponent

FlexDataGridCell is the container component for each of the DataGrid's cells. This is a psuedo abstract class, the cells that you see in the grid are actually one of the following subclasses of this class: There are two other cells types, FlexDataGridDataCell2 and FlexDataGridDataCell3 (if you set enableDataCellOptimization=true) that do not inherit from this class, but are used in lieu of FlexDataGridDataCell in Flex 4 based grids to improve performance, since they are lighter than FlexDataGridDataCell The FlexDataGridCell is responsible for sizing, positioning (based on padding), drawing the background, and drawing the borders. This class has a renderer property, which is the actual component that is displayed on the UI. In case of the Header,Data or Footer cells the default renderer is a UITextField or UIFTETextField. For Filter, it is an instance of the IFilterControl. For the Pager, it is an IPager control. For the LevelRenderer it is an instance of the Class Factory that you specify in the nextLevelRenderer of the associated column Level. For the ExpandCollapse cells, it will draw an instance of the expand collapse icon on basis of the disclosureIcon style property All the drawing happens in the drawCell method. It seperately calls the drawBackground and drawBorder methods. Usually specifying the style properties, or the cellBackgroud/rowBackground/cellBorder/rowBorder functions is sufficient, but in case its needed, these methods can be overridden in a custom implementation, and this custom implementation can then be hooked in via the dataCellRenderer, headerCellRenderer, footerCellRenderer, pagerCellRenderer, filterCellRender, expandCollapseHeaderCellRenderer,nestIndentPaddingCellRenderer, and expandCollapseCellRenderer of the column or the level. Please note, that this class is recycled, so for example, as you scroll, a FlexDataGridCell object that was displaying some other item in the data provider previously could be reused to display the current one.



Public Properties
 PropertyDefined By
 InheritedbackgroundColorString : String
[read-only] If column is a checkbox column, returns the current state of the checkbox renderer
FlexDataGridCell
 InheritedbackgroundDirty : Boolean
A number of operations can cause the cells text and background colors to change.
FlexDataGridCell
 InheritedcheckBoxState : String
[read-only] If column is a checkbox column, returns the current state of the checkbox renderer
FlexDataGridCell
 InheritedcolIcon : Image
When column.enableIcon=true, this is the icon that will be associated with the cell.
FlexDataGridCell
 Inheritedcolumn : FlexDataGridColumn
The FlexDataGridColumn associated with this cell.
FlexDataGridCell
 InheritedcomponentInfo : ComponentInfo
The component info that holds this cell in the cells collection of the associated rowInfo object.
FlexDataGridCell
 InheritedcurrentBackgroundColors : *
FlexDataGridCell
 InheritedcurrentTextColors : *
FlexDataGridCell
  dataProvider : Object
FlexDataGridFooterCell
 Inheriteddestroyed : Boolean
Once a grid is rendered, each cell in the grid is shown in the UI.
FlexDataGridCell
  drawTopBorder : Boolean
[override] [read-only]
FlexDataGridFooterCell
 InheritedexpandCollapseIcon : ExpandCollapseIcon
In 2.7, ability was added to have any cell be a expand collapse cell.
FlexDataGridCell
 InheritedhorizontalGridLineColor : *
[read-only]
FlexDataGridCell
 InheritedhorizontalGridLineThickness : *
[read-only]
FlexDataGridCell
 InheritediExpandCollapseComponent : IExpandCollapseComponent
[read-only] In 2.7, ability was added to have any cell be a expand collapse cell.
FlexDataGridCell
 InheritedisChromeCell : Boolean
[read-only] The "Chrome" is defined as header,footer,pager,filter sections.
FlexDataGridCell
 InheritedisContentArea : Boolean
[read-only] Returns true if we are a data cell or if we area a chrome cell at a nest depth of greater than 1.
FlexDataGridCell
 InheritedisDataCell : Boolean
[read-only] Returns true if the rowInfo object associated with this cell is of type RowPositionInfo.ROW_TYPE_DATA.
FlexDataGridCell
 InheritedisElastic : Boolean
[read-only] Returns true if this cell is not right locked or not fixed width.
FlexDataGridCell
 InheritedisExpandCollapseCell : Boolean
[read-only] Calcualted property that returns if this cell is a expand collapse cell.
FlexDataGridCell
 InheritedisLeftLocked : Boolean
[read-only]
FlexDataGridCell
 InheritedisLocked : Boolean
[read-only]
FlexDataGridCell
 InheritedisNewlyCreated : Boolean
[read-only] When a cell is created for the first time, this flag is set to true.
FlexDataGridCell
 InheritedisRightLocked : Boolean
[read-only]
FlexDataGridCell
 Inheritedlevel : FlexDataGridColumnLevel
The FlexDataGridColumnLevel associated with this cell.
FlexDataGridCell
 Inheritedmoving : Boolean = false
Used by header cells and column group cells for drag drop move.
FlexDataGridCell
 InheritednestDepth : Number
[read-only] Returns the nestpDepth property of the associated level, if it is not null.
FlexDataGridCell
 InheritedperceivedX : Number
[read-only] The X Position of this cell, as the user sees it.
FlexDataGridCell
 Inheritedrenderer : DisplayObject
[read-only]
FlexDataGridCell
 InheritedrendererFactory : IFactory
FlexDataGridCell
 InheritedrowInfo : RowInfo
The rowInfo object associated with this cell.
FlexDataGridCell
 Inheritedtext : String
This is the actual text to display in the cell.
FlexDataGridCell
 InheritedverticalGridLineColor : *
[read-only]
FlexDataGridCell
 InheritedverticalGridLineThickness : *
[read-only]
FlexDataGridCell
 InheritedwordWrap : Boolean
This flag is a used for enabling the wordWrap on the associated renderer.
FlexDataGridCell
Protected Properties
 PropertyDefined By
  prefix : String
[override] [read-only]
FlexDataGridFooterCell
Public Methods
 MethodDefined By
  
FlexDataGridFooterCell
  
calculateValue(flat:Object):void
FlexDataGridFooterCell
  
defaultLabelFunction(col:FlexDataGridColumn, dataProvider:Object):String
[static]
FlexDataGridFooterCell
 Inherited
destroy():void
FlexDataGridCell
 Inherited
drawBackground(unscaledWidth:Number, unscaledHeight:Number):void
Draws the background as well as calls drawBorder on the given cell Each cell in Ultimate will draw its own background and border.
FlexDataGridCell
 Inherited
drawRightBorder(unscaledWidth:Number, unscaledHeight:Number):void
FlexDataGridCell
  
[override]
FlexDataGridFooterCell
  
[override]
FlexDataGridFooterCell
 Inherited
If this is a fillRow, returns the value of the color property.
FlexDataGridCell
 Inherited
getStyleValue(styleProp:String):*
FlexDataGridCell
  
[override]
FlexDataGridFooterCell
 Inherited
FlexDataGridCell
 Inherited
FlexDataGridCell
  
initializeCheckBoxRenderer(renderer:DisplayObject):void
[override]
FlexDataGridFooterCell
 Inherited
Marks the cell so that the background and borders are drawn in the next validation cycle.
FlexDataGridCell
 Inherited
placeComponent(cellRenderer:DisplayObject, unscaledWidth:Number, unscaledHeight:Number, usePadding:Boolean = true):Point
FlexDataGridCell
  
[override]
FlexDataGridFooterCell
 Inherited
setRendererSize(cellRenderer:DisplayObject, w:Number, h:Number):void
FlexDataGridCell
Protected Methods
 MethodDefined By
 Inherited
FlexDataGridCell
 Inherited
drawCell(unscaledWidth:Number, unscaledHeight:Number):void
FlexDataGridCell
Public Constants
 ConstantDefined By
  AVERAGE : String = average
[static]
FlexDataGridFooterCell
  COUNT : String = count
[static]
FlexDataGridFooterCell
  MAX : String = max
[static]
FlexDataGridFooterCell
  MIN : String = min
[static]
FlexDataGridFooterCell
  SUM : String = sum
[static]
FlexDataGridFooterCell
Property Detail
dataProviderproperty
public var dataProvider:Object

drawTopBorderproperty 
drawTopBorder:Boolean  [read-only] [override]


Implementation
    public function get drawTopBorder():Boolean
prefixproperty 
prefix:String  [read-only] [override]


Implementation
    protected function get prefix():String
Constructor Detail
FlexDataGridFooterCell()Constructor
public function FlexDataGridFooterCell()



Method Detail
calculateValue()method
public function calculateValue(flat:Object):void

Parameters

flat:Object

defaultLabelFunction()method 
public static function defaultLabelFunction(col:FlexDataGridColumn, dataProvider:Object):String

Parameters

col:FlexDataGridColumn
 
dataProvider:Object

Returns
String
getBackgroundColors()method 
override public function getBackgroundColors():*

Returns
*
getRolloverColor()method 
override public function getRolloverColor():*

Returns
*
getTextColors()method 
override public function getTextColors():*

Returns
*
initializeCheckBoxRenderer()method 
override public function initializeCheckBoxRenderer(renderer:DisplayObject):void

Parameters

renderer:DisplayObject

refreshCell()method 
override public function refreshCell():void

Constant Detail
AVERAGEConstant
public static const AVERAGE:String = average

COUNTConstant 
public static const COUNT:String = count

MAXConstant 
public static const MAX:String = max

MINConstant 
public static const MIN:String = min

SUMConstant 
public static const SUM:String = sum