AdobeBridgeCS5SDK

Class SDKNode

Object
   |
   +--SDKNode

class SDKNode


Supporting class; backing node for extension handling samples.

Description

Implements the methods needed to support node handling via the ExtensionModel and ExtensionHandler. This class encapsulates a node of the type handled by the sample node-handling extension.

See:

Defined in SDKNode.jsx


Field Summary
 SDKNode children
          The children of this node, if any, in an array.
 SDKNode childrenNames
          The children of this node, if any, in an associative array.
 Boolean container
          Whether this node is a container.
 Boolean iconPath
          The path for the custom icon.
 Metadata metadata
          The XMP for this node
 String name
          The name of this node.
 SDKNode parent
          The parent of this node.
 String. path
          The path of this node.
 
Constructor Summary
SDKNode(name, iscontainer)
           
 
Method Summary
 Boolean addNode(node)
           Adds a child node to this node.
 Object cloneNode()
          
 SDKNode findChildNode(name)
           Searches for a specific child node in any part of the tree below this node.
 SDKNode findChildNodeFromPath(uri)
           Searches for a specific child node in any part of the tree below this node.
 SDKNode getChildNode(name)
           Searches for a specific child node among the immediate children of this node.
 Array getChildren()
           Retrieves all the children of this node
 Array getChildrenNames()
           Retrieves all the children of this node in an associative array
 Array getCustomArray()
           Retrieves this node's data for the custom Infoset member4 value;
 Boolean getCustomBool()
           Retrieves this node's data for the custom Infoset member5 value;
 Date getCustomDate()
           Retrieves this node's data for the custom Infoset member3 value;
 Number getCustomNumber()
           Retrieves this node's data for the custom Infoset member2 value;
 String getCustomString()
           Retrieves this node's data for the custom Infoset member1 value
 String getFileUrl()
           Returns the file url for this node.
 SDKNode getFirstChildNode()
           Return the first child of this node.
 BitmapData getIcon()
           Creates an icon for this node.
 Object getLabelRating(type)
          
 Object getMetadata()
          
 String getName()
           Retrieves the name of this node.
 SDKNode getParent()
           Retrieves the parent of this node;
 String getPath()
           Retrieves the full path of this node.
 BitmapData getPreview()
           Creates a preview image for this node.
 BitmapData getThumb()
           Creates a thumbnail image for this node.
 Boolean hasChildren()
           Reports whether this node has any children
 Boolean isContainer()
           Reports whether this node is a container.
 void listChildren()
          
 void removeNode(node)
           Removes a child node from this node
 void setCustomArray(a)
           Retrieves this node's data for the custom Infoset member4 value;
 void setCustomBool(b)
           Retrieves this node's data for the custom Infoset member5 value;
 void setCustomDate(d)
           Retrieves this node's data for the custom Infoset member3 value;
 void setCustomInfosetData()
           Called at node creation time to set values for the specified fields
 void setCustomNumber(n)
           Retrieves this node's data for the custom Infoset member2 value;
 void setCustomString(s)
           Sets this node's data for the custom Infoset member1 value;
 void setLabelRating(type, val)
          
 void setMetadata(md)
          
 void setName(name)
           Changes the name of this node
 void updateNode(node, oldName)
          

Field Detail

children

SDKNode children

childrenNames

SDKNode childrenNames

container

Boolean container

iconPath

Boolean iconPath

metadata

Metadata metadata

name

String name

parent

SDKNode parent

path

String. path

Constructor Detail

SDKNode

SDKNode(name, iscontainer)

Method Detail

addNode

Boolean addNode(node)

cloneNode

Object cloneNode()

findChildNode

SDKNode findChildNode(name)

findChildNodeFromPath

SDKNode findChildNodeFromPath(uri)

getChildNode

SDKNode getChildNode(name)

getChildren

Array getChildren()

getChildrenNames

Array getChildrenNames()

getCustomArray

Array getCustomArray()

getCustomBool

Boolean getCustomBool()

getCustomDate

Date getCustomDate()

getCustomNumber

Number getCustomNumber()

getCustomString

String getCustomString()

getFileUrl

String getFileUrl()

getFirstChildNode

SDKNode getFirstChildNode()

getIcon

BitmapData getIcon()

getLabelRating

Object getLabelRating(type)

getMetadata

Object getMetadata()

getName

String getName()

getParent

SDKNode getParent()

getPath

String getPath()

getPreview

BitmapData getPreview()

getThumb

BitmapData getThumb()

hasChildren

Boolean hasChildren()

isContainer

Boolean isContainer()

listChildren

void listChildren()

removeNode

void removeNode(node)

setCustomArray

void setCustomArray(a)

setCustomBool

void setCustomBool(b)

setCustomDate

void setCustomDate(d)

setCustomInfosetData

void setCustomInfosetData()

setCustomNumber

void setCustomNumber(n)

setCustomString

void setCustomString(s)

setLabelRating

void setLabelRating(type, val)

setMetadata

void setMetadata(md)

setName

void setName(name)

updateNode

void updateNode(node, oldName)

AdobeBridgeCS5SDK

http://www.adobe.com/devnet/bridge
Documentation generated by JSDoc on Tue Apr 27 10:21:34 2010