Packagecom.adobe.bridge
Classpublic class ExtensionHandler
InheritanceExtensionHandler Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

To extend the node-handling behavior of Adobe Bridge, you must implement these properties and methods to define you own node type and handler. See Adobe Bridge JavaScript Guide and Adobe Bridge JavaScript Reference for complete details. Register a script-defined extension handler with app.registerExtension(). You can access the global list of all registered extensions through app.extensions. Your node-handling extension defines a node type. Your node types are identified by a Bridge URI prefix. You must associates your handler with at least one prefix, using app.registerPrefix().



Public Properties
 PropertyDefined By
  acquirePhysicalFiles : Object
Implement a function that acquires actual file data for a set of placeholder nodes.
ExtensionHandler
  duplicate : Object
Implement a function that duplicates a set of nodes that are handled by this handler.
ExtensionHandler
  getBridgeUriForPath : Object
Implement a function that converts a path string to a canonical Bridge URI.
ExtensionHandler
  getBridgeUriForSearch : Object
Implement a function that executes an extension-defined search among Adobe Bridge nodes of an extension-defined node type.
ExtensionHandler
  getSidecars : Object
Implement a function that retrieves existing sidecar files for a set of nodes.
ExtensionHandler
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  infosets : Array
[read-only] A collection of Infoset objects defining node data managed by this handler.
ExtensionHandler
  makeModel : Object
Implement a function that creates a model instance that implements node handling.
ExtensionHandler
  methods : Object
New methods that are defined on Thumbnail objects that are managed by this handler.
ExtensionHandler
  moveToTrash : Object
Implement a function that deletes a set of nodes, marking the associated files for deletion on disc by moving them to the system trash or recycle bin.
ExtensionHandler
  name : String
[read-only] The unique identifying name of this node-handling extension.
ExtensionHandler
  prefixes : Array
[read-only] A collection of lexical prefix strings for Bridge URIs.
ExtensionHandler
  rotate : Object
Implement a function that sets the rotation setting in metadata for a set of thumbnails to the same value for all.
ExtensionHandler
  setLabels : Object
Implement a function that sets the labels for a set of thumbnails.
ExtensionHandler
  setRatings : Object
Implement a function that sets the ratings for a set of thumbnails.
ExtensionHandler
  setXmp : Object
Implement a function that embeds XMP file metadata packets in a set of files.
ExtensionHandler
Public Methods
 MethodDefined By
  
ExtensionHandler(name:String = null)
ExtensionHandler
 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]
ExtensionHandler
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
acquirePhysicalFilesproperty
acquirePhysicalFiles:Object

Since : CS5

Implement a function that acquires actual file data for a set of placeholder nodes.


Implementation
    public function get acquirePhysicalFiles():Object
    public function set acquirePhysicalFiles(value:Object):void
duplicateproperty 
duplicate:Object

Since : CS5

Implement a function that duplicates a set of nodes that are handled by this handler.


Implementation
    public function get duplicate():Object
    public function set duplicate(value:Object):void
getBridgeUriForPathproperty 
getBridgeUriForPath:Object

Since : CS5

Implement a function that converts a path string to a canonical Bridge URI.


Implementation
    public function get getBridgeUriForPath():Object
    public function set getBridgeUriForPath(value:Object):void
getBridgeUriForSearchproperty 
getBridgeUriForSearch:Object

Since : CS5

Implement a function that executes an extension-defined search among Adobe Bridge nodes of an extension-defined node type.


Implementation
    public function get getBridgeUriForSearch():Object
    public function set getBridgeUriForSearch(value:Object):void
getSidecarsproperty 
getSidecars:Object

Since : CS5

Implement a function that retrieves existing sidecar files for a set of nodes.


Implementation
    public function get getSidecars():Object
    public function set getSidecars(value:Object):void
infosetsproperty 
infosets:Array  [read-only]

Since : CS5

A collection of Infoset objects defining node data managed by this handler.


Implementation
    public function get infosets():Array
makeModelproperty 
makeModel:Object

Since : CS5

Implement a function that creates a model instance that implements node handling.


Implementation
    public function get makeModel():Object
    public function set makeModel(value:Object):void
methodsproperty 
methods:Object

Since : CS5

New methods that are defined on Thumbnail objects that are managed by this handler.


Implementation
    public function get methods():Object
    public function set methods(value:Object):void
moveToTrashproperty 
moveToTrash:Object

Since : CS5

Implement a function that deletes a set of nodes, marking the associated files for deletion on disc by moving them to the system trash or recycle bin.


Implementation
    public function get moveToTrash():Object
    public function set moveToTrash(value:Object):void
nameproperty 
name:String  [read-only]

Since : CS5

The unique identifying name of this node-handling extension.


Implementation
    public function get name():String
prefixesproperty 
prefixes:Array  [read-only]

Since : CS5

A collection of lexical prefix strings for Bridge URIs.


Implementation
    public function get prefixes():Array
rotateproperty 
rotate:Object

Since : CS5

Implement a function that sets the rotation setting in metadata for a set of thumbnails to the same value for all. Does not rotate image bits.


Implementation
    public function get rotate():Object
    public function set rotate(value:Object):void
setLabelsproperty 
setLabels:Object

Since : CS5

Implement a function that sets the labels for a set of thumbnails.


Implementation
    public function get setLabels():Object
    public function set setLabels(value:Object):void
setRatingsproperty 
setRatings:Object

Since : CS5

Implement a function that sets the ratings for a set of thumbnails.


Implementation
    public function get setRatings():Object
    public function set setRatings(value:Object):void
setXmpproperty 
setXmp:Object

Since : CS5

Implement a function that embeds XMP file metadata packets in a set of files.


Implementation
    public function get setXmp():Object
    public function set setXmp(value:Object):void
Constructor Detail
ExtensionHandler()Constructor
public function ExtensionHandler(name:String = null)

Since : CS5

Parameters
name:String (default = null) — (String)
Method Detail
createWithArgs()method
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array