Paket | mx.collections |
Sınıf | public class SortField |
Miras Alma | SortField EventDispatcher Object |
Uygular | ISortField |
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | Flash Player 9, AIR 1.1 |
Flex 4.5 sürümünden itibaren, Adobe bu sınıfa alternatif olarak spark.collections.SortField sınıfını kullanmanızı önerir. |
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.
The <mx:SortField>
tag has the following attributes:
<mx:SortField Properties caseInsensitive="false" compareFunction="Internal compare function" descending="false" name="null" numeric="null" />
İlgili API Öğeleri
Özellik | Tanımlayan: | ||
---|---|---|---|
arraySortOnOptions : int [salt okunur]
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
Belirli bir nesne örneği için sınıf nesnesine veya yapıcı işlevine bir başvuru. | 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 [salt okunur]
True if this ISortField uses a custom comparator function. | SortField |
Yöntem | Tanımlayan: | ||
---|---|---|---|
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
EventDispatcher nesnesi olan bir olay dinleyici nesnesini, dinleyicinin bir olayın bildirimini alması için kaydeder. | EventDispatcher | ||
Olay akışına bir olay gönderir. | EventDispatcher | ||
EventDispatcher nesnesinin belirli bir olay türü için kayıtlı dinleyicisi olup olmadığını kontrol eder. | EventDispatcher | ||
Bir nesnenin belirli bir özelliğinin tanımlı olup olmadığını gösterir. | 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 | ||
Object sınıfının bir örneğinin parametre olarak belirtilen nesnenin prototip zincirinde olup olmadığını gösterir. | Object | ||
Belirtilen özelliğin bulunup bulunmadığını ve numaralandırılabilir olup olmadığını gösterir. | Object | ||
EventDispatcher nesnesinden bir dinleyiciyi kaldırır. | EventDispatcher | ||
Reverse the criteria for this sort field. | SortField | ||
Dinamik bir özelliğin döngü işlemlerinde kullanılabilirliğini ayarlar. | Object | ||
Bu nesnenin, yerel ayara özel kurallara göre biçimlendirilmiş dize temsilini döndürür. | Object | ||
Belirtilen nesnenin dize olarak temsil edilen halini döndürür. | Object | ||
Belirtilen nesnenin temel değerini döndürür. | Object | ||
Bir olay dinleyicisinin bu EventDispatcher nesnesiyle mi, yoksa onun belirtilen olay türüne yönelik üst öğelerinden biriyle mi kayıtlı olduğunu kontrol eder. | EventDispatcher |
arraySortOnOptions | özellik |
arraySortOnOptions:int
[salt okunur] Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | 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..
Uygulama
public function get arraySortOnOptions():int
caseInsensitive | özellik |
caseInsensitive:Boolean
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | Flash Player 9, AIR 1.1 |
Specifies whether the sort for this field should be case insensitive.
Varsayılan değer şudur false.
Bu özellik veri ciltleme kaynağı olarak kullanılabilir. Bu özellik değiştirildiğinde, caseInsensitiveChanged
olayını gönderir.
Uygulama
public function get caseInsensitive():Boolean
public function set caseInsensitive(value:Boolean):void
compareFunction | özellik |
compareFunction:Function
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | 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 beforeb
in the sorted sequence - 0, if
a
equalsb
- 1, if
a
should appear afterb
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 thespark.collections.SortField
class.
Uygulama
public function get compareFunction():Function
public function set compareFunction(value:Function):void
İlgili API Öğeleri
descending | özellik |
descending:Boolean
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | Flash Player 9, AIR 1.1 |
Specifies whether this field should be sorted in descending order.
The default value is false
(ascending).
Bu özellik veri ciltleme kaynağı olarak kullanılabilir. Bu özellik değiştirildiğinde, descendingChanged
olayını gönderir.
Uygulama
public function get descending():Boolean
public function set descending(value:Boolean):void
name | özellik |
name:String
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | Flash Player 9, AIR 1.1 |
The name of the field to be sorted.
Varsayılan değer şudur null.
Bu özellik veri ciltleme kaynağı olarak kullanılabilir. Bu özellik değiştirildiğinde, nameChanged
olayını gönderir.
Uygulama
public function get name():String
public function set name(value:String):void
numeric | özellik |
numeric:Object
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | 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.
Varsayılan değer şudur null.
Bu özellik veri ciltleme kaynağı olarak kullanılabilir. Bu özellik değiştirildiğinde, numericChanged
olayını gönderir.
Uygulama
public function get numeric():Object
public function set numeric(value:Object):void
usingCustomCompareFunction | özellik |
SortField | () | Yapıcı |
public function SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null)
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | Flash Player 9, AIR 1.1 |
Constructor.
Parametrelername: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.
|
initializeDefaultCompareFunction | () | yöntem |
public function initializeDefaultCompareFunction(obj:Object):void
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | 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.
Parametreler
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 | () | yöntem |
public function reverse():void
Dil Sürümü: | ActionScript 3.0 |
Ürün Sürümü: | Flex 3 |
Çalışma Zamanı Sürümleri: | 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, 01:09 PM Z