Packagemx.controls.advancedDataGridClasses
Classpublic class SortInfo
InheritanceSortInfo Inheritance 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
 PropertyDefined 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
 MethodDefined By
  
SortInfo(sequenceNumber:int = -1, descending:Boolean = false, status:String)
Constructor.
SortInfo
Public Constants
 ConstantDefined 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
descendingproperty
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.

sequenceNumberproperty 
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.

statusproperty 
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
ACTUALSORTConstant
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.

PROPOSEDSORTConstant 
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.