com.flexicious.nestedtreedatagrid.cells.CellUtils

	Method	Defined By
		capitalizeFirstLetterIfPrefix(prefix:String, val:String):String [static] If there is a value for the prefix parameter, capitalizes the first word of the val parameter and returns it	CellUtils
		doCap(val:String):String [static] Capitalizes the first character of the passed in string.	CellUtils
		drawBackground(cell:IFlexDataGridCell):void [static] Draws the background as well as calls drawBorder on the given cell Each cell in Ultimate will draw its own background and border.	CellUtils
		drawBorders(cell:IFlexDataGridCell):void [static] Draws the borders of the given cell.	CellUtils
		drawRightBorder(cell:IFlexDataGridCell):void [static] Draws the right border for this cell.	CellUtils
		getBackgroundColorFromGrid(cell:IFlexDataGridCell):* [static] If a value is defined for grid.cellBackgroundColorFunction, returns the result of that function else returns null.	CellUtils
		getBackgroundColors(cell:IFlexDataGridCell):* [static] The getBackgroundColors method is responsible for evaluating the background color of the cell.	CellUtils
		getBackGroundColorString(cell:IFlexDataGridCell):String [static] If the cell.backgroundColors is an array, returns a string join using a comma.	CellUtils
		getRolloverColor(cell:IFlexDataGridCell, prop:String):* [static] If this is a fillRow, returns the value of the color property.	CellUtils
		getStyleValue(cell:IFlexDataGridCell, styleProp:String):* [static] Returns the value of the given style property based on the following logic: If there is a column associated with this cell, and there is a property in the styleOverrides collection of the column with styleProp name, returns the value of that property from styleOverrides If there is a column, calls the getStyleValue method on that column (which checkes to see if a there is a value for this style property in the column, return that, else if in the level, return that, else if in the grid, return that).	CellUtils
		getTextColorFromGrid(cell:IFlexDataGridCell):* [static] If a value is defined for grid.cellTextColorFunction, returns the result of that function else returns null.	CellUtils
		getTextColors(cell:IFlexDataGridCell):* [static] The getTextColors method is responsible for evaluating the text color of the cell.	CellUtils
		initializeCheckBoxRenderer(cell:IFlexDataGridCell, level:FlexDataGridColumnLevel):void [static] This method is responsible for initializing the checkbox renderer for both the header and data cells.	CellUtils
		refreshCell(cell:IFlexDataGridCell):void [static]	CellUtils
		setRendererSize(cellRenderer:DisplayObject, w:Number, h:Number):void [static] Given a renderer, sets the size on basis of whether or not there are vertical and horizotnal gridlines .	CellUtils

Method Detail

capitalizeFirstLetterIfPrefix

()

method

public static function capitalizeFirstLetterIfPrefix(prefix:String, val:String):String

If there is a value for the prefix parameter, capitalizes the first word of the val parameter and returns it

Parameters

	`prefix:String`

	`val:String`

Returns

String

doCap

()

method

public static function doCap(val:String):String

Capitalizes the first character of the passed in string.

Parameters

val:String

Returns

String

drawBackground

()

method

public static function drawBackground(cell:IFlexDataGridCell):void

Draws the background as well as calls drawBorder on the given cell Each cell in Ultimate will draw its own background and border. This method will use the evaluated results of a number of properties on the cell object to calculate the color, width, and visibility of the background associated with this cell.

First, this method will check to see if you have defined a cellCustomBackgroundDrawFunction for the associated column or level. If so, it will call this method, with the cell as a parameter. You can draw a custom background in this function. If you return false, from this function, this method will not execute any other code, and simply call the drawBorders method
First, this method will check to see if you have defined a cellCustomBackgroundDrawFunction for the associated column or level. If so, it will call this method, with the cell as a parameter. You can draw a custom background in this function. If you return false, from this function, this method will not execute any other code, and simply call the drawBorders method

Parameters

cell:IFlexDataGridCell

drawBorders

()

method

public static function drawBorders(cell:IFlexDataGridCell):void

Draws the borders of the given cell. Each cell in Ultimate will draw its own background and border. This method will use the evaluated results of a number of properties on the cell object to calculate the color, width, and visibility of the border associated with this cell.

First, it checks to see if the grid.hasErrors evaluates to true. If it does, the nit checks to see if the cell.rowInfo.data object associated with this cell is within the error collection. If so, it will use the result of the errorBorderColor style property to figure out the color of the border for this cell.
Next, it checks to see if there is a cellBorderFunction defined. If there is one, it will just pass the cell to the given cellBorderFunction and if this function returns false, this method performs no additional processing and returns.
Next, if the cell's hasHorizontalGridLines evaulates to true, this method then uses the results of horizontalGridLineThickness, horizontalGridLineColor property to draw a bottomn border
Next, if the cell's drawTopBorder evaulates to true, this method then uses the results of horizontalGridLineThickness, horizontalGridLineColor property to draw a top border.
Finally, it calls the drawRightBorder method on the cell.

