Packagecom.flexicious.grids.spark.columns
Classpublic class ExtendedGridColumn
InheritanceExtendedGridColumn Inheritance spark.components.gridClasses.GridColumn
Implements com.flexicious.grids.dependencies.IDataGridFilterColumn, IDataGridFooterColumn
Subclasses SelectAllCheckBoxHeaderColumn

Provides the following additional features in addition to the base column 1) Filter renderer (Any control that implements com.flexicious.controls.filters.interfaces.IFilterControl) - Will draw it in the header and filter the collection automatically. 2) comboBoxDataProvider : Dataprovider for a multi select checkbox filter. For example, if you have a column that shows the state code for a list of contacts, you can have the comboboxdataprovider for this column be a list of states to filter by 3) comboBoxBuildFromGrid: Set this to true, and your multi select checkbox will build its list of distinct values to chooose from on the basis of the data in the colunmn 4) percentWidth: Does what the name implies 5) filterExpression: Defaults to FilterExpression.Equals. You can use this to do a contains/beginswith/greaterthan/lessthan etc in the filter header. com.flexicious.controls.filters.FilterExpression 6) useHandCursor: Set this to true and it will make your column display a hand mouse over. Cannot use with your own renderer. 7) Foolter operations : see footerLabel, footerOperation etc. 8) linkText: Set this to true and it will make your column display a link. Cannot use with your own renderer. Note : all style properties are directly applied to the link if you specify the link text. USe in combination with the useHandCursor property

See also

com.flexicious.controls.filters.FilterExpression
com.flexicious.controls.filters.interfaces.IFilterControl


Public Properties
 PropertyDefined By
  clearFilterOnIconClick : Boolean = false
For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear the text on icon click.
ExtendedGridColumn
  clickBehavior : String
Grid can be setup to launch a popup when the user clicks or hovers.
ExtendedGridColumn
  clickParentDisplayObject : DisplayObject
The parent object to use while calling PopupManager.addPopUp.
ExtendedGridColumn
  clickPopupClass : IFactory
The popup class to launch.
ExtendedGridColumn
  clickPopupHeight : Number
The height of the popup to launch when the clickBehavior is set.
ExtendedGridColumn
  clickPopupTitle : String
The title of the popup to launch when the clickBehavior is set.
ExtendedGridColumn
  clickPopupWidth : Number
The width of the popup to launch when the clickBehavior is set.
ExtendedGridColumn
  colNum : Number
[read-only]
ExtendedGridColumn
  columnWidthMode : String
Specifies how the column widths are applied.
ExtendedGridColumn
  columnWidthOffset : int
A value in pixels, that may be used to add/remove width that gets calculated when you use the columnWidthMode property Use if you have custom renderers or icons.
ExtendedGridColumn
  enableFilterAutoComplete : Boolean = false
When filterControl=textInput, setting this flag to true will set the enableAutoComplete flag on the associated TextInput control
ExtendedGridColumn
  excludeFromExport : Boolean
If set to true, this column wont be included in the export mechanism by default.
ExtendedGridColumn
  excludeFromPrint : Boolean
If set to true, this column wont be included in the print mechanism by default.
ExtendedGridColumn
  excludeFromSettings : Boolean
If set to true, this column wont be included displayed in the Settings Popup
ExtendedGridColumn
  filterComboBoxBuildFromGrid : Boolean
Flag, if set to true, will automatically build this collection on basis of distinct values in the grid.
ExtendedGridColumn
  filterComboBoxDataField : String
Used in conjunction with the filterComboBoxDataProvider field, used to set the value of the data field for the associated ISelectFilterControl
ExtendedGridColumn
  filterComboBoxDataProvider : ArrayCollection
Dataprovider to use to build the list of values to dipsplay in the filter control, only applicable if the filterControl is a
ExtendedGridColumn
  filterComboBoxLabelField : String
Used in conjunction with the filterComboBoxDataProvider field, used to set the value of the label field for the associated ISelectFilterControl
ExtendedGridColumn
  filterComboBoxWidth : Number
Returns the width of the dropdown.
ExtendedGridColumn
  filterCompareFunction : Function = null
A function that takes an item, and a filterExpression, and returns true or false on basis of whether the provided item matches the filterExpression.
ExtendedGridColumn
  filterComparisionType : String
