SortField

Pakket	mx.collections
Klasse	public class SortField
Overerving	SortField EventDispatcher Object
Implementatie	ISortField

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

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-syntaxis expanded

MXML-syntaxis verbergen

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

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

Verwante API-elementen

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

Openbare eigenschappen

Overerfde openbare eigenschappen verbergen

Overerfde openbare eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		arraySortOnOptions : int [alleen-lezen] 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 Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie.	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 [alleen-lezen] True if this ISortField uses a custom comparator function.	SortField

Openbare methoden

Overerfde openbare methoden verbergen

Overerfde openbare methoden weergeven

	Methode		Gedefinieerd door
		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 Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt.	EventDispatcher
		dispatchEvent(event:Event):Boolean Verzendt een gebeurtenis naar de gebeurtenisstroom.	EventDispatcher
		hasEventListener(type:String):Boolean Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis.	EventDispatcher
		hasOwnProperty(name:String):Boolean Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd.	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 Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven.	Object
		propertyIsEnumerable(name:String):Boolean Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Verwijdert een listener uit het object EventDispatcher.	EventDispatcher
		reverse():void Reverse the criteria for this sort field.	SortField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in.	Object
		toLocaleString():String Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies.	Object
		toString():String Retourneert een tekenreeksrepresentatie van het opgegeven object.	Object
		valueOf():Object Retourneert de primitieve waarde van het opgegeven object.	Object
		willTrigger(type:String):Boolean Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis.	EventDispatcher

Gebeurtenissen

Klik voor meer informatie over gebeurtenissen.

Overerfde gebeurtenissen verbergen

Overerfde gebeurtenissen weergeven

	Gebeurtenis		Overzicht	Gedefinieerd door
		activate	[uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de besturingssysteemfocus krijgt en actief wordt.	EventDispatcher
		deactivate	[uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de systeemfocus verliest en inactief wordt.	EventDispatcher

Eigenschapdetails

arraySortOnOptions

eigenschap

arraySortOnOptions:int [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

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

Implementatie
public function get arraySortOnOptions():int

caseInsensitive

eigenschap

caseInsensitive:Boolean

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

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

De standaardwaarde is false.

Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis caseInsensitiveChanged verzonden.

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

compareFunction

eigenschap

compareFunction:Function

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

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.

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

Verwante API-elementen

spark.collections.SortField

descending

eigenschap

descending:Boolean

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Specifies whether this field should be sorted in descending order.

The default value is false (ascending).

Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis descendingChanged verzonden.

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

name

eigenschap

name:String

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

The name of the field to be sorted.

De standaardwaarde is null.

Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis nameChanged verzonden.

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

numeric

eigenschap

numeric:Object

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

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.

De standaardwaarde is null.

Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis numericChanged verzonden.

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

usingCustomCompareFunction

eigenschap

usingCustomCompareFunction:Boolean [alleen-lezen]

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

True if this ISortField uses a custom comparator function.

Implementatie
public function get usingCustomCompareFunction():Boolean

Constructordetails

()

Constructor

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

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Constructor.

Parameters

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

Methodedetails

initializeDefaultCompareFunction

()

methode

public function initializeDefaultCompareFunction(obj:Object):void

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

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.

Parameters

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

()

methode

public function reverse():void

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

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.

Juridische kennisgeving | Online privacybeleid

SortField - AS3 Flex

Klassen x

arraySortOnOptions

caseInsensitive

compareFunction

descending

name

numeric

usingCustomCompareFunction

SortField

initializeDefaultCompareFunction

reverse