com.flexicious.nestedtreedatagrid.FlexDataGridContainerBase

	Property	Defined By
		columnDraggingDragCell : FlexDataGridCell When a column is being dragged and dropped into a different location, this variable holds the cell that is being dragged.	FlexDataGridContainerBase
		columnResizingCell : FlexDataGridHeaderCell When a column is being resized, this variable holds the cell that initiated the resize operation.	FlexDataGridContainerBase
		enableHorizontalRecycling : Boolean = true Flag to turn on horizontal scroll recycle.	FlexDataGridContainerBase
		grid : FlexDataGrid The grid that we belong to	FlexDataGridContainerBase
		inEdit : Boolean [read-only] Returns true if grid is in edit mode	FlexDataGridContainerBase
		itemClickTimerDuration : Number = 250 Duration, in milliseconds to wait until dispatching a new ITEM_CLICK event.	FlexDataGridContainerBase
		itemVerticalPositions : Array [read-only] Row positions	FlexDataGridContainerBase
		rows : ArrayCollection Collection of RowInfo objects currently being displayed.	FlexDataGridContainerBase

	Property	Defined By
		cellsWithColSpanOrRowSpan : Array 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.	FlexDataGridContainerBase
		editCell : IFlexDataGridDataCell	FlexDataGridContainerBase
		editor : UIComponent	FlexDataGridContainerBase
		itemClickTimer : Timer Timer to prevent double click from causing two item clicks.	FlexDataGridContainerBase
		_keyboardhandled : Boolean = false	FlexDataGridContainerBase
		lastSelectedRowIndex : int = -1 Last selected Row Index	FlexDataGridContainerBase

	Method	Defined By
		cancelEdit(event:Event):void Cancels the current running edit.	FlexDataGridContainerBase
		emulateClick(cell:IFlexDataGridCell):void Used by accesibility	FlexDataGridContainerBase
		endEdit(editor:UIComponent, event:Event = null):void Dispatches ITEM_EDIT_END.	FlexDataGridContainerBase
		filterPageSort(flat:Object, level:FlexDataGridColumnLevel, parentObj:Object, applyFilter:Boolean = true, applyPaging:Boolean = true, applySort:Boolean = true, pages:Array = null, updatePager:Boolean = false):Object	FlexDataGridContainerBase
		findLoadingInfo(item:Object, level:FlexDataGridColumnLevel, useSelectedKeyField:Boolean = false):ItemLoadInfo In lazy loaded grids, gets the loaded info of the provided object.	FlexDataGridContainerBase
		getCellForRowColumn(dataObject:Object, col:FlexDataGridColumn, includeExp:Boolean = false):IFlexDataGridCell Given a column and a data object, returns the cell associated with the data object.	FlexDataGridContainerBase
		getCellInDirection(thisCell:IFlexDataGridCell, direction:String, dataOnly:Boolean = false, editableOnly:Boolean = false, scrollIfNecessary:Boolean = true, hoverableOnly:Boolean = false):IFlexDataGridCell Gets the cell in the specified direction of the provided cell	FlexDataGridContainerBase
		getChildAtId(arr:Array, id:uint):IFlexDataGridCell Used by accesibility	FlexDataGridContainerBase
		getChildId(arr:Array, cell:IFlexDataGridCell):uint Used by accesibility	FlexDataGridContainerBase
		getChildIds(arr:Array):void Used by accesibility	FlexDataGridContainerBase
		getCurrentEditCell():IFlexDataGridCell The IFlexDataGridCell under edit currently.	FlexDataGridContainerBase
		getCurrentEditor():UIComponent The editor being used as the current component to edit.	FlexDataGridContainerBase
		getFirstAvailableCell(cell:IFlexDataGridCell, up:Boolean = true):IFlexDataGridCell Gets the first cell of the first column.	FlexDataGridContainerBase
		getFirstHoverableCell(row:RowInfo, dataOnly:Boolean = false, editableOnly:Boolean = false):IFlexDataGridCell	FlexDataGridContainerBase
		getSelectedIds(bodyStart:uint):Array Used by accesibility	FlexDataGridContainerBase
		handleArrowKey(cell:IFlexDataGridCell, keyCode:uint, triggerEvent:Event):Boolean Handles cell key up.	FlexDataGridContainerBase
		handleCellKeyUp(cell:IFlexDataGridCell, keyCode:uint, triggerEvent:Event):void Handles cell key up.	FlexDataGridContainerBase
		handleEditorKeyEvent(event:KeyboardEvent, cell:IFlexDataGridCell):void	FlexDataGridContainerBase
		initializeEditor(editCell:IFlexDataGridDataCell, editor:UIComponent, pare:UIComponent):void	FlexDataGridContainerBase
		initializeFilterRenderer(filterRenderer:IFilterControl, filterColumn:FlexDataGridColumn, item:Object, flatDp:Object, level:FlexDataGridColumnLevel):void Given a filter control, initializes it from the provided column	FlexDataGridContainerBase
		invalidateCells():void Calls invalidateBackground() on each of the cells.	FlexDataGridContainerBase
		invalidateDisplayList():void [override]	FlexDataGridContainerBase
		isCoveredByColSpan(cell:IFlexDataGridCell):Boolean Given a cell, returns true if the cell is "hidden" by another cell that has a col span which will cover this cell.	FlexDataGridContainerBase
		isCoveredByRowSpan(cell:IFlexDataGridCell):Boolean Given a cell, returns true if the cell is "hidden" by another cell that has a row span which will cover this cell.	FlexDataGridContainerBase
		isHoverableCell(cell:IFlexDataGridCell):Boolean Can this cell accept hover.	FlexDataGridContainerBase
		isOutOfVisibleArea(row:RowInfo):Boolean Abstract	FlexDataGridContainerBase
		onHeaderCellClicked(cell:FlexDataGridHeaderCell, triggerEvent:Event, isMsc:Boolean = false, useMsc:Boolean = true, direction:String = null):void	FlexDataGridContainerBase
		populateValue(event:Event, itemEditor:UIComponent = null):Boolean Applies the value from the editor back to the model object.	FlexDataGridContainerBase
		reDraw():void Calls removeAllComponents, createComponents, validateNow, and snapToColumnWidths	FlexDataGridContainerBase
		refreshCells():void Re-evaluates all the visible cell contents.	FlexDataGridContainerBase
		refreshCheckBoxes():void	FlexDataGridContainerBase
		removeAllComponents(recycle:Boolean):void End the edit, if active, call removeComponent on each of the rows, and remove all the children.	FlexDataGridContainerBase
		scrollToExistingRow(vsp:Number, scrollDown:Boolean):void Abstract	FlexDataGridContainerBase
		setCurrentCellToFirst():void Sets the current highlight cell to the first available cell.	FlexDataGridContainerBase
		sortByColumn(col:FlexDataGridColumn, direction:String = null):void	FlexDataGridContainerBase

	Method	Defined By
		addEventListeners(comp:ComponentInfo):ComponentInfo 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.	FlexDataGridContainerBase
		addPadding(nestLevel:int, row:RowInfo, paddingHeight:Number, level:FlexDataGridColumnLevel, forceRightLock:Boolean = false, scrollPad:Boolean = false, width:int = -1):FlexDataGridPaddingCell	FlexDataGridContainerBase
		beginEdit(cell:IFlexDataGridDataCell):void Starts the Edit Session.	FlexDataGridContainerBase
		calculateColumnDraggingDropTargetCell(event:MouseEvent):void Given the mouse event, figures out which cell is the drop target.	FlexDataGridContainerBase
		checkRowSpanColSpan(retCell:IFlexDataGridCell, thisCell:IFlexDataGridCell, direction:String, dataOnly:Boolean, editableOnly:Boolean, scrollIfNecessary:Boolean, hoverableOnly:Boolean):IFlexDataGridCell	FlexDataGridContainerBase
		createChildren():void [override]	FlexDataGridContainerBase
		getAllRows():ArrayCollection Gets the Rows Collection	FlexDataGridContainerBase
		getCellHeight(cell:IFlexDataGridCell):Number	FlexDataGridContainerBase
		getCellWidth(cell:IFlexDataGridCell):Number	FlexDataGridContainerBase
		getColSpan(cell:IFlexDataGridCell):int Given a cell, gets the colspan associated with that cell by calling the grid.colSpanFunction.	FlexDataGridContainerBase
		getRowsForRecycling():Object	FlexDataGridContainerBase
		getRowsForSnapping():Object	FlexDataGridContainerBase
		getRowSpan(cell:IFlexDataGridCell):int Given a cell, gets the rowSpan associated with that cell by calling the grid.rowSpanFunction.	FlexDataGridContainerBase
		handleDoubleClick(cell:IFlexDataGridCell, triggerEvent:Event):void Handles the Double Click.	FlexDataGridContainerBase
		handleMouseClick(cell:IFlexDataGridCell, triggerEvent:Event, checkTimer:Boolean = true):void Handles the Mouse click.	FlexDataGridContainerBase
		handleMouseOut(cell:IFlexDataGridCell, triggerEvent:Event):void Handles mouse out.	FlexDataGridContainerBase
		handleMouseOver(cell:IFlexDataGridCell, triggerEvent:Event):void Handles mouse over for data cells.	FlexDataGridContainerBase
		handleSpaceBar(cell:IFlexDataGridCell, triggerEvent:Event):void	FlexDataGridContainerBase
		hideSpannedCells():void Once the snapToColumnWidths finishes, the cellsWithColSpanOrRowSpan array contains all cells that have a row or col span.	FlexDataGridContainerBase
		isCoveredByRowSpanOrColspan(cell:IFlexDataGridCell):Boolean	FlexDataGridContainerBase
		onCellMouseClick(event:MouseEvent):void Handles mouse click.	FlexDataGridContainerBase
		onCellMouseOver(event:MouseEvent):void Handles Cell Mouse Over.	FlexDataGridContainerBase
		onEditorKeyDown(event:KeyboardEvent):void Handles the KeyDown on the Editor Component.	FlexDataGridContainerBase
		onItemClickTimer(event:TimerEvent):void	FlexDataGridContainerBase
		onMouseMove(event:MouseEvent):void	FlexDataGridContainerBase
		onSelectAllChanged(event:Event):void	FlexDataGridContainerBase
		placeSortIcon(event:Event):void	FlexDataGridContainerBase
		removeComponent(comp:ComponentInfo):void 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.	FlexDataGridContainerBase
		removeComponents(row:RowInfo):void Iterates through all rows and calls removeComponent on each of the cells.	FlexDataGridContainerBase
		selectAllChangedHandler(event:Event):void	FlexDataGridContainerBase
		snapRowToColumnWidth(row:RowInfo):void	FlexDataGridContainerBase
		sortByCell(cell:FlexDataGridHeaderCell):void	FlexDataGridContainerBase
		storeSort(item:Object, column:FlexDataGridColumn, ascending:Boolean):void	FlexDataGridContainerBase
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]	FlexDataGridContainerBase

	Event	Summary	Defined By
		columnsResized	Dispatched when the columns at any level are resized.	FlexDataGridContainerBase
		headerClicked	Dispatched when the header cells are clicked	FlexDataGridContainerBase