This is ususally automatically set, you dont have to manually set it, unless you're sending strings as Date objects.
ExtendedGridColumn
  filterControl : String
A control that implements
ExtendedGridColumn
  filterConverterFunction : Function = null
A function that takes an item, and returns a processed value for comparision.
ExtendedGridColumn
  filterDateRangeOptions : Array
Applicable only when the filtercontrol is a
ExtendedGridColumn
  filterOperation : String
The opeartor to apply when doing the conversion.
ExtendedGridColumn
  filterRenderer : IFactory
The actual control to render inside the header column.
ExtendedGridColumn
  filterTriggerEvent : String
The event that the filter triggers on.
ExtendedGridColumn
  filterWaterMark : String
Applicable only if the filter control is TextInput.
ExtendedGridColumn
  footerAlign : String
The alignment of the footer label
ExtendedGridColumn
  footerFormatter : Formatter
Formatter for the footer label
ExtendedGridColumn
  footerLabel : String
The label of the footer
ExtendedGridColumn
  footerLabelFunction : Function
A function that will return the footer label
ExtendedGridColumn
  footerOperation : String
The operation to apply to the footer
ExtendedGridColumn
  footerOperationPrecision : int
Precision for the footer label
ExtendedGridColumn
  footerRenderer : IFactory
A renderer for the footer
ExtendedGridColumn
  footerStyleName : String
Style name for the footer cells.
ExtendedGridColumn
  format : String
Used by the doFormat method.
ExtendedGridColumn
  formatterCurrencySymbol : String
For currency formatter, the currency symbol.
ExtendedGridColumn
  formatterDateFormatString : String
For date formatters, the date format.
ExtendedGridColumn
  formatterPrecision : Number = 2
For number and currency formatters, the default number of digits after the decimal point.
ExtendedGridColumn
  headerRenderer : IFactory
[override] [read-only]
ExtendedGridColumn
  isSortable : Boolean
[read-only] MX and Spark Grids implement the sortable differently, so to match the interface.
ExtendedGridColumn
  linkText : String
When set, creates a link text that can then be used in conjunction with the linkClicked event.
ExtendedGridColumn
  owner : DisplayObject
[read-only]
ExtendedGridColumn
  percentWidth : Number
On creation complete, will use this to distribute the width of the grid among the visible columns in the specified ratio.
ExtendedGridColumn
  persistenceKey : String
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.
ExtendedGridColumn
  searchField : String
The field that the filter should search on.
ExtendedGridColumn
  showClearIconWhenHasText : Boolean = false
For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear show the icon only when there is text in the box.
ExtendedGridColumn
  sortFieldName : String
To prevent sortField from clashing with Spark DataGrid's sort field
ExtendedGridColumn
  uniqueIdentifier : String
A key used to uniquely identify a column.
ExtendedGridColumn
  useCurrentDataProviderForFilterComboBoxValues : Boolean
If you want to restrict the list of options in the filter dropdown to the current dataprovider, set this flag to true.
ExtendedGridColumn
  useHandCursor : Boolean
ExtendedGridColumn
  useLabelFunctionForFilterCompare : Boolean
Flag, that defaults to true, indicates that in client filter mode, use the label function to perform the search comparison as opposed to using the raw value of the "searchField" property of the column.
ExtendedGridColumn
  useLabelFunctionForSortCompare : Boolean
When you set to true, a custom sortCompareFunction is applied that uses the labelFunction instead of the dataField.
ExtendedGridColumn
Public Methods
 MethodDefined By
  
ExtendedGridColumn(columnName:String = null)
Constructor for the Extended Datagrid column
ExtendedGridColumn
  
createPopup(popupData:Object):Object
Creates the popup.
ExtendedGridColumn
  
doFormat(retVal:String):String
The doFormat method returns formatted value on basis of the format properties (See description below) If the input is null, returns null.
ExtendedGridColumn
  
getDistinctValues(dp:Object, collection:Array = null, addedCodes:Array = null):Array
Returns this list of distinct values for this column, in a list of arraycollection which will have properties data and label.
ExtendedGridColumn
  
getStyle(prop:String):*
Not supported
ExtendedGridColumn
  
itemToLabel(data:Object):String
[override]
ExtendedGridColumn
  
