SortField

套件	mx.collections
類別	public class SortField
繼承	SortField EventDispatcher Object
實作	ISortField

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

使用 Flex 4.5 開始，Adobe 建議您使用 spark.collections.SortField 類別當作是此類別的替代類別。

Provides the sorting information required to establish a sort on a field or property in a collection view. The SortField class is meant to be used with the Sort class. Typically the sort is defined for collections of complex items, that is items in which the sort is performed on properties of those objects. As in the following example:


     var col:ICollectionView = new ArrayCollection();
     col.addItem({first:"Anders", last:"Dickerson"});
     var sort:Sort = new Sort();
     sort.fields = [new SortField("first", true)];
     col.sort = sort;

There are situations in which the collection contains simple items, like String, Date, Boolean, etc. In this case, sorting should be applied to the simple type directly. When constructing a sort for this situation only a single sort field is required and should not have a name specified. For example:


     var col:ICollectionView = new ArrayCollection();
     col.addItem("California");
     col.addItem("Arizona");
     var sort:Sort = new Sort();
     sort.fields = [new SortField(null, true)];
     col.sort = sort;

By default the comparison provided by the SortField class does not provide correct language specific sorting for strings. For this type of sorting please see the spark.collections.Sort and spark.collections.SortField classes.

MXML 語法

隱藏 MXML 語法

The <mx:SortField> tag has the following attributes:

  <mx:SortField
  Properties
  caseInsensitive="false"
  compareFunction="Internal compare function"
  descending="false"
  name="null"
  numeric="null"
  />

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		arraySortOnOptions : int [唯讀] This helper property is used internally by the findItem() and sort() methods.	SortField
		caseInsensitive : Boolean Specifies whether the sort for this field should be case insensitive.	SortField
		compareFunction : Function The function that compares two items during a sort of items for the associated collection.	SortField
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		descending : Boolean Specifies whether this field should be sorted in descending order.	SortField
		name : String The name of the field to be sorted.	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
		usingCustomCompareFunction : Boolean [唯讀] True if this ISortField uses a custom comparator function.	SortField

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null) Constructor.	SortField
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		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
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		reverse():void Reverse the criteria for this sort field.	SortField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	事件		摘要	定義自
		activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
		deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher

屬性詳細資訊

arraySortOnOptions

屬性

arraySortOnOptions:int [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

This helper property is used internally by the findItem() and sort() methods. Other uses of this property are not supported. Returns -1 if this ISortField shouldn't be used by the Sort class to sort the field (there is no compareFunction or no name). Otherwise, returns a bitmask of sort options..

實作
public function get arraySortOnOptions():int

caseInsensitive

屬性

caseInsensitive:Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Specifies whether the sort for this field should be case insensitive.

預設值為 false。

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 caseInsensitiveChanged 事件。

實作
public function get caseInsensitive():Boolean
public function set caseInsensitive(value:Boolean):void

compareFunction

屬性

compareFunction:Function

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The function that compares two items during a sort of items for the associated collection. If you specify a compareFunction property in an ISort object, Flex ignores any compareFunction properties of the ISort's SortField objects.

The compare function must have the following signature:

function myCompare(a:Object, b:Object):int

This function must return the following values:

-1, if a should appear before b in the sorted sequence
0, if a equals b
1, if a should appear after b in the sorted sequence

The default value is an internal compare function that can perform a string, numeric, or date comparison in ascending or descending order, with case-sensitive or case-insensitive string comparisons. Specify your own function only if you need a need a custom comparison algorithm. This is normally only the case if a calculated field is used in a display.

Note if you need, language specific sorting then consider using the spark.collections.SortField class.

實作
public function get compareFunction():Function
public function set compareFunction(value:Function):void

相關 API 元素

spark.collections.SortField

descending

屬性

descending:Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Specifies whether this field should be sorted in descending order.

The default value is false (ascending).

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 descendingChanged 事件。

實作
public function get descending():Boolean
public function set descending(value:Boolean):void

name

屬性

name:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The name of the field to be sorted.

預設值為 null。

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 nameChanged 事件。

實作
public function get name():String
public function set name(value:String):void

numeric

屬性

numeric:Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

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.

This property is used by SortField class in case custom compare function is not provided.

If this property is true, the built-in numeric compare function is used. Each of data items is cast to a Number() function before the comparison.

If this property is false, the built-in string compare function is used. Each of data items is cast to a String() function before the comparison.

If this property is null, the first data item is introspected to see if it is a number or string and the sort proceeds based on that introspection.

預設值為 null。

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 numericChanged 事件。

實作
public function get numeric():Object
public function set numeric(value:Object):void

usingCustomCompareFunction

屬性

usingCustomCompareFunction:Boolean [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

True if this ISortField uses a custom comparator function.

實作
public function get usingCustomCompareFunction():Boolean

建構函式詳細資料

()

建構函式

public function SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null)

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Constructor.

參數

	`name:String` (default = `null`) — The name of the property that this field uses for comparison. If the object is a simple type, pass `null`.

	`caseInsensitive:Boolean` (default = `false`) — When sorting strings, tells the comparator whether to ignore the case of the values.

	`descending:Boolean` (default = `false`) — Tells the comparator whether to arrange items in descending order.

	`numeric:Object` (default = `null`) — Tells the comparator whether to compare sort items as numbers, instead of alphabetically.

方法詳細資訊

initializeDefaultCompareFunction

()

方法

public function initializeDefaultCompareFunction(obj:Object):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

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. If the the numeric property is true, then a numeric comparison will be performed when sorting.

參數

obj:Object — The object that contains the data. If the field name has been set with the name property, then the name will be used to access the data value from this object. Otherwise the object itself will be used as the data value.

reverse

()

方法

public function reverse():void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Reverse the criteria for this sort field. If the field was sorted in descending order, for example, sort it in ascending order.

NOTE: An ICollectionView does not automatically update when the ISortFields are modified; call its refresh() method to update the view.

法律聲明 | 線上隱私權政策

SortField - AS3 Flex

類別 x

arraySortOnOptions

caseInsensitive

compareFunction

descending

name

numeric

usingCustomCompareFunction

SortField

initializeDefaultCompareFunction

reverse