Property Detail

_keyboardhandled

property

protected var _keyboardhandled:Boolean = false

cellsWithColSpanOrRowSpan

property

protected var cellsWithColSpanOrRowSpan:Array

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. Please note, this array will only be populated when the snapToColumnWidths has just executed, and the hideSpannedCells has not.

columnDraggingDragCell

property

public var columnDraggingDragCell:FlexDataGridCell

When a column is being dragged and dropped into a different location, this variable holds the cell that is being dragged. The cell actually does not drag, we render a glyph that trails the users mouse pointer. This variable simply holds a reference to the header cell associated with the column being dragged.

columnResizingCell

property

public var columnResizingCell:FlexDataGridHeaderCell

When a column is being resized, this variable holds the cell that initiated the resize operation. We render a glyph that trails the users mouse pointer during the resize operation This variable simply holds a reference to the header cell associated with the column being resized.

editCell

property

editCell:IFlexDataGridDataCell

Implementation
protected function get editCell():IFlexDataGridDataCell
protected function set editCell(value:IFlexDataGridDataCell):void

editor

property

editor:UIComponent

Implementation
protected function get editor():UIComponent
protected function set editor(value:UIComponent):void

enableHorizontalRecycling

property

public var enableHorizontalRecycling:Boolean = true

Flag to turn on horizontal scroll recycle. Should be turned off in case of using ICustomMatchFilterControl, since you do not want these controls to be recycled.