setStyle(prop:String, val:*):void
Not supported
ExtendedGridColumn
  
showPopup(popupData:Object):Object
Launches the actual popup.
ExtendedGridColumn
Events
 Event Summary Defined By
  Fired when the link is clicked if the linkText property is set.ExtendedGridColumn
Styles
 Style Description Defined By
  
filterIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
When filterControl=textInput, the icon that is displayed inside the textbox, based on the insideIconPosition property.
ExtendedGridColumn
  
filterIconPosition
Type: String
When filterControl=textInput, the position of the icon that is displayed inside the textbox. Default 'right'
ExtendedGridColumn
Public Constants
 ConstantDefined By
  COLUMN_WIDTH_MODE_FIT_TO_CONTENT : String = fitToContent
[static]
ExtendedGridColumn
  COLUMN_WIDTH_MODE_FIXED : String = fixed
[static]
ExtendedGridColumn
  COLUMN_WIDTH_MODE_PERCENT : String = percent
[static]
ExtendedGridColumn
  FORMAT_CURRENCY : String = currency
[static] Used by the doFormat method.
ExtendedGridColumn
  FORMAT_DATE : String = date
[static] Used by the doFormat method.
ExtendedGridColumn
  FORMAT_DATE_TIME : String = datetime
[static] Used by the doFormat method.
ExtendedGridColumn
  FORMAT_NONE : String = none
[static] Used by the doFormat method.
ExtendedGridColumn
  FORMAT_NUMBER : String = number
[static] Used by the doFormat method.
ExtendedGridColumn
  FORMAT_TIME : String = time
[static] Used by the doFormat method.
ExtendedGridColumn
Property Detail
clearFilterOnIconClickproperty
public var clearFilterOnIconClick:Boolean = false

For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear the text on icon click. Used for a "clear" icon.

clickBehaviorproperty 
clickBehavior:String

Grid can be setup to launch a popup when the user clicks or hovers. The popup class should have a public show method, that takes an object.This is the object bound to the row that triggers the click or hover event.


Implementation
    public function get clickBehavior():String
    public function set clickBehavior(value:String):void
clickParentDisplayObjectproperty 
clickParentDisplayObject:DisplayObject

The parent object to use while calling PopupManager.addPopUp. Defaults to the grid, but you can use any other DisplayObject.


Implementation
    public function get clickParentDisplayObject():DisplayObject
    public function set clickParentDisplayObject(value:DisplayObject):void
clickPopupClassproperty 
clickPopupClass:IFactory

The popup class to launch. Should have a public show method that takes an object. This is the object bound to the row that triggers the click or hover event.


Implementation
    public function get clickPopupClass():IFactory
    public function set clickPopupClass(value:IFactory):void
clickPopupHeightproperty 
clickPopupHeight:Number

The height of the popup to launch when the clickBehavior is set.


Implementation
    public function get clickPopupHeight():Number
    public function set clickPopupHeight(value:Number):void
clickPopupTitleproperty 
clickPopupTitle:String

The title of the popup to launch when the clickBehavior is set.


Implementation
    public function get clickPopupTitle():String
    public function set clickPopupTitle(value:String):void
clickPopupWidthproperty 
clickPopupWidth:Number

The width of the popup to launch when the clickBehavior is set.


Implementation
    public function get clickPopupWidth():Number
    public function set clickPopupWidth(value:Number):void
colNumproperty 
colNum:Number  [read-only]


Implementation
    public function get colNum():Number
columnWidthModeproperty 
columnWidthMode:String

Specifies how the column widths are applied. Defaults to fixed. This means that the width of the column will be fixed to the size specified in the width property. If this property is set to fitContent, the grid identifies the longest string to be displayed in this column, and sets the width of the column to this value. If this is set to percent, the grid divides the remaining width after allocating all fixedWidth 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. Values : fixed,percent,fitToContent

The default value is auto.


Implementation
    public function get columnWidthMode():String
    public function set columnWidthMode(value:String):void
columnWidthOffsetproperty 
columnWidthOffset:int

A value in pixels, that may be used to add/remove width that gets calculated when you use the columnWidthMode property Use if you have custom renderers or icons.


Implementation
    public function get columnWidthOffset():int
    public function set columnWidthOffset(value:int):void
