SortField

Pacote	mx.collections
Classe	public class SortField
Herança	SortField EventDispatcher Object
Implementações	ISortField

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Ao iniciar com Flex 4.5, a Adobe recomenda que você use a classe de spark.collections.SortField como uma alternativa a esta classe.

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.

Sintaxe MXML expanded

Ocultar sintaxe MXML

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

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

Elementos da API relacionados

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

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		arraySortOnOptions : int [somente leitura] 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 Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	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 [somente leitura] True if this ISortField uses a custom comparator function.	SortField

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		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 Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	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 Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		reverse():void Reverse the criteria for this sort field.	SortField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Evento		Resumo	Definido por
		activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
		deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher

Detalhes da propriedade

arraySortOnOptions

propriedade

arraySortOnOptions:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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

Implementação
public function get arraySortOnOptions():int

caseInsensitive

propriedade

caseInsensitive:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

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

O valor padrão é false.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento caseInsensitiveChanged .

Implementação
public function get caseInsensitive():Boolean
public function set caseInsensitive(value:Boolean):void

compareFunction

propriedade

compareFunction:Function

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Implementação
public function get compareFunction():Function
public function set compareFunction(value:Function):void

Elementos da API relacionados

spark.collections.SortField

descending

propriedade

descending:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies whether this field should be sorted in descending order.

The default value is false (ascending).

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento descendingChanged .

Implementação
public function get descending():Boolean
public function set descending(value:Boolean):void

name

propriedade

name:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

The name of the field to be sorted.

O valor padrão é null.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento nameChanged .

Implementação
public function get name():String
public function set name(value:String):void

numeric

propriedade

numeric:Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

O valor padrão é null.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento numericChanged .

Implementação
public function get numeric():Object
public function set numeric(value:Object):void

usingCustomCompareFunction

propriedade

usingCustomCompareFunction:Boolean [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

True if this ISortField uses a custom comparator function.

Implementação
public function get usingCustomCompareFunction():Boolean

Detalhes do construtor

()

Construtor

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Constructor.

Parâmetros

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

Detalhes do método

initializeDefaultCompareFunction

()

método

public function initializeDefaultCompareFunction(obj:Object):void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Parâmetros

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

()

método

public function reverse():void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Aspectos jurídicos | Política de privacidade on-line

SortField - AS3 Flex

Classes x

arraySortOnOptions

caseInsensitive

compareFunction

descending

name

numeric

usingCustomCompareFunction

SortField

initializeDefaultCompareFunction

reverse