grid

property

public var grid:FlexDataGrid

The grid that we belong to

inEdit

property

inEdit:Boolean [read-only]

Returns true if grid is in edit mode

Implementation
public function get inEdit():Boolean

itemClickTimer

property

protected var itemClickTimer:Timer

Timer to prevent double click from causing two item clicks.

itemClickTimerDuration

property

public var itemClickTimerDuration:Number = 250

Duration, in milliseconds to wait until dispatching a new ITEM_CLICK event. Prevents two ITEM_CLICK events when user double clicks. Defaults to 250

itemVerticalPositions

property

itemVerticalPositions:Array [read-only]

Row positions

Implementation
public function get itemVerticalPositions():Array

lastSelectedRowIndex

property

protected var lastSelectedRowIndex:int = -1

Last selected Row Index

rows

property

public var rows:ArrayCollection

Collection of RowInfo objects currently being displayed. The Header,Footer and Filter containers usually have only one row, while the body container has as many rows an be shown in the currently visible area.

Method Detail

addEventListeners

()

method

protected function addEventListeners(comp:ComponentInfo):ComponentInfo

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.

Parameters

comp:ComponentInfo

Returns

ComponentInfo

addPadding

()

method

 protected function addPadding(nestLevel:int, row:RowInfo, paddingHeight:Number, level:FlexDataGridColumnLevel, forceRightLock:Boolean = false, scrollPad:Boolean = false, width:int = -1):FlexDataGridPaddingCell

