import FlexDataGridColumnGroupCell from 'flexicious-react-datagrid/js/flexgrid/cells/FlexDataGridColumnGroupCell.js'

public class | source

FlexDataGridColumnGroupCell

Extends:

react~React.Component → EventDispatcher → UIComponent → FlexDataGridCell → FlexDataGridColumnGroupCell

A container class for all column group cells. In addition to the functionality it inherits from FlexDataGridCell, it adds support for the following feautres:

Ability to span across multiple columns to visually appear as a single column header

FlexDataGridColumnGroupCell inherits from FlexDataGridCell, which provides a bulk of the functionality to it.

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	background: Boolean
public	columnGroup: FlexDataGridColumnGroup

Method Summary

Public Methods
public	destroy() Destroy function.
public	getBackgroundColors(): String
public	getClassNames(): Array
public	getColumn(): * If there is a columnGroup associated, returns its startColumn property.
public	getColumnGroupIcon(): DisplayObject
public	getDrawTopBorder(): * \| Boolean \| Boolean \| Boolean \| *
public	getPrefix(): String
public	getRolloverColor(): String
public	getTextColors(): String
public	invalidateWX(event: *) handle the invalidateWX.
public	onColumnsResized(event: *) handles columns Resize event.
public	refreshCell() handles the refreshing the contents of a cell.
public	updateDisplayList(unscaledWidth: , unscaledHeight: )

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 FlexDataGridCell
public	backgroundDirty: Boolean A number of operations can cause the cells text and background colors to change.
public	children: *[]
public	colIcon: Image When column.enableIcon=true, this is the icon that will be associated with the cell.
public	column: *
public	componentInfo: ComponentInfo The component info that holds this cell in the cells collection of the associated rowInfo object.
public	currentBackgroundColors: * This property stores the temporary value of a cells background color when the user hovers over it.
public	currentTextColors: Array This property stores the temporary value of a cells text color when the user hovers over it.
public	destroyed: Boolean Once a grid is rendered, each cell in the grid is shown in the UI.
public	expandCollapseIcon: ExpandCollapseIcon In 2.7, ability was added to have any cell be a expand collapse cell.
public	iconBottom: Number
public	iconLeft: Number
public	iconRight: Number
public	iconTop: Number
public	level: FlexDataGridColumnLevel The FlexDataGridColumnLevel associated with this cell.
public	moving: Boolean Used by header cells and column group cells for drag drop move.
public	previouslyAttached: *
public	rowInfo: RowInfo The rowInfo object associated with this cell.
public	showInAutomationHierarchy: Boolean
public	attachUserClass(className: *)
public	capitalizeFirstLetterIfPrefix(val: *): String If there is a value for the prefix parameter, capitalizes the first word of the val parameter and returns it
public	createColumnIcon()
public	destroy() destroy function.
public	drawBackground(unscaledWidth: , unscaledHeight: ) Draws the background as well as calls drawBorder on the given cell
public	drawCell(unscaledWidth: , unscaledHeight: ) Draws the background as well as calls drawBorder on the given cell
public	drawRightBorder(unscaledWidth: , unscaledHeight: ): * Draws the right border for this cell.
public	getBackgroundColorString(): String If the cell.backgroundColors is an array, returns a string join using a comma.
public	getBackgroundColors(): String The getBackgroundColors method is responsible for evaluating the background color of the cell.
public	getCheckBoxState(): string If column is a checkbox column, returns the current state of the checkbox renderer
public	getClassNames(): string[]
public	getColumn(): FlexDataGridColumn The FlexDataGridColumn associated with this cell.
public	getDrawTopBorder(): Boolean Calculated property that controls whether or not to draw the top border.
public	getGrid(): FlexDataGrid The FlexDataGrid associated with this cell.
public	getHorizontalGridLineColor(): String What color to use to draw the horizontal grid lines for this cell.
public	getHorizontalGridLineThickness(): Number What thickness to use to draw the horizontal grid lines for this cell.
public	getIExpandCollapseComponent(): IExpandCollapseComponent
public	getIconUrl(over: *): String
public	getIsChromeCell(): Boolean The "Chrome" is defined as header,footer,pager,filter sections.
public	getIsContentArea(): * \| Boolean Returns true if we are a data cell or if we area a chrome cell at a nest depth of greater than 1.
public	getIsDataCell(): Boolean Returns true if the rowInfo object associated with this cell is of type RowPositionInfo.ROW_TYPE_DATA.
public	getIsElastic(): Boolean Returns true if this cell is not right locked or not fixed width.
public	getIsExpandCollapseCell(): Boolean Calcualted property that returns if this cell is a expand collapse cell.
public	getIsLeftLocked(): Boolean Returns true if the column associated with this cell has columnLockMode="left"
public	getIsLocked(): Boolean Returns true if the column associated with this cell has columnLockMode="left" or columnLockMode="right"
public	getIsNewlyCreated(): Boolean When a cell is created for the first time, this flag is set to true.
public	getIsRightLocked(): boolean Returns true if the column associated with this cell has columnLockMode="right"
public	getLeftPadding(): Number
public	getLevel(): FlexDataGridColumnLevel The FlexDataGridColumnLevel associated with this cell.
public	getLevel(): FlexDataGridColumnLevel The FlexDataGridColumnLevel associated with this cell.
public	getNestDepth(): * \| Number Returns the nestpDepth property of the associated level, if it is not null.
public	getPerceivedX(): Number The X Position of this cell, as the user sees it.
public	getPrefix(): string Returns one of the following values on basis of what type of cell this is: Blank string for data cells header footer filter columnGroup pager
public	getRenderer(): DisplayObject The actual renderer component that displays the value of the cell.
public	getRendererFactory(): IFactory The factory class used for initializing the cell.
public	getRolloverColor(): String If this is a fillRow, returns the value of the color property.
public	getRolloverTextColor(): String Returns the value of the textRollOverColor style property.
public	getRowInfo(): RowInfo The rowInfo object associated with this cell.
public	getStyleValue(styleProp: ):
public	getText(): String This is the actual text to display in the cell.
public	getTextColors(): String The getTextColors method is responsible for evaluating the text color of the cell.
public	getVerticalGridLineColor(): String What color to use to draw the vertical grid lines for this cell.
public	getVerticalGridLineThickness(): Number What thickness to use to draw the horizontal grid lines for this cell.
public	getWordWrap(): Boolean This flag is a used for enabling the wordWrap on the associated renderer.
public	globalToLocal(ptIn: *): flexiciousNmsp.Point Converts the given global Point to local co-ordinates.
public	hasHorizontalGridLines(): Boolean Returns true if the style property for horizontalGridLines is defined for the type of the row.
public	hasVerticalGridLines(): Boolean Returns true if the style property for verticalGridLines is defined for the type of the row.
public	initializeCheckBoxRenderer(renderer: ): This method is responsible for initializing the checkbox renderer for both the header and data cells.
public	invalidateBackground() Marks the cell so that the background and borders are drawn in the next validation cycle.
public	kill() Clean up this cell
public	onCheckChange(event: *)
public	onIconMouseClick(evt: *) when the icon is enables, handles the mouse click event of the icon.
public	onIconMouseOut(evnt: *) when the icon is enables, handles the mouse out event of the icon.
public	onIconMouseOver(evnt: *) when the icon is enables, handles the mouse over event of the icon.
public	onTimerComplete(evt: *) Once the timer completed its time, the final result will be renderered such as showing shooltips or dispatching some events.
public	placeComponent(cellRenderer: , unscaledWidth: , unscaledHeight: , usePadding: ): * This method will size and place the renderer within the bounds of this cell.
public	placeExpandCollapseIcon() setting the position of ExpandCollapseIcon.
public	placeIcon() setting the correct position of the Icon.
public	refreshCell() Used to refresh the contents of a Cell.
public	setActualSize(w: , h: ) To set the actualsize value using width and height values.
public	setColumn(value: *) The FlexDataGridColumnLevel associated with this cell.
public	setEnabled(val: *) Is this enabled cell
public	setHeight(value: *)
public	setRendererFactory(value: *) The factory class used for initializing the cell.
public	setRendererSize(cellRenderer: , w: , h: *) Given a renderer, sets the size on basis of whether or not there are vertical and horizotnal gridlines .
public	setSelectable(val: *)
public	setText(val: *) This is the actual text to display in the cell.
public	setTruncateToFit(val: *)
public	setWidth(value: *) Setting the width.
public	setWordWrap(val: *) This flag is a used for enabling the wordWrap on the associated renderer.
public	updateDisplayList(w: , h: )

