用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: AIR 30.0 和更早版本, Flash Player 30.0 和更早版本, Flash Lite 4
Flex 4.6 和更早版本, Flash Pro CS6 和更早版本
隐藏过滤条件
mx.collections 

ISortField  - AS3 Flex

mx.collections
接口public interface ISortField
实现器 SortField, SortField

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

ISortField 接口定义与 ISort 类一起使用的类的接口,以提供对集合视图中的特定字段或属性进行排序所需要的排序信息。



公共属性
 属性由以下参数定义
  arraySortOnOptions : int
[只读] 此帮助器属性由 findItem() 和 sort() 方法内部使用。
ISortField
  compareFunction : Function
用于在对关联集合的项目进行排序时比较两个项目的函数。
ISortField
  descending : Boolean
指定此字段是否应按降序排序。
ISortField
  name : String
要排序的字段的名称。
ISortField
  numeric : Object
指定当要进行排序的字段包含数值 (number/int/uint) 或数值的字符串表示形式时,比较运算符是否使用数值比较。
ISortField
  usingCustomCompareFunction : Boolean
[只读] 如果此 ISortField 使用自定义比较运算符函数,则为 true。
ISortField
公共方法
 方法由以下参数定义
  
设置默认比较函数以执行比较时,Sort 类将根据以下三项内容之一来调用帮助器函数:是否已设置自定义比较函数、指定字段的数据类型或 numeric 属性的值。
ISortField
  
反转此排序字段的条件。
ISortField
属性详细信息

arraySortOnOptions

属性
arraySortOnOptions:int  [只读]

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

此帮助器属性由 findItem()sort() 方法内部使用。不支持该属性的其它用法。如果 Sort 类不使用此 ISortField 对字段进行排序,则返回 -1(没有 compareFunction 或没有名称)。否则,返回排序选项的位掩码。



实现
    public function get arraySortOnOptions():int

compareFunction

属性 
compareFunction:Function

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

用于在对关联集合的项目进行排序时比较两个项目的函数。如果指定了 ISort 对象中的 compareFunction 属性,则 Flex 会忽略 ISort 的 ISortField 对象的所有 compareFunction 属性。

该比较函数必须具有以下签名:

function myCompare(a:Object, b:Object):int

此函数返回以下值:

  • -1,如果在已排序序列中 a 应显示在 b 之前
  • 0,如果 a 等于 b
  • 1,如果在已排序序列中 a 应显示在 b 之后



实现
    public function get compareFunction():Function
    public function set compareFunction(value:Function):void

descending

属性 
descending:Boolean

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

指定此字段是否应按降序排序。

默认值为 false(升序)。



实现
    public function get descending():Boolean
    public function set descending(value:Boolean):void

name

属性 
name:String

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

要排序的字段的名称。



实现
    public function get name():String
    public function set name(value:String):void

numeric

属性 
numeric:Object

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

指定当要进行排序的字段包含数值 (number/int/uint) 或数值的字符串表示形式时,比较运算符是否使用数值比较。

未提供自定义比较函数的情况下,SortField 类会使用该属性。

如果该属性为 true,则会使用内置数值比较函数。比较前每个数据项调度给 Number() 函数。

如果该属性为 false,则会使用内置字符串比较函数。比较前每个数据项调度给 String() 函数。

如果此属性为 null,则内部检查第一个数据项以查看它是否为数字或字符串,并基于内部检查结果继续进行排序。

默认值为 null。



实现
    public function get numeric():Object
    public function set numeric(value:Object):void

usingCustomCompareFunction

属性 
usingCustomCompareFunction:Boolean  [只读]

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

如果此 ISortField 使用自定义比较运算符函数,则为 true。



实现
    public function get usingCustomCompareFunction():Boolean
方法详细信息

initializeDefaultCompareFunction

()方法
public function initializeDefaultCompareFunction(obj:Object):void

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

设置默认比较函数以执行比较时,Sort 类将根据以下三项内容之一来调用帮助器函数:是否已设置自定义比较函数、指定字段的数据类型或 numeric 属性的值。如果 numeric 属性为 true,将在排序时执行数字比较。

参数

obj:Object — 包含数据的对象。如果已通过 name 属性设置了字段名称,则将使用该名称访问此对象的数据值。否则,将使用对象本身作为数据值。

reverse

()方法 
public function reverse():void

语言版本: ActionScript 3.0
产品版本: Flex 4.5
运行时版本: Flash Player 9, AIR 1.1

反转此排序字段的条件。例如,如果该字段原来按降序排序,则现在按升序排序。

注意:修改 ISortFields 时不会自动更新 ICollectionView;而调用 refresh() 方法可更新此视图。





[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。