Parameters

	`nestLevel:int`

	`row:RowInfo`

	`paddingHeight:Number`

	`level:FlexDataGridColumnLevel`

	`forceRightLock:Boolean` (default = `false`)

	`scrollPad:Boolean` (default = `false`)

	`width:int` (default = `-1`)

Returns

FlexDataGridPaddingCell

beginEdit

()

method

protected function beginEdit(cell:IFlexDataGridDataCell):void

Starts the Edit Session.

Parameters

cell:IFlexDataGridDataCell

calculateColumnDraggingDropTargetCell

()

method

protected function calculateColumnDraggingDropTargetCell(event:MouseEvent):void

Given the mouse event, figures out which cell is the drop target. In 2.9, code was added to drop on the right cell of the current if the mouse is to the right of the middle of the cell, and on the left cell of the current if the mouse is on the left hand side of the middle of the cell. This function checks to see if the mouse is over a header cell, and if the cell being dragged is a header cell. If so, it will size and position a glyph so that the user gets interactive feedback about where the column will be dropped and which column will be dropped. The same applies to the column group cells for drag and drop purposes.

Parameters

event:MouseEvent

cancelEdit

()

method

public function cancelEdit(event:Event):void

Cancels the current running edit. Dispatches ITEM_EDIT_CANCEL.

Parameters

event:Event

checkRowSpanColSpan

()

method

 protected function checkRowSpanColSpan(retCell:IFlexDataGridCell, thisCell:IFlexDataGridCell, direction:String, dataOnly:Boolean, editableOnly:Boolean, scrollIfNecessary:Boolean, hoverableOnly:Boolean):IFlexDataGridCell

Parameters

	`retCell:IFlexDataGridCell`

	`thisCell:IFlexDataGridCell`

	`direction:String`

	`dataOnly:Boolean`

	`editableOnly:Boolean`

	`scrollIfNecessary:Boolean`

	`hoverableOnly:Boolean`

Returns

IFlexDataGridCell

createChildren

()

method

override protected function createChildren():void

emulateClick

()

method

public function emulateClick(cell:IFlexDataGridCell):void

Used by accesibility

Parameters

cell:IFlexDataGridCell

endEdit

()

method

public function endEdit(editor:UIComponent, event:Event = null):void

Dispatches ITEM_EDIT_END. Removes Event listeners

Parameters

	`editor:UIComponent`

	`event:Event` (default = `null`)

filterPageSort

()

