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

Package | mx.controls.advancedDataGridClasses
Class | public class SortInfo
Inheritance | SortInfo Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The SortInfo class defines information about the sorting of a column of the AdvancedDataGrid control. Each column in the AdvancedDataGrid control has an associated SortInfo instance. The AdvancedDataGridSortItemRenderer class uses the information in the SortInfo instance to create the item renderer for the sort icon and text field in the column header of each column in the AdvancedDataGrid control.

See also

mx.controls.AdvancedDataGrid
mx.controls.advancedDataGridClasses.AdvancedDataGridSortItemRenderer

Public Properties

| Property | Defined By
--- | --- | ---
|  | descending : Boolean Contains true when the column is sorted in descending order, and false when the column is sorted in ascending order. | SortInfo
|  | sequenceNumber : int The number of this column in the sort order sequence. | SortInfo
|  | status : String Contains PROPOSEDSORT if the sort is only a visual indication of the proposed sort, or contains ACTUALSORT if the sort is the actual current sort. | SortInfo

Public Methods

| Method | Defined By
--- | --- | ---
|  | SortInfo(sequenceNumber:int = -1, descending:Boolean = false, status:String) Constructor. | SortInfo

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ACTUALSORT : String = actualSort [static] Specifies that the sort is the actual current sort. | SortInfo
|  | PROPOSEDSORT : String = proposedSort [static] Specifies that the sort is only a visual indication of the proposed sort. | SortInfo

Property Detail

descending | property

`public var descending:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Contains `true` when the column is sorted in descending order, and `false` when the column is sorted in ascending order.

sequenceNumber | property |

`public var sequenceNumber:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The number of this column in the sort order sequence. This number is used when sorting by multiple columns.

status | property |

`public var status:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Contains `PROPOSEDSORT` if the sort is only a visual indication of the proposed sort, or contains `ACTUALSORT` if the sort is the actual current sort.

Constructor Detail

SortInfo | () | Constructor

`public function SortInfo(sequenceNumber:int = -1, descending:Boolean = false, status:String)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `sequenceNumber:int` (default = `-1`)`` — The number of this column in the sort order sequence.
| `descending:Boolean` (default = `false`)`` — `true` when the column is sorted in descending order.
| `status:String` (default = `NaN`)`` — `PROPOSEDSORT` if the sort is only a visual indication of the proposed sort, or `ACTUALSORT` if the sort is the actual current sort.

Constant Detail

ACTUALSORT | Constant

`public static const ACTUALSORT:String = actualSort`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies that the sort is the actual current sort.

PROPOSEDSORT | Constant |

`public static const PROPOSEDSORT:String = proposedSort`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies that the sort is only a visual indication of the proposed sort.

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