Packagecom.adobe.bridge
Classpublic class Scope
InheritanceScope Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Identifies a scope modifier to use in node searches among handled nodes. The modifier can expand or limit the scope of the search from the original target node. The scope value and usage is defined entirely by the node's ExtensionModel.getSearchDefinition() implementation.An array of these objects, kept in SearchDefinition.scopeSpecifiers, is used to populate the Find dialog. The box displays a check box for each possible scope extension or limitation. When the user selects a scope, its name becomes the resulting SearchSpecification.scopeSpecifiers value.



Public Properties
 PropertyDefined By
  displayName : String
The localized display name for the corresponding field in the Find dialog.
Scope
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  valueName : String
The unique identifying name for the scope modifier.
Scope
Public Methods
 MethodDefined By
  
Scope(valueName:String = null, displayName:String = null)
Scope
 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]
Scope
 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 unique identifying name for the scope modifier.


Implementation
    public function get valueName():String
    public function set valueName(value:String):void
Constructor Detail
Scope()Constructor
public function Scope(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