SortField

Pakiet	mx.collections
Klasa	public class SortField
Dziedziczenie	SortField EventDispatcher Object
Implementuje	ISortField

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Począwszy od Flex 4.5 firma Adobe zaleca użycie klasy spark.collections.SortField jako zamiennika tej klasy.

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.

Składnia MXML expanded

Ukryj składnię MXML

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

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

Powiązane elementy interfejsu API

mx.collections.ICollectionView
mx.collections.Sort
spark.collections.Sort
spark.collections.SortField

Właściwości publiczne

Ukryj dziedziczone właściwości publiczne

Pokaż dziedziczone właściwości publiczne

	Właściwość		Zdefiniowane przez
		arraySortOnOptions : int [tylko do odczytu] 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 Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.	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 [tylko do odczytu] True if this ISortField uses a custom comparator function.	SortField

Metody publiczne

Ukryj dziedziczone metody publiczne

Pokaż dziedziczone metody publiczne

	Metoda		Zdefiniowane przez
		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 Rejestruje obiekt detektora zdarzeń w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu.	EventDispatcher
		dispatchEvent(event:Event):Boolean Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń.	EventDispatcher
		hasEventListener(type:String):Boolean Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń.	EventDispatcher
		hasOwnProperty(name:String):Boolean Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.	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 Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.	Object
		propertyIsEnumerable(name:String):Boolean Wskazuje, czy określona właściwość istnieje i jest przeliczalna.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Usuwa detektor z obiektu EventDispatcher.	EventDispatcher
		reverse():void Reverse the criteria for this sort field.	SortField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Ustawia dostępność właściwości dynamicznej używanej w pętlach.	Object
		toLocaleString():String Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.	Object
		toString():String Zwraca ciąg reprezentujący określony obiekt.	Object
		valueOf():Object Zwraca pierwotną wartość dla określonego obiektu.	Object
		willTrigger(type:String):Boolean Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego elementach macierzystych.	EventDispatcher

Zdarzenia

Kliknij, aby uzyskać więcej informacji o zdarzeniach

Ukryj zdarzenia dziedziczone

Pokaż zdarzenia dziedziczone

	Zdarzenie		Podsumowanie	Zdefiniowane przez
		activate	[zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja środowiska wykonawczego AIR uzyskuje fokus w systemie operacyjnym i przechodzi w stan aktywny.	EventDispatcher
		deactivate	[zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja AIR traci fokus w systemie operacyjnym i przechodzi w stan nieaktywny.	EventDispatcher

Szczegół właściwości

arraySortOnOptions

właściwość

arraySortOnOptions:int [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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

Implementacja
public function get arraySortOnOptions():int

caseInsensitive

właściwość

caseInsensitive:Boolean

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

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

Wartością domyślną jest false.

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie caseInsensitiveChanged .

Implementacja
public function get caseInsensitive():Boolean
public function set caseInsensitive(value:Boolean):void

compareFunction

właściwość

compareFunction:Function

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Implementacja
public function get compareFunction():Function
public function set compareFunction(value:Function):void

Powiązane elementy interfejsu API

spark.collections.SortField

descending

właściwość

descending:Boolean

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Specifies whether this field should be sorted in descending order.

The default value is false (ascending).

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie descendingChanged .

Implementacja
public function get descending():Boolean
public function set descending(value:Boolean):void

name

właściwość

name:String

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

The name of the field to be sorted.

Wartością domyślną jest null.

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie nameChanged .

Implementacja
public function get name():String
public function set name(value:String):void

numeric

właściwość

numeric:Object

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Wartością domyślną jest null.

Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie numericChanged .

Implementacja
public function get numeric():Object
public function set numeric(value:Object):void

usingCustomCompareFunction

właściwość

usingCustomCompareFunction:Boolean [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

True if this ISortField uses a custom comparator function.

Implementacja
public function get usingCustomCompareFunction():Boolean

Konstruktor Szczegół

()

Konstruktor

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Constructor.

Parametry

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

Szczegół metody

initializeDefaultCompareFunction

()

metoda

public function initializeDefaultCompareFunction(obj:Object):void

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

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

()

metoda

public function reverse():void

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Informacje prawne | Zasady prywatności online

SortField - AS3 Flex

Klasy x

arraySortOnOptions

caseInsensitive

compareFunction

descending

name

numeric

usingCustomCompareFunction

SortField

initializeDefaultCompareFunction

reverse