Packagecom.flexicious.nestedtreedatagrid.valueobjects
Classpublic class VirtualScrollLoadInfo
InheritanceVirtualScrollLoadInfo Inheritance Object

When grid.enableVirtualScroll=true, the grid dispatches a virtualScroll event when the grid scrolls. This event contains a recordsToLoad array, which contains an series of VirtualScrollLoadInfo records. This provides the application a list of record indexes to load, and which levels to load them at. In flat grids, the FlexDataGridVirtualScrollEvent.recordsToLoad will always contain a list of VirtualScrollLoadInfo records were level=1. For nested grids, depending on where the user scrolls and which items are open, you could get a list of records from multiple levels, for example. Records 1-3 from level 1, All children of record 3 from level 2, and then Record 4-10 from level 1. Setting enableVirtualScroll requires that you specify childrenCountField as well as selectedKeyField. Additionally, enableVirtualScroll also requires that you set filterPageSortMode=server and itemLoadMode=server. Finally, virtual scroll does not work with variableRowHeights.



Public Properties
 PropertyDefined By
  item : Object
Pointer to the item.
VirtualScrollLoadInfo
  itemArea : Number
[read-only]
VirtualScrollLoadInfo
  itemHeight : Number
The "area" covered by this item.
VirtualScrollLoadInfo
  level : FlexDataGridColumnLevel
FlexDataGridColumnLevel that this item belongs to
VirtualScrollLoadInfo
  levelNestDepth : int
[read-only] The nest depth of the level
VirtualScrollLoadInfo
  parent : Object
Pointer to the parent item.
VirtualScrollLoadInfo
  recordIndex : int
The record index.
VirtualScrollLoadInfo
  rowType : int
Type of the row.
VirtualScrollLoadInfo
  verticalScrollPosition : Number
The verticalScrollPosition that this record appears at
VirtualScrollLoadInfo
Public Methods
 MethodDefined By
  
VirtualScrollLoadInfo(level:FlexDataGridColumnLevel, recordIndex:int, verticalScrollPosition:Number, itemHeight:Number, item:Object, parent:Object = null, rowType:int = -1)
VirtualScrollLoadInfo
  
VirtualScrollLoadInfo
  
toString():String
VirtualScrollLoadInfo
Property Detail
itemproperty
public var item:Object

Pointer to the item. Should be populated before calling setVirtualScrollData.

itemAreaproperty 
itemArea:Number  [read-only]


Implementation
    public function get itemArea():Number
itemHeightproperty 
public var itemHeight:Number

The "area" covered by this item. Includes any children.

levelproperty 
public var level:FlexDataGridColumnLevel

FlexDataGridColumnLevel that this item belongs to

levelNestDepthproperty 
levelNestDepth:int  [read-only]

The nest depth of the level


Implementation
    public function get levelNestDepth():int
parentproperty 
public var parent:Object

Pointer to the parent item.

recordIndexproperty 
public var recordIndex:int

The record index.

rowTypeproperty 
public var rowType:int

Type of the row.

verticalScrollPositionproperty 
public var verticalScrollPosition:Number

The verticalScrollPosition that this record appears at

Constructor Detail
VirtualScrollLoadInfo()Constructor
public function VirtualScrollLoadInfo(level:FlexDataGridColumnLevel, recordIndex:int, verticalScrollPosition:Number, itemHeight:Number, item:Object, parent:Object = null, rowType:int = -1)



Parameters
level:FlexDataGridColumnLevel
 
recordIndex:int
 
verticalScrollPosition:Number
 
itemHeight:Number
 
item:Object
 
parent:Object (default = null)
 
rowType:int (default = -1)
Method Detail
isParentOf()method
public function isParentOf(child:VirtualScrollLoadInfo):Boolean

Parameters

child:VirtualScrollLoadInfo

Returns
Boolean
toString()method 
public function toString():String

Returns
String