FlexDataGridColumn

EventDispatcher#dispatchEvent

public defaultLabelFunction(col: flexiciousNmsp.FlexDataGridDataCell, dataProvider: *): String source

Checks to see the value of the columns footerOperation. The valid values for this property are sum, min, max, count and average. On basis of this , it computes the value.
It calls toFixed method passing in the footerOperationPrecision value to give it the appropriate number of decimal places
If there is a footerFormater specified, it calls the format method of the footerFormatter passing in the value and displays the result.
If there is a footerLabel specified, it will concatenate the value of the footer label to the result of the calculated value in step 3.

Params:

Name	Type	Attribute	Description
col	flexiciousNmsp.FlexDataGridDataCell
dataProvider	*

Return:

String

public deriveRenderer(chromeType: ): source

Depending on the specified chrome type, gets the appropriate renderer. If truncateToFit or selectable is true, returns a label factory else returns a text field factory.

Params:

Name	Type	Attribute	Description
chromeType	*

Return:

public dispatchEvent(event: ): source

Whenever a tree datagrid event is dispatched at any column, we also dispatch it from the level so if someone wants to listen for an event at all columns...

Override:

Params:

Name	Type	Attribute	Description
event	*

Return:

public doFormat(retVal: ): source

The doFormat method returns formatted value on basis of the format properties (See description below)
If the input is null, returns null. If there is a formatter specified, uses the formatter's format method to return a formatted value. If the format property is specified and no formatter is specified, the column will instantiate a formatter on basis of the value of the format property. The property can be one of 5 constants.

date (FORMAT_DATE) - Uses the DateUtils.MEDIUM_DATE_MASK format MMM D, YYYY - Can be customized using formatterDateString Property

datetime (FORMAT_DATE_TIME) - Uses the DateUtils.LONG_DATE_MASK+ " " + DateUtils.MEDIUM_TIME_MASK format MMM D, YYYY L:NN:SS A - Can be customized using formatterDateString Property

time (FORMAT_TIME) - Uses the DateUtils.LONG_TIME_MASK format. L:NN:SS A TZD - Can be customized using formatterDateString Property

currency (FORMAT_CURRENCY) - Uses formatterCurrencySymbol and formatterPrecision properties for the currency formatter.

number (FORMAT_NUMBER) - Uses formatterPrecision properties for the number formatter.

Based on the formatter created above, the value will be returned.

Params:

Name	Type	Attribute	Description
retVal	*		String to format

Return:

*	Formatted string.

public getAdjacentColumn(num: number): flexiciousNmsp.FlexDataGridColumn source

Params:

Name	Type	Attribute	Description
num	number

Return:

flexiciousNmsp.FlexDataGridColumn

public getClassNames(): string[] source

Override:

EventDispatcher#getClassNames

Return:

string[]

public getClickBehavior(): * source

Unused, for legacy purposes only

Return:

public getColIndex(): number source

Return:

public getColumnLockMode(): * source

In addition to the left locked and unlocked columns supported by the regular Flex DataGrid, Flexicious Ultimate supports right locked columns.
The grid supports the following selection modes:
1) LOCK_MODE_LEFT
2) LOCK_MODE_RIGHT
3) LOCK_MODE_NONE
If set to left, the column will be locked to the left and not scroll horizontally.
If set to right, the column will be locked to the right, and not scroll horizontally.
Please note, column lock modes only make sense if the horizontalScrollPolicy of the grid is set to "on" or "auto", since if there is no horizontal scrollbar, locked columns behave like unlocked columns, because there is no horizontal scroll. This horizontal scroll policy of the grid defaults to "off", and changing this to "on" or "auto" affects the calculations that we perform in deciding the optimal column widths, in that columns are no longer "squished" or "expanded" to fit the visible width of the grid. The left and right locked section for grids with flat data are wide enough to accommodate the left and right locked columns respectively. For nested grids, both left and right locked sections are wide enough to accommodate the widest left and right locked columns at each level, and for the leftLocked section, we add the width of the disclosure cells which is set via the nestIndent property for each level (it gets multiplied by the nestDepth for a tree look).
There are a few restrictions with left and right locked columns. They cannot be re-ordered.
Resizing them results in resizing the section that they are in.
Finally, resizing them is very slightly slower than resizing the unlocked columns, because we have to redraw the grid on basis of updated section widths.

Return:

public getColumnLockMode(): * source

Return:

public getColumnWidthMode(): * source

The columnWidthMode property on the column specifies how the column widths are applied. This property defaults to "none".

Flexicious Ultimate provides a rich mechanism to control column widths. Column widths are a complicated topic because there are a number of scenarios and rules that we need to account for