method

 public function filterPageSort(flat:Object, level:FlexDataGridColumnLevel, parentObj:Object, applyFilter:Boolean = true, applyPaging:Boolean = true, applySort:Boolean = true, pages:Array = null, updatePager:Boolean = false):Object

Parameters

	`flat:Object`

	`level:FlexDataGridColumnLevel`

	`parentObj:Object`

	`applyFilter:Boolean` (default = `true`)

	`applyPaging:Boolean` (default = `true`)

	`applySort:Boolean` (default = `true`)

	`pages:Array` (default = `null`)

	`updatePager:Boolean` (default = `false`)

Returns

Object

findLoadingInfo

()

method

 public function findLoadingInfo(item:Object, level:FlexDataGridColumnLevel, useSelectedKeyField:Boolean = false):ItemLoadInfo

In lazy loaded grids, gets the loaded info of the provided object.

Parameters

	`item:Object`

	`level:FlexDataGridColumnLevel`

	`useSelectedKeyField:Boolean` (default = `false`)

Returns

ItemLoadInfo

getAllRows

()

method

protected function getAllRows():ArrayCollection

Gets the Rows Collection

Returns

ArrayCollection —

getCellForRowColumn

()

method

 public function getCellForRowColumn(dataObject:Object, col:FlexDataGridColumn, includeExp:Boolean = false):IFlexDataGridCell

Given a column and a data object, returns the cell associated with the data object. If the column is null, will return the first unlocked cell of the row associated with the data object, if includeExp is set to true, returns the expand collapse cell. Please note, this only checks the rows that are currently drawn, not the entire dataprovider. Only the data objects that have currently drawn rows (the visible viewport) will return a cell object, others will reuturn null

Parameters

	`dataObject:Object` — An item in the dataprovider.

	`col:FlexDataGridColumn` — A column to match. Can be null.

	`includeExp:Boolean` (default = `false`) — Whether or not to include the expand collapse cell.

Returns

IFlexDataGridCell — IFlexDataGridCell

getCellHeight

()

method

protected function getCellHeight(cell:IFlexDataGridCell):Number

Parameters

cell:IFlexDataGridCell

Returns

Number

getCellInDirection

()

method

 public function getCellInDirection(thisCell:IFlexDataGridCell, direction:String, dataOnly:Boolean = false, editableOnly:Boolean = false, scrollIfNecessary:Boolean = true, hoverableOnly:Boolean = false):IFlexDataGridCell

Gets the cell in the specified direction of the provided cell

Parameters

	`thisCell:IFlexDataGridCell` — The cell to start searching at.

	`direction:String` — The direction to search. Should be one of FlexDataGrid.CELL_POSITION_XXXX constants

	`dataOnly:Boolean` (default = `false`) — Boolean flag to look only for data cells (IFlexDataGridDataCell)

	`editableOnly:Boolean` (default = `false`) — Boolean flag to look only for editable cells

	`scrollIfNecessary:Boolean` (default = `true`) — If next visible cell is beyond scrollable area, recycle and then search again.

	`hoverableOnly:Boolean` (default = `false`) — Boolean flag to look only for cells where isHoverable(cell) is true.

Returns

IFlexDataGridCell — The cell, if one matches the provided criteria, or null

getCellWidth

()

method

protected function getCellWidth(cell:IFlexDataGridCell):Number

Parameters

cell:IFlexDataGridCell

Returns

Number

getChildAtId

()

method

public function getChildAtId(arr:Array, id:uint):IFlexDataGridCell

Used by accesibility

Parameters

	`arr:Array`

	`id:uint`

Returns

IFlexDataGridCell

getChildId

()

method

public function getChildId(arr:Array, cell:IFlexDataGridCell):uint

Used by accesibility

Parameters

	`arr:Array`

	`cell:IFlexDataGridCell`

Returns

uint

getChildIds

()

method

public function getChildIds(arr:Array):void

Used by accesibility

Parameters

arr:Array

getColSpan

()

method

protected function getColSpan(cell:IFlexDataGridCell):int

Given a cell, gets the colspan associated with that cell by calling the grid.colSpanFunction.

Parameters

cell:IFlexDataGridCell

Returns

int

getCurrentEditCell

()

method

