com.flexicious.nestedtreedatagrid.FlexDataGridHeaderContainer

	Property	Defined By
		chromeType : int = 1 The type of this container.	FlexDataGridHeaderContainer
		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
		maxHorizontalScrollPosition : Number [override] [read-only]	FlexDataGridHeaderContainer
		rows : ArrayCollection Collection of RowInfo objects currently being displayed.	FlexDataGridContainerBase
		width : Number [override] [write-only]	FlexDataGridHeaderContainer
		y : Number [override] [write-only]	FlexDataGridHeaderContainer

	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

Public Methods

	Method		Defined By
		FlexDataGridHeaderContainer(grid:FlexDataGrid)	FlexDataGridHeaderContainer
		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
		getFilterArguments():ArrayCollection eturns the filter at the top level.	FlexDataGridHeaderContainer
		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
		getPager():IExtendedPager	FlexDataGridHeaderContainer
		getPagerCell():ComponentInfo	FlexDataGridHeaderContainer
		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
		move(x:Number, y:Number):void [override]	FlexDataGridHeaderContainer
		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
		setFilterFocus(fld:String):Boolean Sets the filter at the top level.	FlexDataGridHeaderContainer
		setFilterValue(col:String, val:Object):void Sets the filter value at the top level for the specified field	FlexDataGridHeaderContainer
		sortByColumn(col:FlexDataGridColumn, direction:String = null):void	FlexDataGridContainerBase

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		addCell(component:DisplayObject, row:RowInfo, existingComponent:ComponentInfo = null):ComponentAdditionResult [override]	FlexDataGridHeaderContainer
		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 [override]	FlexDataGridHeaderContainer
		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
		onCellDropMouseMove(event:MouseEvent):void [override]	FlexDataGridHeaderContainer
		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
		onFilterChange(event:FilterPageSortChangeEvent):void [override]	FlexDataGridHeaderContainer
		onItemClickTimer(event:TimerEvent):void	FlexDataGridContainerBase
		onMouseMove(event:MouseEvent):void	FlexDataGridContainerBase
		onSelectAllChanged(event:Event):void	FlexDataGridContainerBase
		onWidthChanged(event:Event):void	FlexDataGridHeaderContainer
		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
		rootPageChange(event:Event):void [override]	FlexDataGridHeaderContainer
		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

chromeType

property

public var chromeType:int = 1

The type of this container. Can be one of:

ROW_TYPE_HEADER
ROW_TYPE_FOOTER
ROW_TYPE_PAGER
ROW_TYPE_FILTER
ROW_TYPE_DATA
ROW_TYPE_FILL
ROW_TYPE_RENDERER
ROW_TYPE_COLUMN_GROUP

maxHorizontalScrollPosition

property

maxHorizontalScrollPosition:Number [read-only] [override]

Implementation
public function get maxHorizontalScrollPosition():Number

width

property

width:Number [write-only] [override]

Implementation
public function set width(value:Number):void

property

y:Number [write-only] [override]

Implementation
public function set y(value:Number):void

Constructor Detail

FlexDataGridHeaderContainer

()

Constructor

public function FlexDataGridHeaderContainer(grid:FlexDataGrid)

Parameters

grid:FlexDataGrid

Method Detail

addCell

()

method

override protected function addCell(component:DisplayObject, row:RowInfo, existingComponent:ComponentInfo = null):ComponentAdditionResult

Parameters

	`component:DisplayObject`

	`row:RowInfo`

	`existingComponent:ComponentInfo` (default = `null`)

Returns

ComponentAdditionResult

getFilterArguments

()

method

public function getFilterArguments():ArrayCollection

eturns the filter at the top level.

Returns

ArrayCollection

getPager

()

method

public function getPager():IExtendedPager

Returns

IExtendedPager

getPagerCell

()

method

public function getPagerCell():ComponentInfo

Returns

ComponentInfo

getRowsForRecycling

()

method

override protected function getRowsForRecycling():Object

Returns

Object

move

()

method

override public function move(x:Number, y:Number):void

Parameters

	`x:Number`

	`y:Number`

onCellDropMouseMove

()

method

override protected function onCellDropMouseMove(event:MouseEvent):void

Parameters

event:MouseEvent

onFilterChange

()

method

override protected function onFilterChange(event:FilterPageSortChangeEvent):void

Parameters

event:FilterPageSortChangeEvent

onWidthChanged

()

method

protected function onWidthChanged(event:Event):void

Parameters

event:Event

rootPageChange

()

method

override protected function rootPageChange(event:Event):void

Parameters

event:Event

setFilterFocus

()

method

public function setFilterFocus(fld:String):Boolean

Sets the filter at the top level.

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(col:String, val:Object):void

Sets the filter value at the top level for the specified field

Parameters

	`col:String`

	`val:Object`

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

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

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