enableFilterAutoCompleteproperty 
public var enableFilterAutoComplete:Boolean = false

When filterControl=textInput, setting this flag to true will set the enableAutoComplete flag on the associated TextInput control

excludeFromExportproperty 
excludeFromExport:Boolean

If set to true, this column wont be included in the export mechanism by default.


Implementation
    public function get excludeFromExport():Boolean
    public function set excludeFromExport(value:Boolean):void
excludeFromPrintproperty 
excludeFromPrint:Boolean

If set to true, this column wont be included in the print mechanism by default.


Implementation
    public function get excludeFromPrint():Boolean
    public function set excludeFromPrint(value:Boolean):void
excludeFromSettingsproperty 
excludeFromSettings:Boolean

If set to true, this column wont be included displayed in the Settings Popup


Implementation
    public function get excludeFromSettings():Boolean
    public function set excludeFromSettings(value:Boolean):void
filterComboBoxBuildFromGridproperty 
filterComboBoxBuildFromGrid:Boolean

Flag, if set to true, will automatically build this collection on basis of distinct values in the grid.


Implementation
    public function get filterComboBoxBuildFromGrid():Boolean
    public function set filterComboBoxBuildFromGrid(value:Boolean):void
filterComboBoxDataFieldproperty 
filterComboBoxDataField:String

Used in conjunction with the filterComboBoxDataProvider field, used to set the value of the data field for the associated ISelectFilterControl


Implementation
    public function get filterComboBoxDataField():String
    public function set filterComboBoxDataField(value:String):void
filterComboBoxDataProviderproperty 
filterComboBoxDataProvider:ArrayCollection

Dataprovider to use to build the list of values to dipsplay in the filter control, only applicable if the filterControl is a


Implementation
    public function get filterComboBoxDataProvider():ArrayCollection
    public function set filterComboBoxDataProvider(value:ArrayCollection):void

See also

Note:
com.flexicious.controls.interfaces.filters.IMultiSelectFilterControl,
inherit from ISelectFilterControl, and
com.flexicious.controls.MultiSelectComboBox
com.flexicious.controls.RadioButtonList
com.flexicious.controls.ComboBox
all inherently implement
Note 2: It is not required to set this field. You may set the filterComboBoxBuildFromGrid property to true which will automatically build this collection on basis of distinct values in the grid.
filterComboBoxLabelFieldproperty 
filterComboBoxLabelField:String

Used in conjunction with the filterComboBoxDataProvider field, used to set the value of the label field for the associated ISelectFilterControl


Implementation
    public function get filterComboBoxLabelField():String
    public function set filterComboBoxLabelField(value:String):void
filterComboBoxWidthproperty 
filterComboBoxWidth:Number

Returns the width of the dropdown. Applicable only when the filter controls are comboboxes


Implementation
    public function get filterComboBoxWidth():Number
    public function set filterComboBoxWidth(value:Number):void
filterCompareFunctionproperty 
public var filterCompareFunction:Function = null

A function that takes an item, and a filterExpression, and returns true or false on basis of whether the provided item matches the filterExpression. Please note, the filterExpression has a pointer to the iFilterControl that it was created from.

filterComparisionTypeproperty 
filterComparisionType:String

This is ususally automatically set, you dont have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion. Values : auto,string,number,boolean,date

The default value is auto.


Implementation
    public function get filterComparisionType():String
    public function set filterComparisionType(value:String):void
filterControlproperty 
filterControl:String

A control that implements


Implementation
    public function get filterControl():String
    public function set filterControl(value:String):void

See also

filterConverterFunctionproperty 
public var filterConverterFunction:Function = null

A function that takes an item, and returns a processed value for comparision. For example, if your backend sends down strings that represents a date, wire this function up and return a date object for comparision purposes.

filterDateRangeOptionsproperty 
filterDateRangeOptions:Array

Applicable only when the filtercontrol is a


Implementation
    public function get filterDateRangeOptions():Array
    public function set filterDateRangeOptions(value:Array):void

See also

filterOperationproperty 
filterOperation:String

The opeartor to apply when doing the conversion. See FILTER_OPERATION_TYPE constant values from com.flexicious.grids.filters.FilterExpression


