SortField

Paket	mx.collections
Klass	public class SortField
Arv	SortField EventDispatcher Object
Implementerar	ISortField

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Med början från Flex 4.5, rekommenderar Adobe att du använder klassen spark.collections.SortField som ett alternativ till den här klassen.

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

Dölj MXML-syntax

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

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

Relaterade API-element

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

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		arraySortOnOptions : int [skrivskyddad] 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 En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	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 [skrivskyddad] True if this ISortField uses a custom comparator function.	SortField

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		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 Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.	EventDispatcher
		dispatchEvent(event:Event):Boolean Skickar en händelse till händelseflödet.	EventDispatcher
		hasEventListener(type:String):Boolean Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.	EventDispatcher
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	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 Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.	Object
		propertyIsEnumerable(name:String):Boolean Anger om den angivna egenskapen finns och är uppräkningsbar.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		reverse():void Reverse the criteria for this sort field.	SortField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	Object
		toLocaleString():String Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object
		willTrigger(type:String):Boolean Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.	EventDispatcher

Händelser

Klicka för mer information om händelser

Dölj ärvda händelser

Visa ärvda händelser

	Händelse		Sammanfattning	Definieras med
		activate	[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.	EventDispatcher
		deactivate	[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.	EventDispatcher

Egenskapsdetaljer

arraySortOnOptions

egenskap

arraySortOnOptions:int [skrivskyddad]

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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

Implementering
public function get arraySortOnOptions():int

caseInsensitive

egenskap

caseInsensitive:Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

Standardvärdet är false.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen caseInsensitiveChanged .

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

compareFunction

egenskap

compareFunction:Function

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

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

Relaterade API-element

spark.collections.SortField

descending

egenskap

descending:Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Specifies whether this field should be sorted in descending order.

The default value is false (ascending).

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen descendingChanged .

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

name

egenskap

name:String

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

The name of the field to be sorted.

Standardvärdet är null.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen nameChanged .

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

numeric

egenskap

numeric:Object

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Standardvärdet är null.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen numericChanged .

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

usingCustomCompareFunction

egenskap

usingCustomCompareFunction:Boolean [skrivskyddad]

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

True if this ISortField uses a custom comparator function.

Implementering
public function get usingCustomCompareFunction():Boolean

Konstruktordetaljer

()

Konstruktor

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Constructor.

Parametrar

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

Metoddetaljer

initializeDefaultCompareFunction

()

metod

public function initializeDefaultCompareFunction(obj:Object):void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Parametrar

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

()

metod

public function reverse():void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Juridiska meddelanden | Onlinesekretesspolicy

SortField - AS3 Flex

Klasser x

arraySortOnOptions

caseInsensitive

compareFunction

descending

name

numeric

usingCustomCompareFunction

SortField

initializeDefaultCompareFunction

reverse