Packagecom.flexicious.grids.columns
Classpublic class SelectAllAdvancedCheckBoxHeaderColumn
InheritanceSelectAllAdvancedCheckBoxHeaderColumn Inheritance ExtendedAdvancedDataGridColumn Inheritance mx.controls.advancedDataGridClasses.AdvancedDataGridColumn
Implements ISelectAllColumn

Use with the selectedKeyField = "typically the ID field" Once you do this, you can use the Grid.selectedObjects or Grid.selectedKeys and it will give you a list of the grids selected objects, or a list of values of the field that you specify in the selectedKeyField

Default MXML PropertyselectedKeyField



Public Properties
 PropertyDefined By
 InheritedclearFilterOnIconClick : Boolean = false
For filterControl=textInput, if you specify an Filter Icon Style, setting this variable to true will clear the text on icon click.
ExtendedAdvancedDataGridColumn
 InheritedclickBehavior : String
Grid can be setup to launch a popup when the user clicks or hovers.
ExtendedAdvancedDataGridColumn
 InheritedclickParentDisplayObject : DisplayObject
The parent object to use while calling PopupManager.addPopUp.
ExtendedAdvancedDataGridColumn
 InheritedclickPopupClass : IFactory
The popup class to launch.
ExtendedAdvancedDataGridColumn
 InheritedclickPopupHeight : Number
The height of the popup to launch when the clickBehavior is set.
ExtendedAdvancedDataGridColumn
 InheritedclickPopupTitle : String
The title of the popup to launch when the clickBehavior is set.
ExtendedAdvancedDataGridColumn
 InheritedclickPopupWidth : Number
The width of the popup to launch when the clickBehavior is set.
ExtendedAdvancedDataGridColumn
 InheritedcolumnWidthMode : String
Specifies how the column widths are applied.
ExtendedAdvancedDataGridColumn
 InheritedcolumnWidthOffset : 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.
ExtendedAdvancedDataGridColumn
 InheritedenableFilterAutoComplete : Boolean = false
When filterControl=textInput, setting this flag to true will set the enableAutoComplete flag on the associated TextInput control
ExtendedAdvancedDataGridColumn
 InheritedenableNestedPropertySupport : Boolean
Support for nested properties.
ExtendedAdvancedDataGridColumn
 InheritedexcludeFromExport : Boolean
If set to true, this column wont be included in the export mechanism by default.
ExtendedAdvancedDataGridColumn
 InheritedexcludeFromPrint : Boolean
If set to true, this column wont be included in the print mechanism by default.
ExtendedAdvancedDataGridColumn
 InheritedexcludeFromSettings : Boolean
If set to true, this column wont be included displayed in the Settings Popup
ExtendedAdvancedDataGridColumn
 InheritedfilterComboBoxBuildFromGrid : Boolean
Flag, if set to true, will automatically build this collection on basis of distinct values in the grid.
ExtendedAdvancedDataGridColumn
 InheritedfilterComboBoxDataField : String
Used in conjunction with the filterComboBoxDataProvider field, used to set the value of the data field for the associated ISelectFilterControl
ExtendedAdvancedDataGridColumn
 InheritedfilterComboBoxDataProvider : ArrayCollection
Dataprovider to use to build the list of values to dipsplay in the filter control, only applicable if the filterControl is a
ExtendedAdvancedDataGridColumn
 InheritedfilterComboBoxLabelField : String
Used in conjunction with the filterComboBoxDataProvider field, used to set the value of the label field for the associated ISelectFilterControl
ExtendedAdvancedDataGridColumn
 InheritedfilterComboBoxWidth : Number
Returns the width of the dropdown.
ExtendedAdvancedDataGridColumn
 InheritedfilterCompareFunction : 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.
ExtendedAdvancedDataGridColumn
 InheritedfilterComparisionType : String
This is ususally automatically set, you dont have to manually set it, unless you're sending strings as Date objects.
ExtendedAdvancedDataGridColumn
 InheritedfilterControl : String
A control that implements
ExtendedAdvancedDataGridColumn
 InheritedfilterConverterFunction : Function = null
A function that takes an item, and returns a processed value for comparision.
ExtendedAdvancedDataGridColumn
 InheritedfilterDateRangeOptions : Array
Applicable only when the filtercontrol is a
ExtendedAdvancedDataGridColumn
 InheritedfilterOperation : String
The opeartor to apply when doing the conversion.
ExtendedAdvancedDataGridColumn
 InheritedfilterRenderer : IFactory
The actual control to render inside the header column.
ExtendedAdvancedDataGridColumn
 InheritedfilterTriggerEvent : String
The event that the filter triggers on.
ExtendedAdvancedDataGridColumn
 InheritedfilterWaterMark : String
Applicable only if the filter control is TextInput.
ExtendedAdvancedDataGridColumn
 InheritedfooterAlign : String
The alignment of the footer label
ExtendedAdvancedDataGridColumn
 InheritedfooterFormatter : Formatter
Formatter for the footer label
ExtendedAdvancedDataGridColumn
 InheritedfooterLabel : String
The label of the footer
ExtendedAdvancedDataGridColumn
 InheritedfooterLabelFunction : Function
A function that will return the footer label
ExtendedAdvancedDataGridColumn
 InheritedfooterOperation : String
The operation to apply to the footer
ExtendedAdvancedDataGridColumn
 InheritedfooterOperationPrecision : int
Precision for the footer label
ExtendedAdvancedDataGridColumn
 InheritedfooterRenderer : IFactory
A renderer for the footer
ExtendedAdvancedDataGridColumn
 InheritedfooterStyleName : String
Style name for the footer cells.
ExtendedAdvancedDataGridColumn
 Inheritedformat : String