public function getCurrentEditCell():IFlexDataGridCell

The IFlexDataGridCell under edit currently. Please note, this is the IFlexDataGridCell component, not the editor component. This will be populated only after an edit session has started. To access the actual editor, please use the getCurrentEditor property

Returns

IFlexDataGridCell

getCurrentEditor

()

method

public function getCurrentEditor():UIComponent

The editor being used as the current component to edit. This is an instance of the itemEditor class factory. This will be populated only after an edit session has started.

Returns

UIComponent

getFirstAvailableCell

()

method

public function getFirstAvailableCell(cell:IFlexDataGridCell, up:Boolean = true):IFlexDataGridCell

Gets the first cell of the first column.

Parameters

	`cell:IFlexDataGridCell`

	`up:Boolean` (default = `true`)

Returns

IFlexDataGridCell

getFirstHoverableCell

()

method

 public function getFirstHoverableCell(row:RowInfo, dataOnly:Boolean = false, editableOnly:Boolean = false):IFlexDataGridCell

Parameters

	`row:RowInfo`

	`dataOnly:Boolean` (default = `false`)

	`editableOnly:Boolean` (default = `false`)

Returns

IFlexDataGridCell

getRowsForRecycling

()

method

protected function getRowsForRecycling():Object

Returns

Object

getRowsForSnapping

()

method

protected function getRowsForSnapping():Object

Returns

Object

getRowSpan

()

method

protected function getRowSpan(cell:IFlexDataGridCell):int

Given a cell, gets the rowSpan associated with that cell by calling the grid.rowSpanFunction.

Parameters

cell:IFlexDataGridCell

Returns

int

getSelectedIds

()

method

public function getSelectedIds(bodyStart:uint):Array

Used by accesibility

Parameters

bodyStart:uint

Returns

Array

handleArrowKey

()

method

public function handleArrowKey(cell:IFlexDataGridCell, keyCode:uint, triggerEvent:Event):Boolean

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

Parameters

	`cell:IFlexDataGridCell`

	`keyCode:uint`

	`triggerEvent:Event`

Returns

Boolean

handleCellKeyUp

()

method

public function handleCellKeyUp(cell:IFlexDataGridCell, keyCode:uint, triggerEvent:Event):void

Handles cell key up. Handles the following keys: keyCode == Keyboard.UP || keyCode == Keyboard.DOWN || keyCode == Keyboard.LEFT || keyCode == Keyboard.RIGHT || keyCode == Keyboard.TAB || keyCode == Keyboard.PAGE_DOWN || keyCode == Keyboard.PAGE_UP || keyCode == Keyboard.HOME || keyCode == Keyboard.END || keyCode == Keyboard.NUMPAD_SUBTRACT || keyCode == Keyboard.NUMPAD_ADD || keyCode == Keyboard.F2 || keyCode == Keyboard.NUMPAD_MULTIPLY

Parameters

	`cell:IFlexDataGridCell`

	`keyCode:uint`

	`triggerEvent:Event`

handleDoubleClick

()

method

protected function handleDoubleClick(cell:IFlexDataGridCell, triggerEvent:Event):void

Handles the Double Click. If ther enableDoubleClickEdit and editableon the column is set to true, starts the edit session

Parameters

	`cell:IFlexDataGridCell`

	`triggerEvent:Event`

handleEditorKeyEvent

()

method

public function handleEditorKeyEvent(event:KeyboardEvent, cell:IFlexDataGridCell):void

Parameters

	`event:KeyboardEvent`

	`cell:IFlexDataGridCell`

handleMouseClick

()

method

protected function handleMouseClick(cell:IFlexDataGridCell, triggerEvent:Event, checkTimer:Boolean = true):void

Handles the Mouse click. Dispatches ITEM_CLICK. If the Cell is a header cell, calls onHeaderCellClicked. If the cells is the checkbox selection cell, updates the grid selection. Updates the Selected Cells, if grid.isCellSelectionMode. If the column is editable, begins the edit session.

Parameters

	`cell:IFlexDataGridCell`

	`triggerEvent:Event`

	`checkTimer:Boolean` (default = `true`)

handleMouseOut

()

method