Parameters

cell:IFlexDataGridCell

drawRightBorder

()

method

public static function drawRightBorder(cell:IFlexDataGridCell):void

Draws the right border for this cell. There are a few rules on basis of which a right (or a left) border is drawn on a cell.

First, if the cell is a Pager cell, no right border is drawn, since the pager shares its left and right border with the grid.
Second, if the cell has no vertical gridlines, no border is drawn.
Else, if the cell has a column and its right locked, then a left border is drawn.

Parameters

cell:IFlexDataGridCell

getBackgroundColorFromGrid

()

method

public static function getBackgroundColorFromGrid(cell:IFlexDataGridCell):*

If a value is defined for grid.cellBackgroundColorFunction, returns the result of that function else returns null.

Parameters

cell:IFlexDataGridCell

Returns

*

getBackgroundColors

()

method

public static function getBackgroundColors(cell:IFlexDataGridCell):*

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.

Parameters

cell:IFlexDataGridCell

Returns

*

getBackGroundColorString

()

method

public static function getBackGroundColorString(cell:IFlexDataGridCell):String

If the cell.backgroundColors is an array, returns a string join using a comma. Else, returns the result of ExtendedUIUtils.getColorName on it.

Parameters

cell:IFlexDataGridCell

Returns

String

getRolloverColor

()

method

public static function getRolloverColor(cell:IFlexDataGridCell, prop:String):*

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

Parameters

	`cell:IFlexDataGridCell`

	`prop:String`

Returns

*

getStyleValue

()

method

public static function getStyleValue(cell:IFlexDataGridCell, styleProp:String):*

Returns the value of the given style property based on the following logic:

If there is a column associated with this cell, and there is a property in the styleOverrides collection of the column with styleProp name, returns the value of that property from styleOverrides
If there is a column, calls the getStyleValue method on that column (which checkes to see if a there is a value for this style property in the column, return that, else if in the level, return that, else if in the grid, return that). The idea being that you can define a property at the highest possible container (the grid) or one below (at the level) or one below (at the column)

Parameters

	`cell:IFlexDataGridCell`

	`styleProp:String`

Returns

*

getTextColorFromGrid

()

method

public static function getTextColorFromGrid(cell:IFlexDataGridCell):*

If a value is defined for grid.cellTextColorFunction, returns the result of that function else returns null.

Parameters

cell:IFlexDataGridCell

Returns

*

getTextColors

()

method

public static function getTextColors(cell:IFlexDataGridCell):*

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.

Parameters

cell:IFlexDataGridCell

Returns

*

initializeCheckBoxRenderer

()

method

public static function initializeCheckBoxRenderer(cell:IFlexDataGridCell, level:FlexDataGridColumnLevel):void

This method is responsible for initializing the checkbox renderer for both the header and data cells. It performns the following tasks

First, it will set the radio button mode of the associated TriStateCheckBox to true if col.radioButtonMode or level.enableSingleSelect is set to true
Next, if the grid.enableSelectionExclusion flag is set to true, it will set the selected state of the associated TriStateCheckBox to the result of the getCheckBoxStateBasedOnExclusion method of the level
Next, if the grid.enableSelectionExclusion flag is set to false (default), it will set the selected state of the associated TriStateCheckBox based upon the following logic (if enableTriStateCheckBox=true):
- If the associated rowData object is in the selected objects collection of the level, sets it to checked
- If any of the children the associated rowData object are selected, sets it to middle
- Else sets it to unchecked
Finally, if the enableLabelAndCheckBox flag is set to true on the column, this method will apply the result of the columns itemToLabel function to the label property of the checkbox

Parameters

	`cell:IFlexDataGridCell`

	`level:FlexDataGridColumnLevel`

refreshCell

()

method

public static function refreshCell(cell:IFlexDataGridCell):void

Parameters

cell:IFlexDataGridCell

setRendererSize

()

method

public static function setRendererSize(cellRenderer:DisplayObject, w:Number, h:Number):void

Given a renderer, sets the size on basis of whether or not there are vertical and horizotnal gridlines . If there are vertical gridlines, sets the width to width minus verticalGridLineThickness If there are vertical gridlines, sets the height to width minus horizontalGridLineThickness

Parameters

	`cellRenderer:DisplayObject`

	`w:Number`

	`h:Number`

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

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
CellUtils	Methods

Package	com.flexicious.nestedtreedatagrid.cells
Class	public class CellUtils
Inheritance	CellUtils Object