| Package | com.flexicious.grids.spark.columns |
| Class | public class SelectAllCheckBoxHeaderColumn |
| Inheritance | SelectAllCheckBoxHeaderColumn  ExtendedGridColumn spark.components.gridClasses.GridColumn |
| Implements | ISelectAllColumn |
Default MXML PropertyselectedKeyField
| Property | Defined 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 | |
| selectedKeyField : String
The property(attribute) of the type(class) of the objects
contained within the collection bound to the dataProvider. | SelectAllCheckBoxHeaderColumn | ||
| 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 | |
| Property | Defined By | ||
|---|---|---|---|
| _selectedKeyField : String | SelectAllCheckBoxHeaderColumn | ||
| Method | Defined By | ||
|---|---|---|---|
| SelectAllCheckBoxHeaderColumn | |||
| 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 | |
| _selectedKeyField | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _selectedKeyField:String| selectedKeyField | property |
selectedKeyField:StringThe 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". This is then used by the selectedKeys and selectedObjects properties to return the appropriate collection.
public function get selectedKeyField():String public function set selectedKeyField(value:String):void| SelectAllCheckBoxHeaderColumn | () | Constructor |
public function SelectAllCheckBoxHeaderColumn()