Implementation
    public function get filterOperation():String
    public function set filterOperation(value:String):void
filterRendererproperty 
filterRenderer:IFactory

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

This property can be used as the source for data binding.


Implementation
    public function get filterRenderer():IFactory
    public function set filterRenderer(value:IFactory):void
filterTriggerEventproperty 
filterTriggerEvent:String

The event that the filter triggers on. Defaults to "change", or if the filterRenderer supports com.flexicious.controls.interfaces.IDelayedChange, then the delayedChange event.


Implementation
    public function get filterTriggerEvent():String
    public function set filterTriggerEvent(value:String):void

See also

filterWaterMarkproperty 
filterWaterMark:String

Applicable only if the filter control is TextInput. If set, sets the watermark of the TextInput filter to the value specified.


Implementation
    public function get filterWaterMark():String
    public function set filterWaterMark(value:String):void
footerAlignproperty 
footerAlign:String

The alignment of the footer label


Implementation
    public function get footerAlign():String
    public function set footerAlign(value:String):void
footerFormatterproperty 
footerFormatter:Formatter

Formatter for the footer label


Implementation
    public function get footerFormatter():Formatter
    public function set footerFormatter(value:Formatter):void
footerLabelproperty 
footerLabel:String

The label of the footer


Implementation
    public function get footerLabel():String
    public function set footerLabel(value:String):void
footerLabelFunctionproperty 
footerLabelFunction:Function

A function that will return the footer label


Implementation
    public function get footerLabelFunction():Function
    public function set footerLabelFunction(value:Function):void
footerOperationproperty 
footerOperation:String

The operation to apply to the footer


Implementation
    public function get footerOperation():String
    public function set footerOperation(value:String):void
footerOperationPrecisionproperty 
footerOperationPrecision:int

Precision for the footer label


Implementation
    public function get footerOperationPrecision():int
    public function set footerOperationPrecision(value:int):void
footerRendererproperty 
footerRenderer:IFactory

A renderer for the footer


Implementation
    public function get footerRenderer():IFactory
    public function set footerRenderer(value:IFactory):void
footerStyleNameproperty 
footerStyleName:String

Style name for the footer cells.


Implementation
    public function get footerStyleName():String
    public function set footerStyleName(value:String):void
formatproperty 
format:String

Used by the doFormat method.


Implementation
    public function get format():String
    public function set format(value:String):void
formatterCurrencySymbolproperty 
public var formatterCurrencySymbol:String

For currency formatter, the currency symbol. Defaults to blank value.

formatterDateFormatStringproperty 
public var formatterDateFormatString:String

For date formatters, the date format. Defaults to blank value. Initialized on basis of date format. If you wish to override the default format, you can use this string.

formatterPrecisionproperty 
public var formatterPrecision:Number = 2

For number and currency formatters, the default number of digits after the decimal point. Defaults to 2

headerRendererproperty 
headerRenderer:IFactory  [read-only] [override]


Implementation
    public function get headerRenderer():IFactory
isSortableproperty 
isSortable:Boolean  [read-only]

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


Implementation
    public function get isSortable():Boolean
linkTextproperty 
linkText:String

When set, creates a link text that can then be used in conjunction with the linkClicked event.


Implementation
    public function get linkText():String
    public function set linkText(value:String):void
ownerproperty 
owner:DisplayObject  [read-only]


Implementation
    public function get owner():DisplayObject
percentWidthproperty 
percentWidth:Number

On creation complete, will use this to distribute the width of the grid among the visible columns in the specified ratio.


Implementation
    public function get percentWidth():Number
    public function set percentWidth(value:Number):void
persistenceKeyproperty 
persistenceKey:String

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.


Implementation
    public function get persistenceKey():String
    public function set persistenceKey(value:String):void
searchFieldproperty 
searchField:String

The field that the filter should search on. Defaults to the dataField property from mx.controls.dataGridClasses.DataGridColumn. But can be overriden 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 multiselect filter using a list of departments as filterComboBoxDataProvider By default, the comparision 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".


Implementation
    public function get searchField():String
    public function set searchField(value:String):void
showClearIconWhenHasTextproperty 
public var showClearIconWhenHasText:Boolean = false

For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear show the icon only when there is text in the box.

sortFieldNameproperty 
sortFieldName:String

