Packagecom.adobe.bridge
Classpublic class Rank
InheritanceRank Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

A SearchDefinition object can limit the number of results to return, and, if results are limited, it can define a set of possible properties to use in ranking results. Adobe Bridge sorts result nodes by the value of the chosen rank property, and returns no more than the maximum number of result nodes with the highest rank values. When the result is displayed, the view sorts the nodes again using its sorting criteria.The attribute name and display name of a property used for ranking are encapsulated in a Rank object.An array of these objects kept in SearchDefinition.ranks. They are used to populate the Rank field that corresponds to the definition in the Find dialog. If there is more than one, the field displays a drop-down list. The rank that the user selects becomes the SearchSpecification.rankField value.



Public Properties
 PropertyDefined By
  displayName : String
The localized display name for the corresponding field in the Find dialog.
Rank
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  valueName : String
The property name for the ranking property.
Rank
Public Methods
 MethodDefined By
  
Rank(valueName:String = null, displayName:String = null)
Rank
 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]
Rank
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
displayNameproperty
displayName:String

Since : CS5

The localized display name for the corresponding field in the Find dialog.


Implementation
    public function get displayName():String
    public function set displayName(value:String):void
valueNameproperty 
valueName:String

Since : CS5

The property name for the ranking property.


Implementation
    public function get valueName():String
    public function set valueName(value:String):void
Constructor Detail
Rank()Constructor
public function Rank(valueName:String = null, displayName:String = null)

Since : CS5

Parameters
valueName: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