protected function handleMouseOut(cell:IFlexDataGridCell, triggerEvent:Event):void

Handles mouse out. Dispatches the Item Roll Out event

Parameters

	`cell:IFlexDataGridCell`

	`triggerEvent:Event`

handleMouseOver

()

method

protected function handleMouseOver(cell:IFlexDataGridCell, triggerEvent:Event):void

Handles mouse over for data cells. Calls highlightRow for item rollovers.

Parameters

	`cell:IFlexDataGridCell`

	`triggerEvent:Event`

handleSpaceBar

()

method

protected function handleSpaceBar(cell:IFlexDataGridCell, triggerEvent:Event):void

Parameters

	`cell:IFlexDataGridCell`

	`triggerEvent:Event`

hideSpannedCells

()

method

protected function hideSpannedCells():void

Once the snapToColumnWidths finishes, the cellsWithColSpanOrRowSpan array contains all cells that have a row or col span. This method will bring such cells to the top so they hide the ones that are covered.

initializeEditor

()

method

public function initializeEditor(editCell:IFlexDataGridDataCell, editor:UIComponent, pare:UIComponent):void

Parameters

	`editCell:IFlexDataGridDataCell`

	`editor:UIComponent`

	`pare:UIComponent`

initializeFilterRenderer

()

method

 public function initializeFilterRenderer(filterRenderer:IFilterControl, filterColumn:FlexDataGridColumn, item:Object, flatDp:Object, level:FlexDataGridColumnLevel):void

Given a filter control, initializes it from the provided column

Parameters

	`filterRenderer:IFilterControl` — The filtercontrol

	`filterColumn:FlexDataGridColumn` — The column to initialize the control with

	`item:Object` — The item (only required for inner level filters)

	`flatDp:Object` — The dataprovider

	`level:FlexDataGridColumnLevel` — The level against which to initialize the filter.

invalidateCells

()

method

public function invalidateCells():void

Calls invalidateBackground() on each of the cells.

invalidateDisplayList

()

method

override public function invalidateDisplayList():void

isCoveredByColSpan

()

method

public function isCoveredByColSpan(cell:IFlexDataGridCell):Boolean

Given a cell, returns true if the cell is "hidden" by another cell that has a col span which will cover this cell.

Parameters

cell:IFlexDataGridCell — The cell to check

Returns

Boolean

isCoveredByRowSpan

()

method

public function isCoveredByRowSpan(cell:IFlexDataGridCell):Boolean

Given a cell, returns true if the cell is "hidden" by another cell that has a row span which will cover this cell.

Parameters

cell:IFlexDataGridCell — The cell to check

Returns

Boolean

isCoveredByRowSpanOrColspan

()

method

protected function isCoveredByRowSpanOrColspan(cell:IFlexDataGridCell):Boolean

Parameters

cell:IFlexDataGridCell

Returns

Boolean

isHoverableCell

()

method

public function isHoverableCell(cell:IFlexDataGridCell):Boolean

Can this cell accept hover. Returns true if (cell is IFlexDataGridDataCell or cell is FlexDataGridHeaderCell or cell is FlexDataGridFooterCell or cell is FlexDataGridFilterCell or cell is FlexDataGridPagerCell or cell is FlexDataGridLevelRendererCell or cell is FlexDataGridExpandCollapseCell or cell is FlexDataGridColumnGroupCell) and cell.enabled and not cell is FlexDataGridExpandCollapseHeaderCell

Parameters

cell:IFlexDataGridCell

Returns

Boolean

isOutOfVisibleArea

()

method

public function isOutOfVisibleArea(row:RowInfo):Boolean

Abstract

Parameters

row:RowInfo

Returns

Boolean

onCellMouseClick

()

method

protected function onCellMouseClick(event:MouseEvent):void

Handles mouse click. Ensures we're not on the resize area, and ends the active edit, if any, before calling the default click handler.

Parameters

event:MouseEvent

onCellMouseOver

()

method

protected function onCellMouseOver(event:MouseEvent):void

Handles Cell Mouse Over. If header cell is moving, draws the header drop indicator.

Parameters

event:MouseEvent

onEditorKeyDown

()

method

protected function onEditorKeyDown(event:KeyboardEvent):void

