Package | com.adobe.bridge |
Class | public class SearchSpecification |
Inheritance | SearchSpecification ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
conditionList : Array
A collection of SearchCondition objects to use for this search. | SearchSpecification | ||
conjunction : String
The search conjunction, and or or, as selected in the Find dialog. | SearchSpecification | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
maximumResults : Number
The maximum number of result nodes to return from the search. | SearchSpecification | ||
quickSearchItem : String | SearchSpecification | ||
quickSearchValue : String | SearchSpecification | ||
rankField : String
The name of a Rank object, as specified for a SearchDefinition object. | SearchSpecification | ||
rankOrdering : String
The ordering style, one of ascending (the default) or descending. | SearchSpecification | ||
scopeSpecifiers : Array
One or more Scope object name strings, as specified for a SearchDefinition object. | SearchSpecification |
Method | Defined By | ||
---|---|---|---|
SearchSpecification(conditionList:Array = null, conjunction:String = null, maximumResults:Number, rankOrdering:String = null, rankField:String = null, scopeSpecifiers:Array = null, quickSearchItem:String = null, quickSearchValue:String = null) | SearchSpecification | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | |
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
createWithArgs(args:Array):void [override] | SearchSpecification | ||
![]() | hostCreate(args:Array):void | CSHostObject |
conditionList | property |
conditionList:Array
Since : | CS5 |
A collection of SearchCondition objects to use for this search.
public function get conditionList():Array
public function set conditionList(value:Array):void
conjunction | property |
conjunction:String
Since : | CS5 |
The search conjunction, and or or, as selected in the Find dialog.
public function get conjunction():String
public function set conjunction(value:String):void
maximumResults | property |
maximumResults:Number
Since : | CS5 |
The maximum number of result nodes to return from the search.
public function get maximumResults():Number
public function set maximumResults(value:Number):void
quickSearchItem | property |
quickSearchItem:String
Since : | CS5 |
public function get quickSearchItem():String
public function set quickSearchItem(value:String):void
quickSearchValue | property |
quickSearchValue:String
Since : | CS5 |
public function get quickSearchValue():String
public function set quickSearchValue(value:String):void
rankField | property |
rankField:String
Since : | CS5 |
The name of a Rank object, as specified for a SearchDefinition object.
public function get rankField():String
public function set rankField(value:String):void
rankOrdering | property |
rankOrdering:String
Since : | CS5 |
The ordering style, one of ascending (the default) or descending.
public function get rankOrdering():String
public function set rankOrdering(value:String):void
scopeSpecifiers | property |
scopeSpecifiers:Array
Since : | CS5 |
One or more Scope object name strings, as specified for a SearchDefinition object.
public function get scopeSpecifiers():Array
public function set scopeSpecifiers(value:Array):void
SearchSpecification | () | Constructor |
public function SearchSpecification(conditionList:Array = null, conjunction:String = null, maximumResults:Number, rankOrdering:String = null, rankField:String = null, scopeSpecifiers:Array = null, quickSearchItem:String = null, quickSearchValue:String = null)
Since : | CS5 |
Parameters
conditionList:Array (default = null ) — (Array)
| |
conjunction:String (default = null ) — (String)
| |
maximumResults:Number (default = NaN ) — (Number)
| |
rankOrdering:String (default = null ) — (String)
| |
rankField:String (default = null ) — (String)
| |
scopeSpecifiers:Array (default = null ) — (Array)
| |
quickSearchItem:String (default = null ) — (String)
| |
quickSearchValue:String (default = null ) — (String)
|
createWithArgs | () | method |
override protected function createWithArgs(args:Array):void
Since : | CS5 |
Parameters
args:Array |