Used by the doFormat method.
ExtendedAdvancedDataGridColumn
 InheritedformatterCurrencySymbol : String
For currency formatter, the currency symbol.
ExtendedAdvancedDataGridColumn
 InheritedformatterDateFormatString : String
For date formatters, the date format.
ExtendedAdvancedDataGridColumn
 InheritedformatterPrecision : Number = 2
For number and currency formatters, the default number of digits after the decimal point.
ExtendedAdvancedDataGridColumn
 InheritedisSortable : Boolean
[read-only] MX and Spark Grids implement the sortable differently, so to match the interface.
ExtendedAdvancedDataGridColumn
 InheritedlinkText : String
When set, creates a link text that can then be used in conjunction with the linkClicked event.
ExtendedAdvancedDataGridColumn
 InheritedpercentWidth : Number
On creation complete, will use this to distribute the width of the grid among the visible columns in the specified ratio.
ExtendedAdvancedDataGridColumn
 InheritedpersistenceKey : 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.
ExtendedAdvancedDataGridColumn
 InheritedsearchField : String
The field that the filter should search on.
ExtendedAdvancedDataGridColumn
  selectedKeyField : String
The property(attribute) of the type(class) of the objects contained within the collection bound to the dataProvider.
SelectAllAdvancedCheckBoxHeaderColumn
 InheritedshowClearIconWhenHasText : 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.
ExtendedAdvancedDataGridColumn
 InheritedsortField : String
Similar to searchField, if you want to override what the database actually sorts when you sort this column
ExtendedAdvancedDataGridColumn
 InheritedsortFieldName : String
[read-only] To prevent sortField from clashing with Spark DataGrid's sort field
ExtendedAdvancedDataGridColumn
 InheriteduniqueIdentifier : String
A key used to uniquely identify a column.
ExtendedAdvancedDataGridColumn
 InheriteduseCurrentDataProviderForFilterComboBoxValues : Boolean
If you want to restrict the list of options in the filter dropdown to the current dataprovider, set this flag to true.
ExtendedAdvancedDataGridColumn
 InheriteduseHandCursor : Boolean
ExtendedAdvancedDataGridColumn
 InheriteduseLabelFunctionForFilterCompare : 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.
ExtendedAdvancedDataGridColumn
 InheriteduseLabelFunctionForSortCompare : Boolean
When you set to true, a custom sortCompareFunction is applied that uses the labelFunction instead of the dataField.
ExtendedAdvancedDataGridColumn
Protected Properties
 PropertyDefined By
  _selectedKeyField : String
SelectAllAdvancedCheckBoxHeaderColumn
Public Methods
 MethodDefined By
  
SelectAllAdvancedCheckBoxHeaderColumn
 Inherited
createPopup(popupData:Object):Object
Creates the popup.
ExtendedAdvancedDataGridColumn
 Inherited
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.
ExtendedAdvancedDataGridColumn
 Inherited
itemToLabel(data:Object, withFormatting:Boolean = true):String
[override]
ExtendedAdvancedDataGridColumn
 Inherited
showPopup(popupData:Object):Object
Launches the actual popup.
ExtendedAdvancedDataGridColumn
Protected Methods
 MethodDefined By
 Inherited
nestedSortCompareFunction(obj1:Object, obj2:Object):int
ExtendedAdvancedDataGridColumn
Events
 Event Summary Defined By
 InheritedFired when the link is clicked if the linkText property is set.ExtendedAdvancedDataGridColumn
Styles
 Style Description Defined By
 InheritedType: Class Format: EmbeddedFile CSS Inheritance: no
When filterControl=textInput, the icon that is displayed inside the textbox, based on the insideIconPosition property.
ExtendedAdvancedDataGridColumn
 InheritedType: String
When filterControl=textInput, the position of the icon that is displayed inside the textbox.
ExtendedAdvancedDataGridColumn
Public Constants
 ConstantDefined By
 InheritedCOLUMN_WIDTH_MODE_FIT_TO_CONTENT : String = fitToContent
[static]
ExtendedAdvancedDataGridColumn
 InheritedCOLUMN_WIDTH_MODE_FIXED : String = fixed
[static]
ExtendedAdvancedDataGridColumn
 InheritedCOLUMN_WIDTH_MODE_PERCENT : String = percent
[static]
ExtendedAdvancedDataGridColumn
 InheritedFORMAT_CURRENCY : String = currency
[static] Used by the doFormat method.
ExtendedAdvancedDataGridColumn
 InheritedFORMAT_DATE : String = date
[static] Used by the doFormat method.
ExtendedAdvancedDataGridColumn
 InheritedFORMAT_DATE_TIME : String = datetime
[static] Used by the doFormat method.
ExtendedAdvancedDataGridColumn
 InheritedFORMAT_NONE : String = none
[static] Used by the doFormat method.
ExtendedAdvancedDataGridColumn
 InheritedFORMAT_NUMBER : String = number
[static] Used by the doFormat method.
ExtendedAdvancedDataGridColumn
 InheritedFORMAT_TIME : String = time
[static] Used by the doFormat method.
ExtendedAdvancedDataGridColumn
Property Detail
_selectedKeyFieldproperty
protected var _selectedKeyField:String

selectedKeyFieldproperty 
selectedKeyField:String

The property(attribute) of the type(class) of the objects contained within the collection bound to the dataProvider. Example, "employeeId" property would be the selectedKeyField of the class "Employee.as". This is then used by the selectedKeys and selectedObjects properties to return the appropriate collection.


Implementation
    public function get selectedKeyField():String
    public function set selectedKeyField(value:String):void
Constructor Detail
SelectAllAdvancedCheckBoxHeaderColumn()Constructor
public function SelectAllAdvancedCheckBoxHeaderColumn()