When there is a horizontal scroll (horizontalScrollPolicy=on or auto): In this case, the columns are free to (much) take width as they need. Below is how the column widths should handle in this case:
- When columnWidthMode=none or fixed: The column will basically take the width specified by the width property
- When columnWidthMode=fitToContent The column will take the width calculated by its contents. The grid identifies the longest string to be displayed in this column, and sets the width of the column to this value.
- When columnWidthMode=percent. This is not a valid setting when horizontalScrollPolicy is on or auto. The setting will be ignored and the column will take the width specified by the width property. When horizontalScrollPolicy is set to auto or on, columnWidthMode=percent holds no meaning, since there are no fixed bounds to squish the columns within.
When there is no horizontal scroll (horizontalScrollPolicy=off - this is the default):
- When columnWidthMode=none: The column will take the width specified by the width property, and adjust for width (see sum of Column Widths exceeds Grid Width below).
- When columnWidthMode=fixed: The column will take the width specified by the width property, and not adjust for width.
- When columnWidthMode=fitToContent: The column will take the width calculated by its contents, and adjust for width (see sum of Column Widths exceeds Grid Width below).
- When columnWidthMode=percent: For these columns, the grid divides the remaining width after allocating all fixed and fitToContent columns, on a percentage basis among all columns that have columnWidthMode set to percent. PLEASE NOTE : If you set columnWidthMode='percent', also set percentWidth. Also, ensure that the percentWidth of the columns adds up to a 100.

Finally, there are the below calculations once the column widths are allocated:

Grid Width exceeds Sum of Column Widths: The situation where the calcualted column widths do not add upto the grid with is also handled on basis of the horizontalScrollPolicy.
- When there is a horizontal scroll (horizontalScrollPolicy=on or auto): The last column extends to fill up all the remaining space. If you do not want your last column to resize, add a dummy column that has the following property (order is important) minWidth="1" width="1" paddingLeft="0" paddingRight="0"
- When there is no horizontal scroll (horizontalScrollPolicy=off - this is the default): The extra width is divided proportionally between all the columns where columnWidthMode does not equal fixed.

Sum of Column Widths exceeds Grid Width: Similarly, The situation where the allocated column widths exceed the width of the grid with is also handled on basis of the horizontalScrollPolicy.

When there is a horizontal scroll (horizontalScrollPolicy=on or auto): We simply show a scroll bar, and no column widths are changed.

When there is no horizontal scroll (horizontalScrollPolicy=off - this is the default): This excess width is reduced proportionally between columns where columnWidthMode does not equal fixed.

Left and right locked columns do not support column width mode, it is ignored for these.
Finally, with multi level grids, if the hierarchy's columns width in the top level is smaller than the next level's width (and the horizontal scroll policy of the grid is "on"/"auto"), the horizontal scroller will be calculated only by the top level's width, making some columns in the next level unreachable. The recommendation is to give a large column width to the last top level column, which is large enough so that sum of column widths at top level is larger than the sum of column widths at the bottom level.
Values : none,fixed,percent,fitToContent

Return:

public getDataCellRenderer(): * source

Container for the item renderer. Needs to implement IFlexDataGridDataCell. Defaults to FlexDataGridDataCell

Return:

public getDataField(): string source

If you specify a complex property ,the grid takes over the sortCompareFunction, and the sortField property is ignored.

Return:

public getDistinctValues(dp: object, collection: Array, addedCodes: Array, lvl: flexiciousNmsp.FlexDataGridColumnLevel): Array source

Returns this list of distinct values for this column, in a list of arraycollection which will have properties data and label.

Params:

Name	Type	Attribute	Description
dp	object
collection	Array
addedCodes	Array
lvl	flexiciousNmsp.FlexDataGridColumnLevel

Return:

Array

public getEditable(): boolean source

Flag that indicates whether the items in the column are editable.

Return:

public getFilterControl(): * source

A control that implements IFilterControl

Return:

public getFilterRenderer(): * source

The actual control to render inside the header column. This control must implement the com.flexicious.controls.interfaces.filters.IFilterControl interface.

Return:

public getHeaderText(cell: flexiciousNmsp.FlexDataGridDataCell): string source

Text for the header of this column. By default, the DataGrid control uses the value of the dataField property as the header text. IF a headerTextFunction is specified, that is used first.

Params:

Name	Type	Attribute	Description
cell	flexiciousNmsp.FlexDataGridDataCell

Return:

public getIconField(): string source

The property on the model object that returns the url to the icon, if you wish to show different icons for each cell.

Defaults to data field. If there are scenarios where you wish to show both the icon as well as the text, you can specify the iconField and the dataField. Otherwise, where you show just the icon, you can leave the iconField blank and have the data field specify the value of the icon url.

Return:

public getIndex(): number source

Return:

public getIsElastic(): boolean source

Returns true if the column is not right locked or IFixedWidth.

Return:

public getIsFirstRightLocked(): boolean source

Return:

public getIsFirstUnLocked(): boolean source

Return:

public getIsLastLeftLocked(): boolean source

Return:

public getIsLastUnLocked(): boolean source

Return:

public getIsLastleftLocked(): boolean source

Return:

public getIsLastrightLocked(): boolean source

Return:

public getIsLeftLocked(): boolean source

Returns true if the column is left locked.

Return:

public getIsLocked(): boolean source

Returns true if the column is left or right locked.

Return:

public getIsRightLocked(): boolean source

Returns true if the column is right locked.

Return:

public getIsSortable(): boolean source

MX and Spark Grids implement the sortable differently, so to match the interface.

Return:

public getLabel(): string source

For support in pickers

Return:

public getLabelFunction(value: *): Function source

A function that determines the text to display in this column. By default the column displays the text for the field in the data that matches the column name. However, sometimes you want to display text based on more than one field in the data, or display something that does not have the format that you want. In such a case you specify a callback function using labelFunction.

For the DataGrid control, the method signature has the following form:

labelFunction(item:Object, column:DataGridColumn):String

Where item contains the DataGrid item object, and column specifies the DataGrid column.

A callback function might concatenate the firstName and lastName fields in the data, or do some custom formatting on a Date, or convert a number for the month into the string for the month.

Params:

Name	Type	Attribute	Description
value	*

Return:

Function

public getLabelFunction2(value: *): Function source

A specialized function that determines the text to display in this column, and takes the actual cell being (a) evaluated parameter.

As opposed to the regular label function, this actually takes a FlexDataGridCell (a) object parameter, which contains the level information if you need to perform additonal logic. Please note, the cell parameter will be null in certain cases, like from the quickFind() method, where the cell is not currently drawn.

Example: labelFunction="myLabelFunc"

private String myLabelFunc(Object item, FlexDataGridColumn col, FlexDataGridCell cell ){ }

Params:

Name	Type	Attribute	Description
value	*

Return:

Function

public getLevel(value: *): flexiciousNmsp.FlexDataGridColumnLevel source

Params:

Name	Type	Attribute	Description
value	*

Return:

flexiciousNmsp.FlexDataGridColumnLevel

level

public getNestDepth(): * source

Gets the nest depth of the associated level.

Return:

public getOwner(): flexiciousNmsp.FlexDataGrid source

Return:

flexiciousNmsp.FlexDataGrid

public getPersistenceKey(): string source

this method was deprecated. - now defaults to the uniqueIdentifier.

For datagrids where there are multiple columns with the same header text, this field may be specified so that the persistence mechanism does not overwrite it.

Return:

public getSearchField(): string source

The field that the filter should search on. Defaults to the dataField property from mx.controls.dataGridClasses.DataGridColumn. But can be overridden if needed.

For example, consider a grid bound to a list of Employee objects, with a departmentName and departmentId property. This column shows the departmentName, with a combobox filter or a multi-select filter using a list of departments as filterComboBoxDataProvider

By default, the comparison will occur using the selected label of the filter control being compared to the departmentName property of each employee. This is allright if the filterPageSortMode property of the com.flexicious.grids.ExtendedDataGrid is set to "client", but if it is "server" , you would ideally want to have the ID of the selected department(s). In that case, you would set the searchField property to "departmentId", filterComboBoxDataField to "departmentId", filterComboBoxLabelField to "departmentName".

Return:

public getSortField(): string source

Similar to searchField, if you want to override what the database actually sorts when you sort this column

Return:

public getSortFieldName(): string source

Similar to searchField, if you want to override what the database actually sorts when you sort this column

Return:

public getStyleValue(styleProp: string): object source

Gets the style value for the provided style property at the current level. If not defined at current level, gets the one defined at the grid level.

Params:

Name	Type	Attribute	Description
styleProp	string

Return:

object

public getUniqueIdentifier(): * source

A key used to uniquely identify a column. Defaults to the header text Used in print and preference persistence to identify columns.

Return:

public getVisible(): boolean source

Flag that indicates whether the column is visible. If true, the column is visible.

Return:

public getWidth(): number source

The width of the column, in pixels.

Return:

public getX(): number source

Current X position of this column relative to the container for its cells.

Return:

public hasCustomItemRenderer(): boolean source

Return:

public isValidStyleValue(val: *): boolean source

A function that is used when we have complex properties in the datafield.

Params:

Name	Type	Attribute	Description
val	*

Return:

public itemToLabel(data: object, cell: flexiciousNmsp.FlexDataGridCell): * source

Returns the String that the item renderer displays for the given data object. 0) If there is a linktext property specified on the column, this function returns that. 1) If the DataGridColumn or its DataGrid control has a non-null labelFunction property, it applies the function to the data object. 2) If the DataGridColumn or its DataGrid control has a non-null labelFunction2 property, it applies the function to the data object. 3) Otherwise, the method extracts the contents of the field specified by the dataField property, or gets the string value of the data object. 4) If the method cannot convert the parameter to a String, it returns a single space.

Params:

Name	Type	Attribute	Description
data	object
cell	flexiciousNmsp.FlexDataGridCell

Return:

*	Displayable String based on the data.

public itemToLabelCommon(item: object): String source

Params:

Name	Type	Attribute	Description
item	object

Return:

String

public kill() source

Removes all event listeners

Override:

EventDispatcher#kill

public labelFunctionSortCompare(obj1: object, obj2: object): boolean source

Params:

Name	Type	Attribute	Description
obj1	object
obj2	object

Return: