import FlexDataGridVirtualBodyContainer from 'flexicious-react-datagrid/js/flexgrid/grids/FlexDataGridVirtualBodyContainer.js'

public class | source

FlexDataGridVirtualBodyContainer

Extends:

react~React.Component → EventDispatcher → UIComponent → FlexDataGridContainerBase → FlexDataGridBodyContainer → FlexDataGridVirtualBodyContainer

The container for the body that supports virtual scrolling

Constructor Summary

Public Constructor
public	constructor(grid: *)

Member Summary

Public Members
public	itemVerticalPositions: *[]
public	loadedViewPort: flexiciousNmsp.Rectangle The current viewport rectange
public	virtualScrollDelay: Number Delay in milliseconds before "virtualScroll" event is dispatched.
public	virtualScrollTimer: * The timer that launches the actual scroll so we do not fire server calls as the user is scrolling.

Method Summary

Public Methods
public	addOpenItem(item: Object, rowPositionInfo: flexiciousNmsp.RowPositionInfo, check: boolean, lvl: flexiciousNmsp.FlexDataGridColumnLevel)
public	addRecord(recordsOnPage: Array, vsp: number): number
public	calculateTotalHeight(flat: object, level: flexiciousNmsp.FlexDataGridColumnLevel, heightSoFar: number, nestLevel: number, expanding: flexiciousNmsp.RowPositionInfo, addedRows: Array, parentObject: object, isRecusirve: boolean): number
public	clearAllCollections()
public	clearOpenItems()
public	dispatchScroll(vsp: number, recordsOnPage: array)
public	doScroll()
public	findRowPositionInfo(item: Object): flexiciousNmsp.RowPositionInfo
public	getAnchorArea(openArea: flexiciousNmsp.VirtualScrollLoadInfo, vsp: number, level: flexiciousNmsp.FlexDataGridColumnLevel): flexiciousNmsp.VirtualScrollLoadInfo
public	getChromeHeight(nextLvl: flexiciousNmsp.FlexDataGridColumnLevel): number
public	getClassNames(): *
public	getFirstVisibleRow(): flexiciousNmsp.RowInfo
public	getLastVisibleRow(): flexiciousNmsp.RowInfo
public	getOpenVirtualScrollInfo(vsp: number, levelNestDepth: number): object
public	getParentOpenItem(verticalPosition: number, myNestDepth: number): flexiciousNmsp.VirtualScrollLoadInfo
public	getParentOpenItemFromObject(item: object): object
public	getTopLevelRecordIndex(vsp: number): number
public	getVpFromRecordIndex(vsp: number, recordIndex: number, expandingLevel: flexiciousNmsp.FlexDataGridColumnLevel): boolean
public	gotoVerticalPosition(vsp: number)
public	handleArrowKey(cell: flexiciousNmsp.FlexDataGridCell, keyCode: number, triggerEvent: *): boolean
public	onChildHeaderClicked(headerCell: flexiciousNmsp.FlexDataGridHeaderCell)
public	onTimerComplete(event: *)
public	recycle(level: flexiciousNmsp.FlexDataGridColumnLevel, scrollDown: boolean, scrollDelta: number, scrolling: boolean)
public	removeOpenItem(item: Object, rowPositionInfo: flexiciousNmsp.RowPositionInfo)
public	removeOpenItemVerticalPosition(toRemove: flexiciousNmsp.VirtualScrollLoadInfo, vPos: number)
public	setCurrentRowAtScrollPosition(vsp: number): boolean The current viewport rectange
public	setVirtualScrollData(arr: Array)
public	setVirtualScrollProperties()

Inherited Summary

From class EventDispatcher
public	[prop]: *
public	dead: boolean
public	eventListeners: Array A list of event listeners for this event dispatcher object.
public	typeCache: {}
public	addEventListener(context: , type: , listener: *) Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
public	constructed()
public	dispatchEvent(event: *): boolean Dispatches an event into the event flow.
public	getClassNames(): string[]
public	getStyle(prop: ): Gets the value of the prop property on this object
public	hasEventListener(type: *): Boolean Returns true if an event listener exists
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.
public	kill() Removes all event listeners
public	killArray(arr: *) Given an array of event dispatchers, calls the kill method on each of them.
public	removeEventListener(type: , listener: ) Removes a listener from the EventDispatcher object.
public	setStyle(prop: , val: ) Sets the value of the prop property on this object

