Packagecom.adobe.bridge
Classpublic class SearchDefinition
InheritanceSearchDefinition Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Passed to Adobe Bridge to populate the Find dialog. Provides a way for Adobe Bridge extensions to specify how the Adobe Bridge Find dialog should be populated for a search among handled nodes. It specifies possible search criteria, and result scope and ranking criteria. If the user invokes the Find dialog for a handled node, the dialog calls the the node's ExtensionModel.getSearchDefinition() method. Your node-handling extension must define this method to return a SearchDefinition object that can be used to populate Find dialog. When a user clicks Find in the Find dialog, Adobe Bridge uses the dialog selections to create a SearchSpecification object, which, together with a target node, specifies a search.



Public Properties
 PropertyDefined By
  criteriaList : Array
A collection of possible SearchCriteria objects to use for this search.
SearchDefinition
  defaultResultsLimit : Number
If non-zero, the Find dialog offers choices to limit the result set to certain sizes, and the choice defaults to this value.
SearchDefinition
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  quickSearchMenuItems : Array
SearchDefinition
  ranks : Array
A set of Rank objects to use only if the search can limit results.
SearchDefinition
  scopeSpecifiers : Array
A set of scopes used to extend or limit the scope of the search.
SearchDefinition
Public Methods
 MethodDefined By
  
SearchDefinition(criteriaList:Array = null, defaultResultsLimit:Number, ranks:Array = null, scopeSpecifiers:Array = null)
SearchDefinition
 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]
SearchDefinition
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
criteriaListproperty
criteriaList:Array

Since : CS5

A collection of possible SearchCriteria objects to use for this search.


Implementation
    public function get criteriaList():Array
    public function set criteriaList(value:Array):void
defaultResultsLimitproperty 
defaultResultsLimit:Number

Since : CS5

If non-zero, the Find dialog offers choices to limit the result set to certain sizes, and the choice defaults to this value.


Implementation
    public function get defaultResultsLimit():Number
    public function set defaultResultsLimit(value:Number):void
quickSearchMenuItemsproperty 
quickSearchMenuItems:Array

Since : CS5


Implementation
    public function get quickSearchMenuItems():Array
    public function set quickSearchMenuItems(value:Array):void
ranksproperty 
ranks:Array

Since : CS5

A set of Rank objects to use only if the search can limit results.


Implementation
    public function get ranks():Array
    public function set ranks(value:Array):void
scopeSpecifiersproperty 
scopeSpecifiers:Array

Since : CS5

A set of scopes used to extend or limit the scope of the search.


Implementation
    public function get scopeSpecifiers():Array
    public function set scopeSpecifiers(value:Array):void
Constructor Detail
SearchDefinition()Constructor
public function SearchDefinition(criteriaList:Array = null, defaultResultsLimit:Number, ranks:Array = null, scopeSpecifiers:Array = null)

Since : CS5

Parameters
criteriaList:Array (default = null) — (Array)
 
defaultResultsLimit:Number (default = NaN) — (Number)
 
ranks:Array (default = null) — (Array)
 
scopeSpecifiers:Array (default = null) — (Array)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array