Packagecom.flexicious.nestedtreedatagrid.valueobjects
Classpublic class RowInfo
InheritanceRowInfo Inheritance flash.events.EventDispatcher
Implements IFilterControlContainer



Public Properties
 PropertyDefined By
  cells : Array
RowInfo
  data : Object
[read-only]
RowInfo
  dataGrid : IExtendedDataGrid
RowInfo
  hasDisclosure : Boolean
RowInfo
  hasNestPad : Boolean
RowInfo
  hasRightLockPad : Boolean
RowInfo
  hasScrollbarPad : Boolean
RowInfo
  height : int
RowInfo
  isChromeRow : Boolean
[read-only] Returns true for Header, footer, Pager and renderer rows.
RowInfo
  isColumnBased : Boolean
[read-only] Returns true for Header, Data and Footer rows,where cells map directly to columns
RowInfo
  isColumnGroupRow : Boolean
[read-only]
RowInfo
  isDataRow : Boolean
[read-only]
RowInfo
  isFillRow : Boolean
[read-only]
RowInfo
  isFilterRow : Boolean
[read-only]
RowInfo
  isFooterRow : Boolean
[read-only]
RowInfo
  isHeaderRow : Boolean
[read-only]
RowInfo
  isPagerRow : Boolean
[read-only]
RowInfo
  isRendererRow : Boolean
[read-only]
RowInfo
  name : String
[read-only]
RowInfo
  rowPositionInfo : RowPositionInfo
RowInfo
  y : int
RowInfo
Protected Properties
 PropertyDefined By
  _filterContainerInterface : FilterContainerImpl
RowInfo
Public Methods
 MethodDefined By
  
RowInfo(height:int, y:Number, grid:IExtendedDataGrid)
RowInfo
  
Gets the component info object for the specified column
RowInfo
  
Gets the component info object for the specified column
RowInfo
  
RowInfo
  
Gets the first IExpandCollapseComponent
RowInfo
  
getFilterArguments():ArrayCollection
Loops through all registered IFilterControls, and creates a filter
RowInfo
  
getFilterControls():ArrayCollection
Returns all the filter controls
RowInfo
  
getFilterValue(column:String):Object
Used to set the initial value of the filter.
RowInfo
  
RowInfo
  
getNextFocusableFilter(myIndex:int, forward:Boolean, inclusive:Boolean = false):IFocusManagerComponent
Gets the next focusable filter control starting at myIndex, proceeding in forward or backward direction based on the forward parameter
RowInfo
  
hasField(column:String):Boolean
Returns true if the container has a filter control that is bound to the specified column.
RowInfo
  
RowInfo
  
RowInfo
  
Registers the IFilter control in our list.
RowInfo
  
RowInfo
  
setFilterFocus(fld:String):Boolean
RowInfo
  
setFilterValue(column:String, value:Object):void
Used to set the initial value of the filter.
RowInfo
  
setFocusOnNextFocusableControl(myIndex:int, forward:Boolean, inclusive:Boolean = false):Boolean
Sets the focus on the next focusable filter control starting at myIndex, proceeding in forward or backward direction based on the forward parameter
RowInfo
  
setRowPositionInfo(rowPos:RowPositionInfo, setHt:Boolean = false):void
Reuse an existing row.
RowInfo
  
showHide(showHide:Boolean):void
RowInfo
  
Registers the IFilter control in our list.
RowInfo
Property Detail
_filterContainerInterfaceproperty
protected var _filterContainerInterface:FilterContainerImpl

cellsproperty 
cells:Array

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


Implementation
    public function get cells():Array
    public function set cells(value:Array):void
dataproperty 
data:Object  [read-only]


Implementation
    public function get data():Object
dataGridproperty 
dataGrid:IExtendedDataGrid

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


Implementation
    public function get dataGrid():IExtendedDataGrid
    public function set dataGrid(value:IExtendedDataGrid):void
hasDisclosureproperty 
hasDisclosure:Boolean

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


Implementation
    public function get hasDisclosure():Boolean
    public function set hasDisclosure(value:Boolean):void
hasNestPadproperty 
hasNestPad:Boolean

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


Implementation
    public function get hasNestPad():Boolean
    public function set hasNestPad(value:Boolean):void
hasRightLockPadproperty 
hasRightLockPad:Boolean

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


Implementation
    public function get hasRightLockPad():Boolean
    public function set hasRightLockPad(value:Boolean):void
hasScrollbarPadproperty 
hasScrollbarPad:Boolean

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


Implementation
    public function get hasScrollbarPad():Boolean
    public function set hasScrollbarPad(value:Boolean):void
heightproperty 
height:int

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


Implementation
    public function get height():int
    public function set height(value:int):void
isChromeRowproperty 
isChromeRow:Boolean  [read-only]

Returns true for Header, footer, Pager and renderer rows.


Implementation
    public function get isChromeRow():Boolean
isColumnBasedproperty 
isColumnBased:Boolean  [read-only]

Returns true for Header, Data and Footer rows,where cells map directly to columns


Implementation
    public function get isColumnBased():Boolean
isColumnGroupRowproperty 
isColumnGroupRow:Boolean  [read-only]


Implementation
    public function get isColumnGroupRow():Boolean
isDataRowproperty 
isDataRow:Boolean  [read-only]


Implementation
    public function get isDataRow():Boolean
