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

public class | source

FlexDataGridHeaderContainer

Extends:

react~React.Component → EventDispatcher → UIComponent → FlexDataGridContainerBase → FlexDataGridHeaderContainer

The container for header, footer, filter and pager sections of the top level. These rows are locked so they stay in place, i.e, they do not scroll when the user scrolls vertically.

When the user scrolls horizontally, these rows will scroll.

Constructor Summary

Public Constructor
public	constructor(grid: *)

Member Summary

Public Members
public	chromeType: * The type of this container.
public	horizontalScrollPolicy: String
public	verticalScrollPolicy: String

Method Summary

Public Methods
public	addCell(component: , row: flexiciousNmsp.RowInfo, existingComponent: flexiciousNmsp.ComponentInfo):
public	createComponents(level: flexiciousNmsp.FlexDataGridColumnLevel, currentScroll: number, flat: object)
public	getClassNames(): string[]
public	getFilterArguments(): Array Returns the filter at the top level.
public	getMaxHorizontalScrollPosition(): number
public	getPager(): flexiciousNmsp.FlexDataGridPagerCell
public	getPagerCell(): flexiciousNmsp.FlexDataGridPagerCell
public	getRowsForRecycling(): Array
public	getScrollableRect(): flexiciousNmsp.Rectangle
public	onCellDropMouseMove(event: *)
public	onFilterChange(event: *)
public	onWidthChanged(event: *)
public	rootPageChange(event: *)
public	setFilterFocus(fld: String): boolean Sets the filter at the top level.
public	setFilterValue(col: , val: ) Sets the filter value at the top level for the specified field
public	setWidth(value: number)
public	setWidth(w: number)

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)

Public Constructors

public constructor(grid: *) source

Override:

FlexDataGridContainerBase#constructor

Params:

Name	Type	Attribute	Description
grid	*

Public Members

public chromeType: * source

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

public horizontalScrollPolicy: String source

Override:

UIComponent#horizontalScrollPolicy

Properties:

Name	Type	Attribute	Description
horizontalScrollPolicy	*

public verticalScrollPolicy: String source

Override:

UIComponent#verticalScrollPolicy

Properties:

Name	Type	Attribute	Description
verticalScrollPolicy	*

Public Methods

public addCell(component: , row: flexiciousNmsp.RowInfo, existingComponent: flexiciousNmsp.ComponentInfo): source

Override:

FlexDataGridContainerBase#addCell

Params:

Name	Type	Attribute	Description
component	*
row	flexiciousNmsp.RowInfo
existingComponent	flexiciousNmsp.ComponentInfo

Return:

public createComponents(level: flexiciousNmsp.FlexDataGridColumnLevel, currentScroll: number, flat: object) source

Override:

FlexDataGridContainerBase#createComponents

Params:

Name	Type	Attribute	Description
level	flexiciousNmsp.FlexDataGridColumnLevel
currentScroll	number
flat	object

public getClassNames(): string[] source

Override:

FlexDataGridContainerBase#getClassNames

Return:

string[]

public getFilterArguments(): Array source

Returns the filter at the top level.

Return:

Array

public getMaxHorizontalScrollPosition(): number source

Return:

number

public getPager(): flexiciousNmsp.FlexDataGridPagerCell source

Return:

flexiciousNmsp.FlexDataGridPagerCell

public getPagerCell(): flexiciousNmsp.FlexDataGridPagerCell source

Return:

flexiciousNmsp.FlexDataGridPagerCell

public getRowsForRecycling(): Array source

Override:

FlexDataGridContainerBase#getRowsForRecycling

Return:

Array

public getScrollableRect(): flexiciousNmsp.Rectangle source

Return:

flexiciousNmsp.Rectangle

public onCellDropMouseMove(event: *) source

Override:

FlexDataGridContainerBase#onCellDropMouseMove

Params:

Name	Type	Attribute	Description
event	*

public onFilterChange(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public onWidthChanged(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public rootPageChange(event: *) source

Override:

FlexDataGridContainerBase#rootPageChange

Params:

Name	Type	Attribute	Description
event	*

public setFilterFocus(fld: String): boolean source

Sets the filter at the top level.

Params:

Name	Type	Attribute	Description
fld	String		The string to match the searchField property of the filter control with.

Return:

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.

public setFilterValue(col: , val: ) source

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

Params:

Name	Type	Attribute	Description
col	*
val	*

public setWidth(value: number) source

Override:

UIComponent#setWidth

Params:

Name	Type	Attribute	Description
value	number

public setWidth(w: number) source

Override:

UIComponent#setWidth

Params:

Name	Type	Attribute	Description
w	number		width

FlexDataGridHeaderContainer

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(grid: *) source

Override:

Params:

Public Members

public chromeType: * source

public horizontalScrollPolicy: String source

Override:

Properties:

public verticalScrollPolicy: String source

Override:

Properties:

Public Methods

public addCell(component: *, row: flexiciousNmsp.RowInfo, existingComponent: flexiciousNmsp.ComponentInfo): * source

Override:

Params:

Return:

public createComponents(level: flexiciousNmsp.FlexDataGridColumnLevel, currentScroll: number, flat: object) source

Override:

Params:

public getClassNames(): string[] source

Override:

Return:

public getFilterArguments(): Array source

Return:

public getMaxHorizontalScrollPosition(): number source

Return:

public getPager(): flexiciousNmsp.FlexDataGridPagerCell source

Return:

public getPagerCell(): flexiciousNmsp.FlexDataGridPagerCell source

Return:

public getRowsForRecycling(): Array source

Override:

Return:

public getScrollableRect(): flexiciousNmsp.Rectangle source

Return:

public onCellDropMouseMove(event: *) source

Override:

Params:

public onFilterChange(event: *) source

Params:

public onWidthChanged(event: *) source

Params:

public rootPageChange(event: *) source

Override:

Params:

public setFilterFocus(fld: String): boolean source

Params:

Return:

public setFilterValue(col: *, val: *) source

Params:

public setWidth(value: number) source

Override:

Params:

public setWidth(w: number) source

Override:

Params:

public addCell(component: , row: flexiciousNmsp.RowInfo, existingComponent: flexiciousNmsp.ComponentInfo): source

public setFilterValue(col: , val: ) source