Handles the KeyDown on the Editor Component. If Escape, ends edit, if Enter or Tab, commmits the value, and moves on to the next cell if Tab. Next Row if Enter. If next Row or next cell belongs to a section that is not yet drawn, draws it and attempts to focus into the next editor.

Parameters

event:KeyboardEvent

onHeaderCellClicked

()

method

 public function onHeaderCellClicked(cell:FlexDataGridHeaderCell, triggerEvent:Event, isMsc:Boolean = false, useMsc:Boolean = true, direction:String = null):void

Parameters

	`cell:FlexDataGridHeaderCell`

	`triggerEvent:Event`

	`isMsc:Boolean` (default = `false`)

	`useMsc:Boolean` (default = `true`)

	`direction:String` (default = `null`)

onItemClickTimer

()

method

protected function onItemClickTimer(event:TimerEvent):void

Parameters

event:TimerEvent

onMouseMove

()

method

protected function onMouseMove(event:MouseEvent):void

Parameters

event:MouseEvent

onSelectAllChanged

()

method

protected function onSelectAllChanged(event:Event):void

Parameters

event:Event

placeSortIcon

()

method

protected function placeSortIcon(event:Event):void

Parameters

event:Event

populateValue

()

method

public function populateValue(event:Event, itemEditor:UIComponent = null):Boolean

Applies the value from the editor back to the model object. Dispatches ITEM_EDIT_VALUE_COMMIT

Parameters

	`event:Event`

	`itemEditor:UIComponent` (default = `null`)

Returns

Boolean

reDraw

()

method

public function reDraw():void

Calls removeAllComponents, createComponents, validateNow, and snapToColumnWidths

refreshCells

()

method

public function refreshCells():void

Re-evaluates all the visible cell contents.

refreshCheckBoxes

()

method

public function refreshCheckBoxes():void

removeAllComponents

()

method

public function removeAllComponents(recycle:Boolean):void

End the edit, if active, call removeComponent on each of the rows, and remove all the children.

Parameters

recycle:Boolean

removeComponent

()

method

protected function removeComponent(comp:ComponentInfo):void

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.

Parameters

comp:ComponentInfo

removeComponents

()

method

protected function removeComponents(row:RowInfo):void

Iterates through all rows and calls removeComponent on each of the cells. Removes event listeners added to the RowInfo object

Parameters

row:RowInfo

scrollToExistingRow

()

method

public function scrollToExistingRow(vsp:Number, scrollDown:Boolean):void

Abstract

Parameters

	`vsp:Number`

	`scrollDown:Boolean`

selectAllChangedHandler

()

method

protected function selectAllChangedHandler(event:Event):void

Parameters

event:Event

setCurrentCellToFirst

()

method

public function setCurrentCellToFirst():void

Sets the current highlight cell to the first available cell.

snapRowToColumnWidth

()

method

protected function snapRowToColumnWidth(row:RowInfo):void

Parameters

row:RowInfo

sortByCell

()

method

protected function sortByCell(cell:FlexDataGridHeaderCell):void

Parameters

cell:FlexDataGridHeaderCell

sortByColumn

()

method

public function sortByColumn(col:FlexDataGridColumn, direction:String = null):void

Parameters

	`col:FlexDataGridColumn`

	`direction:String` (default = `null`)

storeSort

()

method

protected function storeSort(item:Object, column:FlexDataGridColumn, ascending:Boolean):void

Parameters

	`item:Object`

	`column:FlexDataGridColumn`

	`ascending:Boolean`

updateDisplayList

()

method

override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

	`unscaledWidth:Number`

	`unscaledHeight:Number`

Event Detail

columnsResized

Event

Event Object Type: com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

Dispatched when the columns at any level are resized.

headerClicked

Event

Event Object Type: com.flexicious.nestedtreedatagrid.events.FlexDataGridEvent

Dispatched when the header cells are clicked

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
FlexDataGridContainerBase	Properties \| Methods \| Events

Package	com.flexicious.nestedtreedatagrid
Class	public class FlexDataGridContainerBase
Inheritance	FlexDataGridContainerBase mx.core.Container
Subclasses	FlexDataGridBodyContainer, FlexDataGridHeaderContainer