Adobe® Flash® Platform için ActionScript® 3.0 Başvurusu
Ana Sayfa  |  Paket ve Sınıf Listesini Gizle |  Paketler  |  Sınıflar  |  Yenilikler  |  Dizin  |  Ekler  |  Niçin İngilizce?
Filtreler: Sunucudan Veri Alınıyor...
Sunucudan Veri Alınıyor...
spark.collections 

SortField  - AS3 Flex

Paketspark.collections
Sınıfpublic class SortField
Miras AlmaSortField Inheritance AdvancedStyleClient Inheritance EventDispatcher Inheritance Object
Uygular ISortField

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

Provides the sorting information required to establish a sort on a field or property in a collection view. SortField class is meant to be used with 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();
     var sortfield:SortField = new SortField("first", true);
     sortfield.setStyle("locale", "en-US");
     sort.fields = [sortfield];
     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();
     var sortfield:SortField = new SortField(null, true);
     sortfield.setStyle("locale", "en-US");
     sort.fields = [sortfield];
     col.sort = sort;
  

The default comparison provided by the SortField class provides correct language specific sorting for strings. The language is selected by the setting the locale style on an instance of the class in one of the following ways:

  • By using the class in an MXML declaration and inheriting the locale from the document that contains the declaration.
  • Example:
      <fx:Declarations> 
             <s:SortField id="sf" /> 
      </fx:Declarations>
      
  • By using an MXML declaration and specifying the locale value in the list of assignments.
  • Example:
      <fx:Declarations> 
          <s:SortField id="sf_SimplifiedChinese" locale="zh-Hans-CN" /> 
      </fx:Declarations>
      
  • Calling the setStyle method, e.g. sf.setStyle("locale", "zh-Hans-CN")
  • Inheriting the style from a UIComponent by calling the UIComponent's addStyleClient() method.

MXML SözdizimiexpandedMXML Sözdizimini Gizle

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

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

Örnekleri görüntüle

İlgili API Öğeleri



Genel Özellikler
 ÖzellikTanımlayan:
  arraySortOnOptions : int
[salt okunur] This helper property is used internally by the findItem() and sort() methods.
SortField
 InheritedclassName : String
[salt okunur] The name of the component class.
AdvancedStyleClient
  compareFunction : Function
The function that compares two items during a sort of items for the associated collection.
SortField
 Inheritedconstructor : 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
 Inheritedid : String
The identity of the component.
AdvancedStyleClient
 InheritedinheritingStyles : Object
An object containing the inheritable styles for this non-visual style client instance.
AdvancedStyleClient
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for finding the style manager that controls the styles for this non-visual style client instance.
AdvancedStyleClient
  name : String
The name of the field to be sorted.
SortField
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
AdvancedStyleClient
  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
 InheritedstyleDeclaration : CSSStyleDeclaration
The style declaration that holds the inline styles declared by this object.
AdvancedStyleClient
 InheritedstyleManager : IStyleManager2
[salt okunur] Returns the StyleManager instance used by this component.
AdvancedStyleClient
 InheritedstyleName : Object
The source of this object's style values.
AdvancedStyleClient
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
AdvancedStyleClient
  usingCustomCompareFunction : Boolean
[salt okunur] True if this ISortField uses a custom comparator function.
SortField
Genel Yöntemler
 YöntemTanımlayan:
  
SortField(name:String = null, descending:Boolean = false, numeric:Object = null)
Constructor.
SortField
 Inherited
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
 Inherited
Deletes a style property from this component instance.
AdvancedStyleClient
 Inherited
Olay akışına bir olay gönderir.
EventDispatcher
 Inherited
Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.
AdvancedStyleClient
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
AdvancedStyleClient
 Inherited
Returns true if currentCSSState is not null.
AdvancedStyleClient
 Inherited
EventDispatcher nesnesinin belirli bir olay türü için kayıtlı dinleyicisi olup olmadığını kontrol eder.
EventDispatcher
 Inherited
Bir nesnenin belirli bir özelliğinin tanımlı olup olmadığını gösterir.
Object
 Inherited
The initialized method is called when this class or a class that extends this class is used in an MXML declaration.
AdvancedStyleClient
  
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
 Inherited
Object sınıfının bir örneğinin parametre olarak belirtilen nesnenin prototip zincirinde olup olmadığını gösterir.
Object
 Inherited
Returns true if cssState matches currentCSSState.
AdvancedStyleClient
 Inherited
Determines whether this instance is the same as, or is a subclass of, the given type.
AdvancedStyleClient
 Inherited