From class UIComponent
public static	clearPendingUpdates()
public static	flushPendingUpdates()
public	childIndex: number
public	children: *[]
public	childrenWithProps: *[]
public	data: * This is a getter/setter for the data property.
public	domElement: HTMLElement The dom element associated with this UIComponent.
public	domListeners: Array A list of event listeners that are added to the domElement (these create html dom event listeners as opposed to js only event listeners)
public	enabled: boolean Whether or not this control is enabled.
public	errorString: *
public	handCursor: *
public	height: number
public	horizontalScrollPolicy: *
public	includeInLayout: boolean
public	initialized: boolean
public	innerHTML: string
public	invalid: Boolean A flag to store if this object has been marked for invalidation.
public	oldDisplay: *
public	parent: *
public	propertyBag: {}
public	props: *
public	reactElement: ReactElement The react element associated with this UIComponent.
public	state: *
public	tagName: *
public	toolTip: *
public	verticalScrollPolicy: *
public	visible: boolean Whether or not this control is enabled.
public	width: number
public	x: *
public	y: *
public	addChild(child: *) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addChildAt(child: , idx: ) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addDomEventListener(evt: , f: ) When you call addEventListener on a UIComponent, certain events, defined by the domEvents array are also associated with the corresponding domElement.
public	addEventListener(context: , type: , listener: *) Calls super.addEventListener, and for dom based events, also adds a HTML Event listener
public	attachClass(newClass: *)
public	componentDidMount()
public	componentWillMount()
public	componentWillReceiveProps(nextProps: *)
public	componentWillUnmount()
public	componentWillUpdate()
public	detachClass(newClass: *)
public	domEventFired(event: *) The event handler that gets triggered from the HTML DOM.
public	focus()
public	getAllChildren(): *
public	getAttribute(attr: ):
public	getAutomationName(): *
public	getChildAt(idx: ): Returns the child of the domElement at the specified index.
public	getClassNames(): string[]
public	getComponentStyleAttribute(attr: ):
public	getData(): * This is a getter/setter for the data property.
public	getElementByTagName(tag: ):
public	getEnabled(): * Sets the enabled flag
public	getErrorString(val: ):
public	getHandCursor(): *
public	getHandCursor(): *
public	getHeight(): *
public	getHorizontalScrollPolicy(): *
public	getHorizontalScrollPosition(): *
public	getIncludeInLayout(val: ):
public	getInnerHTML(): * Getter for the innerHTML property
public	getPixelHeight(): *
public	getStyleAttribute(attr: ):
public	getText(): * Getter for the text property
public	getVerticalScrollPolicy(): *
public	getVerticalScrollPosition(): *
public	getVisible(val: ): Sets the visible flag
public	getWidth(): *
public	getX(): * Gets the X co ordinate
public	getY(): * Gets the Y co ordinate
public	globalToLocal(ptIn: *): flexiciousNmsp.Point Converts the given global Point to local co-ordinates.
public	initFromProps(props: *)
public	initialize() Any initialization code is supposed to go in this method.
public	invalidateDisplayList() This method will queue the component so the display list will render it once the current frame of execution is over.
public	kill() First, calls super.kill(), which takes out all event listeners.
public	localToGlobal(ptIn: *): flexiciousNmsp.Point Converts the given local Point to global co-ordinates.
public	measureText(textToMeasure: ): {"width": } Returns the width of the given text.
public	mergeObjects(obj1: , obj2: ): *
public	move(x: , y: ) Sets the X and Y co ordinates of the current dom element
public	numChildren(): * Gets the number of children of the dom element associated with this UIComponent.
public	owns(elem: *): Boolean Recursively iterates through the parent hierarchy of the given element to check to see if the current node is in its parent hierarchy.
public	ownsPoint(pt: *): boolean
public	removeAllChildren(child: *)
public	removeChild(child: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeChildAt(idx: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeComponentAttribute(attr: *)
public	removeDomEventListener(evt: , f: ) Removes a previously attached DOM event listener.
public	removeEventListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	removeEventListenerKeepDomListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	render(): *
public	setActualSize(w: , h: )
public	setActualSizeFromDomElement()
public	setAttribute(attr: , val: )
public	setAutomationName(val: *)
public	setChildIndex(child: , index: ) Sets the visible flag
public	setComponentStyleAttribute(attr: , val: )
public	setData(val: *) This is important, because the grid looks for a "setData" method on the renderer.
public	setDomElement(elem: *) Sets the domElement of this UIComponent to the specified element, and creates a property on the dom element called component to this.
public	setEnabled(val: *) Sets the enabled flag
public	setErrorString(val: *)
public	setHandCursor(val: *)
public	setHeight(val: ):
public	setHorizontalScrollPolicy(policy: *)
public	setHorizontalScrollPosition(val: ):
public	setIncludeInLayout(val: *)
public	setInnerHTML(val: *) Setter for the innerHTML property
public	setState(newState: *)
public	setStateIfDomPresent(state: , db: )
public	setStateInternal(newState: *)
public	setStyleAttribute(attr: , val: )
public	setText(val: *) Setter for the text property
public	setToolTip(val: *)
public	setVerticalScrollPolicy(policy: *)
public	setVerticalScrollPosition(val: ):
public	setVisible(val: *) Sets the visible flag
public	setWidth(val: ):
public	setX(val: ): Sets the X co ordinate
public	setY(val: ): Sets the Y co ordinate
public	updateDisplayList(w: , h: ) Called as a part of render phase.
public	validateNow()
public	validateNowIfValid()

From class FlexDataGridContainerBase
public	cellsWithColSpanOrRowSpan: Aray Once we are through calculating rowspans and colspans, we go through this array, popping cells and hiding cells that are covered by the increased col and row spans of the cells in this array.
public	columnDraggingDragCell: * When a column is being dragged and dropped into a different location, this variable holds the cell that is being dragged.
public	columnDraggingDropTargetCell: *
public	columnDraggingToRight: boolean
public	columnResizingCell: * When a column is being resized, this variable holds the cell that initiated the resize operation.
public	columnResizingCellGlyph: *
public	columnResizingGlyph: *
public	enableHorizontalRecycling: boolean Flag to turn on horizontal scroll recycle.
public	grid: * The grid that we belong to
public	itemClickTimer: flexiciousNmsp.Timer Timer to prevent double click from causing two item clicks.
public	itemClickTimerDuration: number Duration, in milliseconds to wait until dispatching a new ITEM_CLICK event.
public	lastSelectedRowIndex: number Last selected Row Index
public	resizeCursorID: number
public	rows: Array Collection of RowInfo objects currently being displayed.
public	startX: *
public	startY: *
public	verticalSpill: boolean
public	addCell(component: , row: , existingComponent: ):
public	addEventListeners(comp: *) Based upon the type of the cell, adds various event listeners to them to respond to mouse overs, clicks, double clicks, mouse outs, keyboard input, etc.
public	addPadding(nestLevel: number, row: flexiciousNmsp.RowInfo, paddingHeight: number, level: flexiciousNmsp.FlexDataGridColumnLevel, forceRightLock: boolean, scrollPad: boolean, width: number): *
public	addRow(ht: , scrollDown: , rowPositionInfo: ):
public	addToSection(cell: , row: , lockDir: , existingComponent: ): *
public	beginEdit(cell: *) Starts the Edit Session.
public	buildFilter(iSelectFilterControl: Object, column: flexiciousNmsp.FlexDataGridColumn, parentObject: Object, flatValues: Object)
public	calculateColumnDraggingDropTargetCell(event: *) Given the mouse event, figures out which cell is the drop target.
public	cancelEdit(event: *) Cancels the current running edit.
public	checkRowSpanColSpan(retCell: , thisCell: , direction: , dataOnly: , editableOnly: , scrollIfNecessary: , hoverableOnly: ):
public	columnDraggingMouseMoveHandler(event: *)
public	columnDraggingMouseUpHandler(event: *)
public	columnResizeMouseUpHandler(event: *)
public	columnResizingHandler(event: *)
public	createChildren()
public	createComponents(level: flexiciousNmsp.FlexDataGridColumnLevel, currentScroll: number)
public	createFilter(level: flexiciousNmsp.FlexDataGridColumnLevel, parentObject: Object): AdvancedFilter
public	dispatchPageChange(event: *)
public	doInvalidate()
public	emulateClick(cell: *) Used by accesibility
public	endEdit(editor: *) Dispatches ITEM_EDIT_END.
public	filterPageSort(flat: Object, level: flexiciousNmsp.FlexDataGridColumnLevel, parentObj: Object, applyFilter: boolean, applyPaging: boolean, applySort: boolean, pages: Array, updatePager: boolean): Object
public	findLoadingInfo(item: , level: , useSelectedKeyField: ): In lazy loaded grids, gets the loaded info of the provided object.
public	getAllRows(): Array Gets the Rows Collection
public	getBorderHeight(cell: *): number
public	getBorderWidth(cell: *): number
public	getCellForRowColumn(dataObject: , col: , includeExp: ): Given a column and a data object, returns the cell associated with the data object.
public	getCellFromMouseEventTarget(target: *): flexiciousNmsp.FlexDataGridCell
public	getCellHeight(cell: flexiciousNmsp.FlexDataGridDataCell): number
public	getCellInDirection(thisCell: , direction: , dataOnly: , editableOnly: , scrollIfNecessary: , hoverableOnly: ): * Gets the cell in the specified direction of the provided cell
public	getCellWidth(cell: flexiciousNmsp.FlexDataGridDataCell): number
public	getChildAtId(arr: Array, id: number): Object Used by accesibility
public	getChildId(arr: Array, cell: flexiciousNmsp.FlexDataGridDataCell): number Used by accesibility
public	getChildIds(arr: Array) Used by accesibility
public	getClassNames(): string[]
public	getColSpan(cell: flexiciousNmsp.FlexDataGridDataCell): number Given a cell, gets the colspan associated with that cell by calling the this.grid.colSpanFunction.
public	getCurrentEditCell(): * The IFlexDataGridCell under edit currently.
public	getCurrentEditor(): * The editor being used as the current component to edit.
public	getEditCell(): * The IFlexDataGridCell under edit currently.
public	getEditor(): * The editor being used as the current component to edit.
public	getExistingCell(existingComponents: Array, rendererFactory: , col: ): *
public	getFirstAvailableCell(cell: , up: ): * Gets the first cell of the first column.
public	getFirstHoverableCell(row: , dataOnly: , editableOnly: ):
public	getInEdit(): * Returns true if grid is in edit mode
public	getItemVerticalPositions(): number Row positions
public	getPagerWidth(): *
public	getRowSpan(cell: flexiciousNmsp.FlexDataGridDataCell): number Given a cell, gets the rowSpan associated with that cell by calling the this.grid.rowSpanFunction.
public	getRowsForRecycling(): Array
public	getRowsForSnapping(): Object
public	getSelectedIds(bodyStart: *): Array Used by accesibility
public	getTraceCells(): String
public	getTraceRows(): String
public	gotoHorizontalPosition(hsp: *)
public	handleArrowKey(cell: , keyCode: , triggerEvent: *): boolean Handles cell key up.
public	handleCellKeyUp(cell: , keyCode: , triggerEvent: *) Handles cell key up.
public	handleDoubleClick(cell: , triggerEvent: ) Handles the Double Click.
public	handleMouseClick(cell: , triggerEvent: ) Handles the Mouse click.
public	handleMouseOut(cell: , triggerEvent: ) Handles mouse out.
public	handleMouseOver(cell: , triggerEvent: ) Handles mouse over for data cells.
public	handleSpaceBar(cell: , triggerEvent: )
public	hideSpannedCells() Once the snapToColumnWidths finishes, the cellsWithColSpanOrRowSpan array contains all cells that have a row or col span.
public	initializeFilterRenderer(filterRenderer: , filterColumn: , item: , flatDp: , level: *) Given a filter control, initializes it from the provided column
public	initializeRendererFromColumn(filterRenderer: , filterColumn: )
public	invalidateCells() Calls invalidateBackground() on each of the cells.
public	invalidateDisplayList()
public	isCoveredByColSpan(cell: *): boolean Given a cell, returns true if the cell is "hidden" by another cell that has a col span which will cover this cell.
public	isCoveredByRowSpan(cell: *): boolean Given a cell, returns true if the cell is "hidden" by another cell that has a row span which will cover this cell.
public	isCoveredByRowSpanOrColspan(cell: ):
public	isHoverableCell(cell: ): Can this cell accept hover.
public	isInVisibleHorizontalRange(x: number, width: number): boolean Returns true if the passed in numbers are in the visible ViewPort
public	isOutOfVisibleArea(row: *): boolean Abstract
public	kill()
public	killResize()
public	onCellDoubleClick(event: *)
public	onCellDropMouseMove(event: *)
public	onCellKeyUp(event: *)
public	onCellMouseClick(event: *) Handles mouse click.
public	onCellMouseOut(event: *)
public	onCellMouseOver(event: *) Handles Cell Mouse Over.
public	onEditorKeyDown(event: *) Handles the KeyDown on the Editor Component.
public	onEditorKeyFocusChange(event: *)
public	onEditorValueCommit(event: *)
public	onGridMouseMove(event: *)
public	onHeaderCellClicked(cell: flexiciousNmsp.FlexDataGridDataCell, triggerEvent: *, isMsc: boolean)
public	onHeaderCellMouseDown(event: *)
public	onHeaderCellMouseMove(event: *)
public	onHeaderCellMouseOut(event: *)
public	onItemClickTimer(event: *)
public	onSelectAllChanged(event: *)
public	onStageResize(event: *)
public	placeComponents()
public	placeSortIcon(event: *)
public	populateValue(event: *): boolean Applies the value from the editor back to the model object.
public	processColumnGroupCell(level: flexiciousNmsp.FlexDataGridColumnLevel, rendererFactory: , row: flexiciousNmsp.RowInfo, item: object, rowHeight: number, columnGroup: flexiciousNmsp.FlexDataGridColumnGroup, existingComponents: Array):
public	processFilterCell(level: flexiciousNmsp.FlexDataGridColumnLevel, cols: Array, colIndex: number, row: flexiciousNmsp.RowInfo, item: object, flatDp: object, existingComponents: Array)
public	processFooterCell(level: flexiciousNmsp.FlexDataGridColumnLevel, cols: Array, colIndex: number, row: flexiciousNmsp.RowInfo, item: object, existingComponents: Array)
public	processHeaderCell(level: flexiciousNmsp.FlexDataGridColumnLevel, cols: Array, colIndex: number, row: flexiciousNmsp.RowInfo, item: object, rowHeight: number, existingComponents: Array)
public	processHeaderLevel(level: flexiciousNmsp.FlexDataGridColumnLevel, rowPositionInfo: flexiciousNmsp.RowPositionInfo, scrollDown: boolean, item: object, chromeLevel: number, existingRow: flexiciousNmsp.RowInfo, existingComponents: Array): *
public	processRendererLevel(rowPositionInfo: flexiciousNmsp.RowPositionInfo, scrollDown: boolean): flexiciousNmsp.RowIndo
public	processRowPositionInfo(rowPositionInfo: , scrollDown: , existingRow: , existingComponents: ): *
public	reDraw() Calls removeAllComponents, createComponents, validateNow, and snapToColumnWidths
public	recycleH(level: flexiciousNmsp.FlexDataGridColumnLevel, scrollRight: boolean)
public	refreshCells() Re-evaluates all the visible cell contents.
public	refreshCheckBoxes()
public	removeAllComponents(recycle: boolean) End the edit, if active, call removeComponent on each of the rows, and remove all the children.
public	removeComponent(comp: *) Removes the component from its parents hierarchy, and calls destroy method, if the component is a IFlexDataGridCell object Hangs on to the component in the cache for further reuse.
public	removeComponents(row: *) Iterates through all rows and calls removeComponent on each of the cells.
public	removeEventListeners(comp: *)
public	rootPageChange(event: *)
public	scrollToExistingRow(vsp: , scrollDown: ) Abstract
public	selectAllChangedHandler(event: *)
public	setCurrentCellToFirst() Sets the current highlight cell to the first available cell.
public	setEditCell(val: *)
public	setEditor(val: *)
public	snapRowToColumnWidth(row: flexiciousNmsp.RowInfo)
public	snapToColumnWidths()
public	sortByCell(cell: flexiciousNmsp.FlexDataGridDataCell)
public	sortByColumn(col: *)
public	startColumnDrag()
public	storeSort(item: object, column: flexiciousNmsp.FlexDataGridColumn, ascending: boolean)
public	updateDisplayList(unscaledWidth: number, unscaledHeight: number)

From class FlexDataGridBodyContainer
public	backgroundForFillerRows: flexiciousNmsp.UIComponent
public	currentRowPointer: null
public	fillerRow: *
public	fillerRows: Array
public	floatingHeaderRowInfo: * When you have sticky headers, this will be the one floating row.
public	grid: FlexDataGridContainerBase
public	horizontalMask: Number
public	isMouseDown: number
public	itemVerticalPositions: *[]
public	matchSticks: Array
public	maxHorizontalScrollPosition: *
public	maxVerticalScrollPosition: *
public	onDisabledCell: Boolean
public	openItems: Array A list of items that the user has opened.
public	parentMap: Object
public	rows: *[]
public	variableRowHeightRenderers: null Active only when the body containers calculateRowHeight method is running.
public	verticalMask: Number
public	verticalSpill: *
public	addCell(component: UIComponent, row: flexiciousNmsp.RowInfo, existingComponent: flexiciousNmsp.ComponentInfo): flexiciousNmsp.ComponentAdditionResult
public	addEventListeners(comp: flexiciousNmsp.ComponentInfo)
public	addHMatchStick(p: *)
public	addMatchStick(p: *)
public	addMatchSticks(p: *)
public	addOpenItem(item: Object, rowPositionInfo: flexiciousNmsp.RowPositionInfo, check: Boolean, lvl: flexiciousNmsp.FlexDataGridColumnLevel)
public	addRow(ht: number, scrollDown: boolean, rowPositionInfo: RowPositionInfo): *
public	addToExpandingPositions(array: Array, parentRowIndex: number, item: object, heightSoFar: number, level: flexiciousNmsp.FlexDataGridColumnLevel, parent: Object, rowType: number): number
public	addToVerticalPositions(item: Object, heightSoFar: number, level: flexiciousNmsp.FlexDataGridColumnLevel, parent: Object, rowType: number): number
public	adjustFiller(offset: Number)
public	adjustRowPositions(rowPositionInfo: flexiciousNmsp.RowPositionInfo, howManyToRemove: number, heightRemoved: number)
public	binarySearch(arr: Array, verticalPos: Number, low: Number, high: Number): flexiciousNmsp.RowPositionInfo On basis of the vertical scroll position provided, does a quick binary lookup of the record to be shown at that row.
public	calculateTotalHeight(flat: Object, level: flexiciousNmsp.FlexDataGridColumnLevel, heightSoFar: number, nestLevel: number, expanding: flexiciousNmsp.RowPositionInfo, addedRows: Array, parentObject: Object, isRecursive: boolean): number Dual purpose function, one to calculate height, second to figure out that at vertical position Y, the seed record to be shown is?.
public	checkAutoAdjust()
public	checkInconsistency()
public	checkScrollChange(prevCalc: number)
public	checkStickyHeader()
public	clearAllCollections()
public	clearOpenItems()
public	clearVariableRowHeightRenderes() Clears out the variable row height renderers
public	createComponents(level: flexiciousNmsp.FlexDataGridColumnLevel, currentScroll: Number)
public	drawFiller(end: flexiciousNmsp.RowPositionInfo)
public	drawRows(forceFiller: Boolean): boolean
public	drawRowsUsingCache(start: flexiciousNmsp.RowPositionInfo, end: flexiciousNmsp.RowPositionInfo, scrollDown: Boolean, offPage: Boolean)
public	ensureAutoAjustHeight()
public	expandCollapse(expandingDataItem: Object, rowPositionInfo: flexiciousNmsp.RowPositionInfo, forceScrollBar: Boolean)
public	gatherFilteredPagedSortedData(dictionary: Dictionary, result: ArrayCollection, flat: Object, level: flexiciousNmsp.FlexDataGridColumnLevel, parentObject: Object, applyFilter: Boolean, applyPaging: Boolean, applySort: Boolean, pages: Array, flatten: Boolean)
public	getAllRows(): ArrayCollection
public	getCalculatedTotalHeight(): number
public	getChromeType(name: String): number
public	getClassNames(): *
public	getColumnGroupDepth(row: flexiciousNmsp.RowInfo): number
public	getFilteredPagedSortedData(dictionary: Dictionary, applyFilter: Boolean, applyPaging: Boolean, applySort: Boolean, pages: Array, flatten: Boolean): Object
public	getHorizontalScrollBar(): flexiciousNmsp.Rectangle Gets the horizontal scroll bar props
public	getItemAtPosition(position: Number): flexiciousNmsp.RowPositionInfo Returns the RowPosition Info object for the item at the given vertical scroll position
public	getItemVerticalPositions(): Array Gets a copy of the calculated item vertical positions
public	getLoadedItems(): * In lazy loaded grid levels, (filterPageSortMode=server), when the user expands a level for the first time, since the data is not loaded, the level dispatches the filterPageSortChange, or itemLoad.
public	getMaxHorizontalScrollPosition(): number Gets the scrollLeft
public	getMaxVerticalScrollPosition(): number Gets the scrollLeft
public	getNumTotalRows(): number
public	getObjectStack(itemToFind: Object, stackSoFar: Array, useItemKeyForCompare: Boolean, flat: Object, level: flexiciousNmsp.FlexDataGridColumnLevel): Boolean Given an object at any level, returns an array containing information about that object, followed by its parent, until the top of the tree is reached, in reverse order.
public	getOnScreenRows(): Array Returns the number of rows currently visible.
public	getRootFlat(): Object
public	getRowPositionInfo(item: Object, lvl: flexiciousNmsp.FlexDataGridColumnLevel): *
public	getRowPositionInfoFromRows(item: Object): *
public	getRowsForRecycling(): Boolean
public	getRowsForRecycling(): Object
public	getRowsForSnapping(): *
public	getScrollableRect(): flexiciousNmsp.Rectangle handle getScrollableRect
public	getValidNextPage(): boolean Returns true if there is another page of data.
public	getVerticalScrollBar(): flexiciousNmsp.Rectangle Gets the vertical scroll bar props
public	gotoItem(item: Object, highlight: Boolean, useItemKeyForCompare: Boolean, level: flexiciousNmsp.FlexDataGridColumnLevel, rebuild: Boolean): Boolean Given a data item, scrolls to that item in the datagrid If the use item Key For compare parameter is set to true, uses the selectedKeyField value of the item to identify the item.
public	gotoRow(rowIndex: Number): Boolean Given a row index (less than the total number of rows, goes to the row in question).
public	gotoVerticalPosition(vsp: Number) Goes to the vertical position specified by the parameter.
public	gridMouseOut()
public	handleArrowKey(cell: flexiciousNmsp.FlexDataGridCell, keyCode: Number, triggerEvent: *): boolean
public	handleExpandCollapse(disclosureCell: flexiciousNmsp.ExpandCollapseComponent)
public	handleSpaceBar(cell: flexiciousNmsp.FlexDataGridCell, triggerEvent: *)
public	hideFloatingRow()
public	invalidateCalculatedHeight()
public	isLoading(item: object, level: flexiciousNmsp.FlexDataGridColumnLevel, useSelectedKeyField: Boolean): Boolean
public	isOutOfVisibleArea(row: flexiciousNmsp.RowInfo): * Returnes true if the row's vertical position is less than the grids vertical scroll bar position or if the rows vertical position plus rows height is greater than the grids vertical position plus grid height.
public	isYOutOfVisibleArea(numY: Number, numH: Number): Number Returnes true if the row's vertical position is less than the grids vertical scroll bar position or if the rows vertical position plus rows height is greater than the grids vertical position plus grid height.
public	keyDownHandler(event: *)
public	kill()
public	kill()
public	nextPage()
public	onCellDragComplete(event: *)
public	onCellDragMouseDown(event: *)
public	onCellDragMouseMove(event: *)
public	onCellDragMouseUp(event: *)
public	onCellDropMouseMove(event: *)
public	onChildHeaderClicked(headerCell: flexiciousNmsp.FlexDataGridHeaderCell)
public	onDragDrop(event: *)
public	onDragEnter(event: *)
public	onExpandCollapse(event: *)
public	onFilterChange(event: *) handle filterchange
public	onHeaderCellClicked(headerCell: flexiciousNmsp.FlexDataGridHeaderCell, triggerEvent: *, isMsc: boolean)
public	onHeightChanged(event: *)
public	onPageChange(event: *)
public	onSelectAllChanged(event: *)
public	onWidthChanged(event: *)
public	positionExists(seed: flexiciousNmsp.RowPositionInfo): Boolean
public	processItem(rowPositionInfo: flexiciousNmsp.RowPositionInfo, scrollDown: Boolean, existingRow: flexiciousNmsp.RowInfo, existingComponents: Array): flexiciousNmsp.RowInfo
public	processItemPositionInfoUsingCache(seed: flexiciousNmsp.RowPositionInfo, insertionPoint: Number, scrollDown: Boolean)
public	processRowPositionInfo(rowPositionInfo: flexiciousNmsp.RowPositionInfo, scrollDown: Boolean, existingRow: flexiciousNmsp.RowInfo, existingComponents: Array): flexiciousNmsp.RowInfo
public	processSection(addedRows: Array, rowIndex: number, parentObject: Object, heightSoFar: number, level: flexiciousNmsp.FlexDataGridColumnLevel, parentObject5: Object, chromeType: number, expanding: flexiciousNmsp.RowPositionInfo, expandingLevel: flexiciousNmsp.FlexDataGridColumnLevel): number
public	pushCell(column: flexiciousNmsp.FlexDataGridColumn, row: flexiciousNmsp.RowInfo, existingComponents: Array): flexiciousNmsp.ComponentAdditionResult
public	quickFind(whatToFind: String, flat: Object, level: flexiciousNmsp.FlexDataGridColumnLevel, result: Array): * Iterates through the data provider to get a list of objects that match the text provided.
public	recycle(level: flexiciousNmsp.FlexDataGridColumnLevel, scrollDown: Boolean, scrollDelta: Number, scrolling: Boolean)
public	recycleH(level: flexiciousNmsp.FlexDataGridColumnLevel, scrollRight: Boolean)
public	removeAllComponents(recycle: Boolean)
public	removeEventListeners(comp: flexiciousNmsp.ComponentInfo)
public	removeMatchSticks()
public	removeOpenItem(item: Object, rowPositionInfo: RowPositionInfo)
public	render(): *
public	resizeFillerCells()
public	rowExists(rowPos: flexiciousNmsp.RowPositionInfo): Boolean
public	saveRowInCache(row: flexiciousNmsp.RowInfo)
public	scrollToExistingRow(vsp: Number, scrollDown: Bolean) Scrolls to a row that is already drawn.
public	selectText(txt: String) Selects the provided text in the currently visible cells that have the default item renderer, or if the item renderer has the selection property
public	setBackgroudFillerSize()
public	setChildData(item: Object, schildren: Object, level: flexiciousNmsp.FlexDataGridColumnLevel, totalRecords: Number, useSelectedKeyField: Boolean): Boolean
public	setCurrentRowAtScrollPosition(vsp: number): boolean
public	setVerticalScrollPosition(val: number)
public	setVisibleRange() Sets the records in the visible range.
public	shiftColumns(columnToInsert: flexiciousNmsp.FlexDataGridColumn, insertBefore: flexiciousNmsp.FlexDataGridColumn) Inserts the column specified column before the specified column
public	updateDisplayList(unscaledWidth: , unscaledHeight: )
public	validateDisplayList()

Public Constructors

public constructor(grid: *) source

Override:

FlexDataGridBodyContainer#constructor

Params:

Name	Type	Attribute	Description
grid	*

Public Members

public itemVerticalPositions: *[] source

Override:

FlexDataGridBodyContainer#itemVerticalPositions

public loadedViewPort: flexiciousNmsp.Rectangle source

The current viewport rectange

Properties:

Name	Type	Attribute	Description
loadedViewPort	*

public virtualScrollDelay: Number source

Delay in milliseconds before "virtualScroll" event is dispatched.

Properties:

Name	Type	Attribute	Description
virtualScrollDelay	*

public virtualScrollTimer: * source

The timer that launches the actual scroll so we do not fire server calls as the user is scrolling.

Properties:

Name	Type	Attribute	Description
virtualScrollTimer	*

Public Methods

public addOpenItem(item: Object, rowPositionInfo: flexiciousNmsp.RowPositionInfo, check: boolean, lvl: flexiciousNmsp.FlexDataGridColumnLevel) source

Override:

FlexDataGridBodyContainer#addOpenItem

Params:

Name	Type	Attribute	Description
item	Object
rowPositionInfo	flexiciousNmsp.RowPositionInfo
check	boolean
lvl	flexiciousNmsp.FlexDataGridColumnLevel

public addRecord(recordsOnPage: Array, vsp: number): number source

Params:

Name	Type	Attribute	Description
recordsOnPage	Array
vsp	number

Return:

number

public calculateTotalHeight(flat: object, level: flexiciousNmsp.FlexDataGridColumnLevel, heightSoFar: number, nestLevel: number, expanding: flexiciousNmsp.RowPositionInfo, addedRows: Array, parentObject: object, isRecusirve: boolean): number source

Dual purpose function, one to calculate height, second to figure out that at vertical position Y, the seed record to be shown is?.

Override:

FlexDataGridBodyContainer#calculateTotalHeight

Params:

Name	Type	Attribute	Description
flat	object
level	flexiciousNmsp.FlexDataGridColumnLevel
heightSoFar	number
nestLevel	number
expanding	flexiciousNmsp.RowPositionInfo
addedRows	Array
parentObject	object
isRecusirve	boolean

Return:

number

total height

public clearAllCollections() source

Override:

FlexDataGridBodyContainer#clearAllCollections

public clearOpenItems() source

Override:

FlexDataGridBodyContainer#clearOpenItems

public dispatchScroll(vsp: number, recordsOnPage: array) source

Params:

Name	Type	Attribute	Description
vsp	number
recordsOnPage	array

public doScroll() source

public findRowPositionInfo(item: Object): flexiciousNmsp.RowPositionInfo source

Params:

Name	Type	Attribute	Description
item	Object

Return:

flexiciousNmsp.RowPositionInfo

public getAnchorArea(openArea: flexiciousNmsp.VirtualScrollLoadInfo, vsp: number, level: flexiciousNmsp.FlexDataGridColumnLevel): flexiciousNmsp.VirtualScrollLoadInfo source

Params:

Name	Type	Attribute	Description
openArea	flexiciousNmsp.VirtualScrollLoadInfo
vsp	number
level	flexiciousNmsp.FlexDataGridColumnLevel

Return:

flexiciousNmsp.VirtualScrollLoadInfo

public getChromeHeight(nextLvl: flexiciousNmsp.FlexDataGridColumnLevel): number source

Params:

Name	Type	Attribute	Description
nextLvl	flexiciousNmsp.FlexDataGridColumnLevel

Return:

number

public getClassNames(): * source

Override:

FlexDataGridBodyContainer#getClassNames

Return:

Array

public getFirstVisibleRow(): flexiciousNmsp.RowInfo source

Return:

flexiciousNmsp.RowInfo

public getLastVisibleRow(): flexiciousNmsp.RowInfo source

Return:

flexiciousNmsp.RowInfo

public getOpenVirtualScrollInfo(vsp: number, levelNestDepth: number): object source

Params:

Name	Type	Attribute	Description
vsp	number
levelNestDepth	number

Return:

object

public getParentOpenItem(verticalPosition: number, myNestDepth: number): flexiciousNmsp.VirtualScrollLoadInfo source

Params:

Name	Type	Attribute	Description
verticalPosition	number
myNestDepth	number

Return:

flexiciousNmsp.VirtualScrollLoadInfo

public getParentOpenItemFromObject(item: object): object source

Params:

Name	Type	Attribute	Description
item	object

Return:

object

public getTopLevelRecordIndex(vsp: number): number source

Params:

Name	Type	Attribute	Description
vsp	number

Return:

number

top level record index

public getVpFromRecordIndex(vsp: number, recordIndex: number, expandingLevel: flexiciousNmsp.FlexDataGridColumnLevel): boolean source

Params:

Name	Type	Attribute	Description
vsp	number
recordIndex	number
expandingLevel	flexiciousNmsp.FlexDataGridColumnLevel

Return:

boolean

public gotoVerticalPosition(vsp: number) source

Goes to the vertical position specified by the parameter. Recycles the renderers

Override:

FlexDataGridBodyContainer#gotoVerticalPosition

Params:

Name	Type	Attribute	Description
vsp	number

public handleArrowKey(cell: flexiciousNmsp.FlexDataGridCell, keyCode: number, triggerEvent: *): boolean source

Handles cell key up. Handles KeyBoard.UP,KeyBoard.DOWN,KeyBoard.LEFT,KeyBoard.RIGHT

Override:

FlexDataGridBodyContainer#handleArrowKey

Params:

Name	Type	Attribute	Description
cell	flexiciousNmsp.FlexDataGridCell
keyCode	number
triggerEvent	*

Return:

boolean

public onChildHeaderClicked(headerCell: flexiciousNmsp.FlexDataGridHeaderCell) source

Override:

FlexDataGridBodyContainer#onChildHeaderClicked

Params:

Name	Type	Attribute	Description
headerCell	flexiciousNmsp.FlexDataGridHeaderCell

public onTimerComplete(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public recycle(level: flexiciousNmsp.FlexDataGridColumnLevel, scrollDown: boolean, scrollDelta: number, scrolling: boolean) source

Override:

FlexDataGridBodyContainer#recycle

Params:

Name	Type	Attribute	Description
level	flexiciousNmsp.FlexDataGridColumnLevel
scrollDown	boolean
scrollDelta	number
scrolling	boolean

public removeOpenItem(item: Object, rowPositionInfo: flexiciousNmsp.RowPositionInfo) source

Override:

FlexDataGridBodyContainer#removeOpenItem

Params:

Name	Type	Attribute	Description
item	Object
rowPositionInfo	flexiciousNmsp.RowPositionInfo

public removeOpenItemVerticalPosition(toRemove: flexiciousNmsp.VirtualScrollLoadInfo, vPos: number) source

Params:

Name	Type	Attribute	Description
toRemove	flexiciousNmsp.VirtualScrollLoadInfo
vPos	number

public setCurrentRowAtScrollPosition(vsp: number): boolean source

The current viewport rectange

Override:

FlexDataGridBodyContainer#setCurrentRowAtScrollPosition

Params:

Name	Type	Attribute	Description
vsp	number

Return:

boolean

public setVirtualScrollData(arr: Array) source

Params:

Name	Type	Attribute	Description
arr	Array