Public Constructors

public constructor() source

Override:

FlexDataGridCell#constructor

Public Members

public background: Boolean source

Properties:

Name	Type	Attribute	Description
background	*

public columnGroup: FlexDataGridColumnGroup source

Properties:

Name	Type	Attribute	Description
columnGroup	*

Public Methods

public destroy() source

Destroy function.

Override:

FlexDataGridCell#destroy

public getBackgroundColors(): String source

The getBackgroundColors method is responsible for evaluating the background color of the cell.

First, it checks to see if this is a filler row. If so, it will use the alternatingItemColors array and return its 0th or 1st index based upton the rowInfo.rowPositionInfo.rowIndex.

Next, it checks to see if the cell is disabled. If so, it will return the value of the selectionDisabledColor style property

Next, it checks to see if there is a custom cellBackgroundColorFunction on the column and if so, it returns the result of this function

Next, it checks to see if there is a custom rowBackgroundColorFunction on the level and if so, it returns the result of this function

Next, it checks to see if there rowInfo's data object is in the errors collection of the grid, and if so, it return the value of the errorBackgroundColor property.

Next, it checks to see if there enableEditRowHighlight is true amd this row is in edit mode, then it returns the value of the editItemColors style property.

Next, it checks to see if there is a value for the currentBackgroundColors property (based upon rollover) and if so returns that. The currentBackgroundColors property is a result of the grid.highlightRow method.

If enableActiveCellHighlight=true uses the value of the activeCellColor style.

Else, uses the value of the rollOverColor style property.