Propagates style changes to the children of this style client instance.
AdvancedStyleClient
 Inherited
Belirtilen özelliğin bulunup bulunmadığını ve numaralandırılabilir olup olmadığını gösterir.
Object
 Inherited
Sets up the internal style cache values so that the getStyle() method functions.
AdvancedStyleClient
 Inherited
Registers the EffectManager as one of the event listeners for each effect event.
AdvancedStyleClient
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher nesnesinden bir dinleyiciyi kaldırır.
EventDispatcher
  
Reverse the criteria for this sort field.
SortField
 Inherited
Dinamik bir özelliğin döngü işlemlerinde kullanılabilirliğini ayarlar.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
AdvancedStyleClient
 Inherited
Detects changes to style properties.
AdvancedStyleClient
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
AdvancedStyleClient
 Inherited
Bu nesnenin, yerel ayara özel kurallara göre biçimlendirilmiş dize temsilini döndürür.
Object
 Inherited
Belirtilen nesnenin dize olarak temsil edilen halini döndürür.
Object
 Inherited
Belirtilen nesnenin temel değerini döndürür.
Object
 Inherited
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
Olaylar
 Olay Özet Tanımlayan:
 Inherited[broadcast olayı] Flash Player veya AIR uygulaması işletim sistemi odağına gelip etkin olduğunda gönderilir.EventDispatcher
 Inherited[broadcast olayı] Çalışan Flash Player veya AIR uygulaması sistem odağını kaybettiğinde ve etkin olmayan duruma geldiğinde gönderilir.EventDispatcher
Stiller

Stiller ortaktır veya belirli bir temayla ilişkilendilir. Stil ortak değilse herhangi bir temayla ilişkilendirilebilir. Stil belirli bir temayla ilişkilendirilirse, yalnızca uygulamanızın o temayı kullanması durumunda kullanılabilir.

Yaygın Stiller
 Stil Açıklama Tanımlayan:
  
locale
Tür: String CSS Mirası: Evet
Dil Sürümü: ActionScript 3.0  Ürün Sürümü: Flex 4.5  Çalışma Zamanı Sürümleri: Flash10.1, AIR 2.5

The locale identifier that specifies the language, region, script and optionally other related tags and keys. The syntax of this identifier must follow the syntax defined by the Unicode Technical Standard #35 (for example, en-US, de-DE, zh-Hans-CN).

For browser based apps, the default locale is based on the language settings from the browser. (Note that this is not the browser UI language that is available from Javascript, but rather is the list of preferred locales for web pages that the user has set in the browser preferences.) For AIR applications, the default UI locale is based on the user's system preferences.

Daha fazla bilgi

SortField
Özellik Ayrıntısı

arraySortOnOptions

özellik
arraySortOnOptions:int  [salt okunur]

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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

compareFunction

özellik 
compareFunction:Function

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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 the Object a should appear before the Object b in the sorted sequence
  • 0, if the Object a equals the Object b
  • 1, if the Object a should appear after the Object 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. The string comparison is performed using the locale (language, region and script) specific comparison method from the SortingCollator class. This class uses the locale style to determine a locale 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.



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

descending

özellik 
descending:Boolean

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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 
usingCustomCompareFunction:Boolean  [salt okunur]

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

True if this ISortField uses a custom comparator function.



Uygulama
    public function get usingCustomCompareFunction():Boolean
Yapıcı Ayrıntı

SortField

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

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

Constructor.

Parametreler
name:String (default = null) — The name of the property that this field uses for comparison. If the object is a simple type, pass null.
 
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.
Yöntem Ayrıntısı

initializeDefaultCompareFunction

()yöntem
public function initializeDefaultCompareFunction(obj:Object):void

Dil Sürümü: ActionScript 3.0
Ürün Sürümü: Flex 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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 4.5
Çalışma Zamanı Sürümleri: Flash Player 10.1, AIR 2.5

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.

SortExample1.mxml
<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
               xmlns:s="library://ns.adobe.com/flex/spark" 
               xmlns:mx="library://ns.adobe.com/flex/mx" 
               minWidth="955" minHeight="600">
    <!-- Sample program for spark.collections.Sort and SortField --> 
    <fx:Declarations>
        <s:Sort id="sortbyLastName_FirstName">
            <s:fields>
                <s:SortField name="last"/>
                <s:SortField name="first"/>
            </s:fields>
        </s:Sort>
        <mx:ArrayCollection id="collection" sort="{sortbyLastName_FirstName}">
            <mx:source>
                <fx:Object first="Anders" last="Dickerson"/>
                <fx:Object first="Eileen" last="Maccormick"/>
                <fx:Object first="Aiden" last="MacCormick"/>
                <fx:Object first="Steve" last="MacGregor"/>
            </mx:source>
        </mx:ArrayCollection>
    </fx:Declarations>
    
    <s:VGroup>
        <s:VGroup>
            <s:HGroup>
                <s:Label text="Input Locale ID Name: "/>
                <s:TextInput id="inputLocaleIDName"/>
                <!-- 
                Sets the locale style on the document UI component.
                The SortField and Sort objects defined in the 
                fx:Declarations section will inherit this style.
                -->
                <s:Button click="{setStyle('locale', inputLocaleIDName.text); 
                          collection.refresh()}" label="Apply"/>
            </s:HGroup>
            <s:Label text="Example: 'en-US', 'fr-FR', 'zh-CN', 'ar-SA'"/>
        </s:VGroup>
        <s:DataGrid dataProvider="{collection}" width="100%"
                     creationComplete="{collection.refresh()}">
            <s:columns>
                <s:ArrayList>
                    <s:GridColumn dataField="last"/>
                    <s:GridColumn dataField="first"/>
                </s:ArrayList>
            </s:columns>
        </s:DataGrid>
    </s:VGroup>
</s:Application>
SortExample2.mxml
<?xml version="1.0" encoding="utf-8"?>
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
               xmlns:s="library://ns.adobe.com/flex/spark" 
               xmlns:mx="library://ns.adobe.com/flex/mx" 
               minWidth="955" minHeight="600"
               creationComplete="initApp()">
    <!-- Sample program for spark.collections.Sort and SortField -->    
    <fx:Script>
        <![CDATA[
            import mx.collections.ArrayCollection;
            import spark.collections.*;
            [Bindable]
            private var collection:ArrayCollection = new ArrayCollection();
            
            private function localeChange():void
            {
                // Sets the locale style on this application.
                // The SortField objects will inherit this style.
                setStyle('locale', inputLocaleIDName.text);
                collection.refresh();
            }

            private function initApp() : void
            {
                // Add data to the collection.
                collection.addItem({first:"Anders", last:"Dickerson"});
                collection.addItem({first:"Steve", last:"Maccormick"});
                collection.addItem({first:"Aiden", last:"MacCormick"});
                collection.addItem({first:"Eileen", last:"MacGregor"});
                
                // Create the Sort instance.
                var sort:Sort = new Sort();
                
                // Set the sort field; sort on the last name first, first name 
                // second.
                var sortfieldLastName:SortField = new SortField("last",true);
                var sortfieldFirstName:SortField = new SortField("first",true);
                sort.fields = [sortfieldLastName, sortfieldFirstName];
                
                // Add the sort field objects to this application's list of
                // style clients.  This will cause the sort field objects to 
                // inherit the locale style from this Application. 
                addStyleClient(sortfieldLastName);
                addStyleClient(sortfieldFirstName);
                
                // Assign the Sort object to the view.
                collection.sort = sort;
                
                // Apply the sort to the collection.
                collection.refresh();
            }
        ]]>
    </fx:Script>
    
    <s:VGroup>
        <s:VGroup>
            <s:HGroup>
                <s:Label text="Input Locale ID Name: "/>
                <s:TextInput id="inputLocaleIDName"/>
                <s:Button click="localeChange()" label="Apply"/>
            </s:HGroup>
            <s:Label text="Example: 'en-US', 'fr-FR', 'zh-CN', 'ar-SA'"/>
        </s:VGroup>
        
        <s:DataGrid dataProvider="{collection}" width="100%"
                     creationComplete="{collection.refresh()}">
            <s:columns>
                <s:ArrayList>
                    <s:GridColumn dataField="last"/>
                    <s:GridColumn dataField="first"/>
                </s:ArrayList>
            </s:columns>
        </s:DataGrid>
    </s:VGroup>
</s:Application>




[ X ]Niçin İngilizce?
ActionScript 3.0 Başvurusu'ndaki içerik İngilizce görünür

ActionScript 3.0 Başvurusu'nun tüm bölümleri tüm dillere çevrilmemiştir. Bir dil öğesi çevrilmediğinde İngilizce görünür. Örneğin, ga.controls.HelpBox sınıfı hiçbir dile çevrilmez. Bu nedenle, başvurunun Türkçe versiyonunda ga.controls.HelpBox sınıfı İngilizce görünür.