Packagecom.adobe.bridge
Classpublic class SearchCriteria
InheritanceSearchCriteria Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Passed to Adobe Bridge to populate the Find dialog. Encapsulates one search criterion for a search among handled nodes. Your node handler can define possible search criteria for your nodes by creating these objects and passing them to Adobe Bridge in a SearchDefinition object, during the call to the node's ExtensionModel.getSearchDefinition() method. Each object corresponds to one line in the Criteria box of the Find dialog. The left side is a property associated with possible matching nodes, called the search field The middle value is the comparison operator The right side is the comparison value, or operand (some operators, such as "exists", do not require an operand) For each node in the scope, a search that uses a selected criterion matches the selected search-field value against the operand using the selected comparison operator. This object specifies the left and right sides. By default, all of the predefined operators are displayed for user selection. You can use this object to limit which of these operators are available for selection. The user's choices in the dialog are returned to Adobe Bridge in a set of a SearchCondition objects contained in a SearchSpecification object.



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  operands : Array
One or more Operand objects used to populate the drop-down list for the right-side field of this line in the Find dialog.
SearchCriteria
  operandType : String
The data type of the operand values.
SearchCriteria
  operatorTypesToDisable : Array
A set of predefined operator strings that are not displayed for selection.
SearchCriteria
  searchField : String
A search field, the name of some property associated with the search node.
SearchCriteria
  searchFieldDisplay : String
A localized display name for the search field, displayed in the Find dialog.
SearchCriteria
  searchFieldSort : Boolean
Whether searchfield display names are sorted alphabetically in the Find dialog.
SearchCriteria
Public Methods
 MethodDefined By
  
SearchCriteria(searchField:String = null, operandType:String = null, searchFieldDisplay:String = null, operands:Array = null)
SearchCriteria
 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]
SearchCriteria
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
operandsproperty
operands:Array

Since : CS5

One or more Operand objects used to populate the drop-down list for the right-side field of this line in the Find dialog.


Implementation
    public function get operands():Array
    public function set operands(value:Array):void
operandTypeproperty 
operandType:String

Since : CS5

The data type of the operand values.


Implementation
    public function get operandType():String
    public function set operandType(value:String):void
operatorTypesToDisableproperty 
operatorTypesToDisable:Array

Since : CS5

A set of predefined operator strings that are not displayed for selection.


Implementation
    public function get operatorTypesToDisable():Array
    public function set operatorTypesToDisable(value:Array):void
searchFieldproperty 
searchField:String

Since : CS5

A search field, the name of some property associated with the search node.


Implementation
    public function get searchField():String
    public function set searchField(value:String):void
searchFieldDisplayproperty 
searchFieldDisplay:String

Since : CS5

A localized display name for the search field, displayed in the Find dialog. .


Implementation
    public function get searchFieldDisplay():String
    public function set searchFieldDisplay(value:String):void
searchFieldSortproperty 
searchFieldSort:Boolean

Since : CS5

Whether searchfield display names are sorted alphabetically in the Find dialog.


Implementation
    public function get searchFieldSort():Boolean
    public function set searchFieldSort(value:Boolean):void
Constructor Detail
SearchCriteria()Constructor
public function SearchCriteria(searchField:String = null, operandType:String = null, searchFieldDisplay:String = null, operands:Array = null)

Since : CS5

Parameters
searchField:String (default = null) — (String)
 
operandType:String (default = null) — (String)
 
searchFieldDisplay:String (default = null) — (String)
 
operands:Array (default = null) — (Array)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array