Next, it checks to see if the row is selected (row selection mode) or cell is selected (cell selection mode) and if so, returns selectionColor property.

Next, it checks to see if a backgroundColor property is specified on the associated column and if so, returns the value of this property.

Finally, it uses the alternatingItemColors array and return its 0th or 1st index based upton the rowInfo.rowPositionInfo.rowIndex.

Getting the BackgroundColors of a FlexDataGridCell

Override:

FlexDataGridCell#getBackgroundColors

Return:

String

public getClassNames(): Array source

Override:

FlexDataGridCell#getClassNames

Return:

Array

public getColumn(): * source

If there is a columnGroup associated, returns its startColumn property. Else returns the default column associated with this cell.

Override:

FlexDataGridCell#getColumn

Return:

public getColumnGroupIcon(): DisplayObject source

Return:

DisplayObject

public getDrawTopBorder(): * | Boolean | Boolean | Boolean | * source

Calculated property that controls whether or not to draw the top border. Each cell in Ultimate will draw its own background and border. In order to prevent cells from drawing double borders (cell above me drew bottom border, so I should not need to draw my top border), this flag evaluates to false. But in certain cases, you may want to draw both top and bottom border. The bottom border is always controlled by the horizontalGridLines style property. The top border is controlled by the drawTopBorder style property. In order to provide fine grained control over border drawing functionality, there are the following style properties available.

drawTopBorder
headerDrawTopBorder
footerDrawTopBorder
pagerDrawTopBorder
filterDrawTopBorder
columnGroupDrawTopBorder

To control the bottom border, the following properties are available:

horizontalGridLines
headerHorizontalGridLines
footerHorizontalGridLines
pagerHorizontalGridLines
filterHorizontalGridLines
columnGroupHorizontalGridLines

Override:

FlexDataGridCell#getDrawTopBorder

Return:

* | Boolean | Boolean | Boolean | *

public getPrefix(): String source

Returns one of the following values on basis of what type of cell this is:

Blank string for data cells
header
footer
filter
columnGroup
pager

Override:

FlexDataGridCell#getPrefix

Return:

String

public getRolloverColor(): String source

If this is a fillRow, returns the value of the color property. Else, returns the value of the "prop" property which is the value of one of the following style properties:

rollOverColors

headerRollOverColors

footerRollOverColors

filterRollOverColors

pagerRollOverColors

columnGroupRollOverColors

Getting the Roll Over Color Of a FlexDataGridCell

Override:

FlexDataGridCell#getRolloverColor

Return:

String

public getTextColors(): String source

The getTextColors method is responsible for evaluating the text color of the cell.

First, it checks to see if the cell is disabled. If so, it will return the value of the textDisabledColor style property

Next, it checks to see if there is a value for the currentTextColors property (based upon rollover) and if so returns that.

Next, it checks to see if there is a custom cellTextColorFunction on the column and if so, it returns the result of this function

Next, it checks to see if there is a custom rowTextColorFunction on the level and if so, it returns the result of this function

Next, it checks to see if there enableEditRowHighlight is true amd this row is in edit mode, then it returns the value of the editTextColor style property.

Next, it checks to see if the row is selected (row selection mode) or cell is selected (cell selection mode) and if so, returns textSelectedColor property.

Next, it checks to see if a columnTextColor property is specified on the associated column and if so, returns the value of this property.

Finally, it uses the alternatingTextColors array and return its 0th or 1st index based upton the rowInfo.rowPositionInfo.rowIndex.

Getting the TextColors of a FlexDataGridCell

Override:

FlexDataGridCell#getTextColors

Return:

String

public invalidateWX(event: *) source

handle the invalidateWX.

Params:

Name	Type	Attribute	Description
event	*

public onColumnsResized(event: *) source

handles columns Resize event.

Params:

Name	Type	Attribute	Description
event	*

public refreshCell() source

handles the refreshing the contents of a cell.

Override:

FlexDataGridCell#refreshCell

public updateDisplayList(unscaledWidth: , unscaledHeight: ) source

Called as a part of render phase.

Override:

FlexDataGridCell#updateDisplayList

Params:

Name	Type	Attribute	Description
unscaledWidth	*
unscaledHeight	*

FlexDataGridColumnGroupCell

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public background: Boolean source

Properties:

public columnGroup: FlexDataGridColumnGroup source

Properties:

Public Methods

public destroy() source

Override:

public getBackgroundColors(): String source

Override:

Return:

public getClassNames(): Array source

Override:

Return:

public getColumn(): * source

Override:

Return:

public getColumnGroupIcon(): DisplayObject source

Return:

public getDrawTopBorder(): * | Boolean | Boolean | Boolean | * source

Override:

Return:

public getPrefix(): String source

Override:

Return:

public getRolloverColor(): String source

Override:

Return:

public getTextColors(): String source

Override:

Return:

public invalidateWX(event: *) source

Params:

public onColumnsResized(event: *) source

Params:

public refreshCell() source

Override:

public updateDisplayList(unscaledWidth: *, unscaledHeight: *) source

Override:

Params:

public updateDisplayList(unscaledWidth: , unscaledHeight: ) source