| Paquete | mx.collections |
| Clase | public class SortField |
| Herencia | SortField  EventDispatcher Object |
| Implementa | ISortField |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
 | Desde Flex 4.5, Adobe recomienda la utilización de la clase spark.collections.SortField como una alternativa a esta clase. |
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;
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.
Mostrar sintaxis MXML
Ocultar sintaxis MXMLThe <mx:SortField> tag has the following attributes:
<mx:SortField Properties caseInsensitive="false" compareFunction="Internal compare function" descending="false" name="null" numeric="null" />
Elementos de API relacionados
| Propiedad | Definido por | ||
|---|---|---|---|
| arraySortOnOptions : int [solo lectura]
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
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | 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 [solo lectura]
True if this ISortField uses a custom comparator function. | SortField | ||
| 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 un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | |
|
Distribuye un evento en el flujo del evento. | EventDispatcher | |
|
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | |
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
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 | ||
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Elimina un detector del objeto EventDispatcher. | EventDispatcher | |
Reverse the criteria for this sort field. | SortField | ||
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
|
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | EventDispatcher | |
arraySortOnOptions | propiedad |
arraySortOnOptions:int [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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..
Implementación
public function get arraySortOnOptions():intcaseInsensitive | propiedad |
caseInsensitive:Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Specifies whether the sort for this field should be case insensitive.
El valor predeterminado es false.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento caseInsensitiveChanged .
Implementación
public function get caseInsensitive():Boolean public function set caseInsensitive(value:Boolean):voidcompareFunction | propiedad |
compareFunction:Function| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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
ashould appear beforebin the sorted sequence - 0, if
aequalsb - 1, if
ashould appear afterbin 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 thespark.collections.SortField class.
Implementación
public function get compareFunction():Function public function set compareFunction(value:Function):voidElementos de API relacionados
descending | propiedad |
descending:Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Specifies whether this field should be sorted in descending order.
The default value is false (ascending).
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento descendingChanged .
Implementación
public function get descending():Boolean public function set descending(value:Boolean):voidname | propiedad |
name:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The name of the field to be sorted.
El valor predeterminado es null.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento nameChanged .
Implementación
public function get name():String public function set name(value:String):voidnumeric | propiedad |
numeric:Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es null.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento numericChanged .
Implementación
public function get numeric():Object public function set numeric(value:Object):voidusingCustomCompareFunction | propiedad |
usingCustomCompareFunction:Boolean [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
True if this ISortField uses a custom comparator function.
Implementación
public function get usingCustomCompareFunction():BooleanSortField | () | Información sobre |
public function SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null)| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Constructor.
Parámetrosname:String (default = null)null.
| |
caseInsensitive:Boolean (default = false) | |
descending:Boolean (default = false) | |
numeric:Object (default = null) |
initializeDefaultCompareFunction | () | método |
public function initializeDefaultCompareFunction(obj:Object):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | 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.
Tue Jun 12 2018, 02:12 PM Z