mx.controls.advancedDataGridClasses.SortInfo - Adobe® Flex® 4 Language Reference (Flex 4)

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.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		descending : Boolean Contains true when the column is sorted in descending order, and false when the column is sorted in ascending order.	SortInfo
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SortInfo(sequenceNumber:int = -1, descending:Boolean = false, status:String) Constructor.	SortInfo
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

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.