To prevent sortField from clashing with Spark DataGrid's sort field


Implementation
    public function get sortFieldName():String
    public function set sortFieldName(value:String):void
uniqueIdentifierproperty 
uniqueIdentifier:String

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


Implementation
    public function get uniqueIdentifier():String
    public function set uniqueIdentifier(value:String):void
useCurrentDataProviderForFilterComboBoxValuesproperty 
useCurrentDataProviderForFilterComboBoxValues:Boolean

If you want to restrict the list of options in the filter dropdown to the current dataprovider, set this flag to true. By default, we use the entire data provider, including the currently filtered items.

The default value is false.


Implementation
    public function get useCurrentDataProviderForFilterComboBoxValues():Boolean
    public function set useCurrentDataProviderForFilterComboBoxValues(value:Boolean):void
useHandCursorproperty 
useHandCursor:Boolean


Implementation
    public function get useHandCursor():Boolean
    public function set useHandCursor(value:Boolean):void
useLabelFunctionForFilterCompareproperty 
useLabelFunctionForFilterCompare:Boolean

Flag, that defaults to true, indicates that in client filter mode, use the label function to perform the search comparison as opposed to using the raw value of the "searchField" property of the column.


Implementation
    public function get useLabelFunctionForFilterCompare():Boolean
    public function set useLabelFunctionForFilterCompare(value:Boolean):void
useLabelFunctionForSortCompareproperty 
useLabelFunctionForSortCompare:Boolean

When you set to true, a custom sortCompareFunction is applied that uses the labelFunction instead of the dataField.


Implementation
    public function get useLabelFunctionForSortCompare():Boolean
    public function set useLabelFunctionForSortCompare(value:Boolean):void
Constructor Detail
ExtendedGridColumn()Constructor
public function ExtendedGridColumn(columnName:String = null)

Constructor for the Extended Datagrid column

Parameters
columnName:String (default = null) — Column name to bind this colum to
Method Detail
createPopup()method
public function createPopup(popupData:Object):Object

Creates the popup.

Parameters

popupData:Object

Returns
Object
doFormat()method 
public function doFormat(retVal:String):String

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.

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

Parameters

retVal:String — String to format

Returns
String — Formatted string.
getDistinctValues()method 
public function getDistinctValues(dp:Object, collection:Array = null, addedCodes:Array = null):Array

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

Parameters

dp:Object
 
collection:Array (default = null)
 
addedCodes:Array (default = null)

Returns
Array
getStyle()method 
public function getStyle(prop:String):*

Not supported

Parameters

prop:String

Returns
*
itemToLabel()method 
override public function itemToLabel(data:Object):String

Parameters

data:Object

Returns
String
setStyle()method 
public function setStyle(prop:String, val:*):void

Not supported

Parameters

prop:String
 
val:*

showPopup()method 
public function showPopup(popupData:Object):Object

Launches the actual popup.

Parameters

popupData:Object

Returns
Object
Event Detail
linkClicked Event
Event Object Type: mx.events.ItemClickEvent

Fired when the link is clicked if the linkText property is set.

Constant Detail
COLUMN_WIDTH_MODE_FIT_TO_CONTENTConstant
public static const COLUMN_WIDTH_MODE_FIT_TO_CONTENT:String = fitToContent

COLUMN_WIDTH_MODE_FIXEDConstant 
public static const COLUMN_WIDTH_MODE_FIXED:String = fixed

COLUMN_WIDTH_MODE_PERCENTConstant 
public static const COLUMN_WIDTH_MODE_PERCENT:String = percent

FORMAT_CURRENCYConstant 
public static const FORMAT_CURRENCY:String = currency

Used by the doFormat method.

FORMAT_DATEConstant 
public static const FORMAT_DATE:String = date

Used by the doFormat method.

FORMAT_DATE_TIMEConstant 
public static const FORMAT_DATE_TIME:String = datetime

Used by the doFormat method.

FORMAT_NONEConstant 
public static const FORMAT_NONE:String = none

Used by the doFormat method.

FORMAT_NUMBERConstant 
public static const FORMAT_NUMBER:String = number

Used by the doFormat method.

FORMAT_TIMEConstant 
public static const FORMAT_TIME:String = time

Used by the doFormat method.