Packagecom.adobe.bridge
Classpublic class SortCriterion
InheritanceSortCriterion Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Sorting compares the values of a property associated with the displayed nodes. This object identifies that property, which can be in handler-defined node data (that is, defined in an Infoset object), or defined in embedded XMP metadata.When Adobe Bridge enters a container node, it calls the node's ExtensionModel.getSortCriteria() method, which returns a list of these objects. The method can supply a completely new list, or can get the default list from app.defaultSortCriteria and modify it, append to it, or return it unchanged.



Public Properties
 PropertyDefined By
  displayName : String
A localized display name for this sorting criterion.
SortCriterion
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  infosetMember : String
The name of an Infoset property by which to sort.
SortCriterion
  name : String
The unique identifying name of this sort criterion.
SortCriterion
  type : String
The data type of the criterion property.
SortCriterion
  xmpNamespace : String
The namespace portion of an XMP property by which to sort.
SortCriterion
  xmpUri : String
The URI key portion of an XMP property by which to sort.
SortCriterion
Public Methods
 MethodDefined By
  
SortCriterion(name:String = null, type:String = null, xmpNamespace:String = null, xmpUri:String = null, displayName:String = null)
SortCriterion
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
  
createWithArgs(args:Array):void
[override]
SortCriterion
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
displayNameproperty
displayName:String

Since : CS5

A localized display name for this sorting criterion.


Implementation
    public function get displayName():String
    public function set displayName(value:String):void
infosetMemberproperty 
infosetMember:String

Since : CS5

The name of an Infoset property by which to sort.


Implementation
    public function get infosetMember():String
    public function set infosetMember(value:String):void
nameproperty 
name:String

Since : CS5

The unique identifying name of this sort criterion.


Implementation
    public function get name():String
    public function set name(value:String):void
typeproperty 
type:String

Since : CS5

The data type of the criterion property.


Implementation
    public function get type():String
    public function set type(value:String):void
xmpNamespaceproperty 
xmpNamespace:String

Since : CS5

The namespace portion of an XMP property by which to sort.


Implementation
    public function get xmpNamespace():String
    public function set xmpNamespace(value:String):void
xmpUriproperty 
xmpUri:String

Since : CS5

The URI key portion of an XMP property by which to sort.


Implementation
    public function get xmpUri():String
    public function set xmpUri(value:String):void
Constructor Detail
SortCriterion()Constructor
public function SortCriterion(name:String = null, type:String = null, xmpNamespace:String = null, xmpUri:String = null, displayName:String = null)

Since : CS5

Parameters
name:String (default = null) — (String)
 
type:String (default = null) — (String)
 
xmpNamespace:String (default = null) — (String)
 
xmpUri:String (default = null) — (String)
 
displayName:String (default = null) — (String)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array