Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
GridSortFieldSimple

Package | spark.components.gridClasses
Class | public class GridSortFieldSimple
Inheritance | GridSortFieldSimple SortField SortField flash.events.EventDispatcher

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | arraySortOnOptions : int [read-only] This helper property is used internally by the findItem() and sort() methods. | SortField
|  | caseInsensitive : Boolean [read-only] Specifies whether the sort for this field should be case insensitive. | SortField
|  | className : String [read-only] | SortField
|  | column : GridColumn [read-only] | GridSortFieldSimple
|  | compareFunction : Function [override] The function that compares two items during a sort of items for the associated collection. | SortField
|  | descending : Boolean Specifies whether this field should be sorted in descending order. | SortField
|  | id : String | SortField
|  | inheritingStyles : Object | SortField
|  | moduleFactory : IFlexModuleFactory | SortField
|  | name : String The name of the field to be sorted. | SortField
|  | nonInheritingStyles : Object | SortField
|  | numeric : Object Specifies that if the field being sorted contains numeric (number/int/uint) values, or string representations of numeric values, the comparator use a numeric comparison. | SortField
|  | sortCompareType : String Specifies what compare type will be used for the sortField. | SortField
|  | styleDeclaration : CSSStyleDeclaration | SortField
|  | styleManager : IStyleManager2 [read-only] | SortField
|  | styleName : Object | SortField
|  | styleParent : IAdvancedStyleClient | SortField
|  | usingCustomCompareFunction : Boolean [read-only] True if this ISortField uses a custom comparator function. | SortField

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | GridSortFieldSimple(column:GridColumn, name:String = null, descending:Boolean = false, numeric:Object = null, sortCompareType:String = null, customCompareFunction:Function = null) | GridSortFieldSimple
|  | clearStyle(styleProp:String):void | SortField
|  | getClassStyleDeclarations():Array | SortField
|  | getStyle(styleProp:String):* | SortField
|  | hasCSSState():Boolean | SortField
|  | initialized(document:Object, id:String):void | SortField
|  | initializeDefaultCompareFunction(obj:Object):void A helper function called by the Sort class to set the default comparison function to perform a comparison based on one of three things: whether or not a custom compare function has been set, the data type for the specified field or the the value of the numeric property. | SortField
|  | matchesCSSState(cssState:String):Boolean | SortField
|  | matchesCSSType(cssType:String):Boolean | SortField
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void | SortField
|  | objectHasSortField(object:Object):Boolean | SortField
|  | regenerateStyleCache(recursive:Boolean):void | SortField
|  | registerEffects(effects:Array):void | SortField
|  | reverse():void Reverse the criteria for this sort field. | SortField
|  | setStyle(styleProp:String, newValue:*):void | SortField
|  | styleChanged(styleProp:String):void | SortField
|  | stylesInitialized():void | SortField
|  | updateSortCompareType():Boolean This changes the internal compare function used by the SortField based on the value of sortCompareType. | SortField

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | getSortFieldValue(obj:Object):* [override] | GridSortFieldSimple
|  | stringCompare(a:Object, b:Object):int [override] Pull the strings from the objects and call the implementation. | SortField
|  | xmlCompare(a:Object, b:Object):int [override] Pull the values out fo the XML object, then compare using the string or numeric comparator depending on the numeric flag. | SortField

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | locale | Type: String CSS Inheritance: yes The locale identifier that specifies the language, region, script and optionally other related tags and keys. See also http://www.unicode.org/reports/tr35/ | SortField

Property Detail

column | property

`column:GridColumn` [read-only]

Implementation
`public function get column():GridColumn`
Constructor Detail

GridSortFieldSimple | () | Constructor

`public function GridSortFieldSimple(column:GridColumn, name:String = null, descending:Boolean = false, numeric:Object = null, sortCompareType:String = null, customCompareFunction:Function = null)`

Parameters

| `column:GridColumn`
| `name:String` (default = `null`)``
| `descending:Boolean` (default = `false`)``
| `numeric:Object` (default = `null`)``
| `sortCompareType:String` (default = `null`)``
| `customCompareFunction:Function` (default = `null`)``

Method Detail

getSortFieldValue | () | method

`override protected function getSortFieldValue(obj:Object):*`

Parameters

| `obj:Object`

Returns

| `*`

Sun Mar 5 2017, 03:42 PM +11:00