isFillRowproperty 
isFillRow:Boolean  [read-only]


Implementation
    public function get isFillRow():Boolean
isFilterRowproperty 
isFilterRow:Boolean  [read-only]


Implementation
    public function get isFilterRow():Boolean
isFooterRowproperty 
isFooterRow:Boolean  [read-only]


Implementation
    public function get isFooterRow():Boolean
isHeaderRowproperty 
isHeaderRow:Boolean  [read-only]


Implementation
    public function get isHeaderRow():Boolean
isPagerRowproperty 
isPagerRow:Boolean  [read-only]


Implementation
    public function get isPagerRow():Boolean
isRendererRowproperty 
isRendererRow:Boolean  [read-only]


Implementation
    public function get isRendererRow():Boolean
nameproperty 
name:String  [read-only]


Implementation
    public function get name():String
rowPositionInfoproperty 
rowPositionInfo:RowPositionInfo

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


Implementation
    public function get rowPositionInfo():RowPositionInfo
    public function set rowPositionInfo(value:RowPositionInfo):void
yproperty 
y:int

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


Implementation
    public function get y():int
    public function set y(value:int):void
Constructor Detail
RowInfo()Constructor
public function RowInfo(height:int, y:Number, grid:IExtendedDataGrid)



Parameters
height:int
 
y:Number
 
grid:IExtendedDataGrid
Method Detail
getCellForColumn()method
public function getCellForColumn(col:FlexDataGridColumn):ComponentInfo

Gets the component info object for the specified column

Parameters

col:FlexDataGridColumn

Returns
ComponentInfo
getCellForColumnGroup()method 
public function getCellForColumnGroup(col:FlexDataGridColumnGroup):ComponentInfo

Gets the component info object for the specified column

Parameters

col:FlexDataGridColumnGroup

Returns
ComponentInfo
getColumnGroupDepth()method 
public function getColumnGroupDepth(grid:FlexDataGrid):int

Parameters

grid:FlexDataGrid

Returns
int
getExpandCollapseCell()method 
public function getExpandCollapseCell():IExpandCollapseComponent

Gets the first IExpandCollapseComponent

Returns
IExpandCollapseComponent
getFilterArguments()method 
public function getFilterArguments():ArrayCollection

Loops through all registered IFilterControls, and creates a filter

Returns
ArrayCollection
getFilterControls()method 
public function getFilterControls():ArrayCollection

Returns all the filter controls

Returns
ArrayCollection
getFilterValue()method 
public function getFilterValue(column:String):Object

Used to set the initial value of the filter.

Parameters

column:String

Returns
Object
getMaxCellHeight()method 
public function getMaxCellHeight(col:FlexDataGridColumn = null):Number

Parameters

col:FlexDataGridColumn (default = null)

Returns
Number
getNextFocusableFilter()method 
public function getNextFocusableFilter(myIndex:int, forward:Boolean, inclusive:Boolean = false):IFocusManagerComponent

Gets the next focusable filter control starting at myIndex, proceeding in forward or backward direction based on the forward parameter

Parameters

myIndex:int — The index to start searching at
 
forward:Boolean — Direction to search in.
 
inclusive:Boolean (default = false)

Returns
IFocusManagerComponent — A IFocusManagerComponent that can accept focus.
hasField()method 
public function hasField(column:String):Boolean

Returns true if the container has a filter control that is bound to the specified column.

Parameters

column:String

Returns
Boolean
invalidateCells()method 
public function invalidateCells():void

refreshCells()method 
public function refreshCells():void

registerIFilterControl()method 
public function registerIFilterControl(iFilterControl:IFilterControl):void

Registers the IFilter control in our list.

Parameters

iFilterControl:IFilterControl — A control that implements IFilterControl

removeCell()method 
public function removeCell(comp:ComponentInfo):void

Parameters

comp:ComponentInfo

setFilterFocus()method 
public function setFilterFocus(fld:String):Boolean

Parameters

fld:String — The string to match the searchField property of the filter control with.

Returns
Boolean — True if focus was set, false if otherwise. Focus may not be set if the given search field does not exist, or if the filter control for the given search field does not implement IFocusManagerComponent.
setFilterValue()method 
public function setFilterValue(column:String, value:Object):void

Used to set the initial value of the filter.

Parameters

column:String — The column to set filter for
 
value:Object — The value to set

setFocusOnNextFocusableControl()method 
public function setFocusOnNextFocusableControl(myIndex:int, forward:Boolean, inclusive:Boolean = false):Boolean

Sets the focus on the next focusable filter control starting at myIndex, proceeding in forward or backward direction based on the forward parameter

Parameters

myIndex:int — The index to start searching at
 
forward:Boolean — Direction to search in.
 
inclusive:Boolean (default = false)

Returns
Boolean — A IFocusManagerComponent that can accept focus.
setRowPositionInfo()method 
public function setRowPositionInfo(rowPos:RowPositionInfo, setHt:Boolean = false):void

Reuse an existing row.

Parameters

rowPos:RowPositionInfo
 
setHt:Boolean (default = false)

showHide()method 
public function showHide(showHide:Boolean):void

Parameters

showHide:Boolean

unRegisterIFilterControl()method 
public function unRegisterIFilterControl(iFilterControl:IFilterControl):void

Registers the IFilter control in our list.

Parameters

iFilterControl:IFilterControl — A control that implements IFilterControl