|
AdobeBridgeCS5SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--SDKNode
Supporting class; backing node for extension handling samples.
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:
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 |
SDKNode children
SDKNode childrenNames
Boolean container
Boolean iconPath
Metadata metadata
String name
SDKNode parent
String. path
Constructor Detail |
SDKNode(name, iscontainer)
name
- The name of the node
iscontainer
- True if this node will be a container node, false otherwise
Method Detail |
Boolean addNode(node)
node
- SDKNode. The node to add.
Object cloneNode()
SDKNode findChildNode(name)
name
- The name of the node to find.
SDKNode findChildNodeFromPath(uri)
path
- The name of the node to find, including the prefix
SDKNode getChildNode(name)
name
- The name of the node to find.
Array getChildren()
Array getChildrenNames()
Array getCustomArray()
Boolean getCustomBool()
Date getCustomDate()
Number getCustomNumber()
String getCustomString()
String getFileUrl()
SDKNode getFirstChildNode()
BitmapData getIcon()
Object getLabelRating(type)
Object getMetadata()
String getName()
SDKNode getParent()
String getPath()
BitmapData getPreview()
BitmapData getThumb()
Boolean hasChildren()
Boolean isContainer()
void listChildren()
void removeNode(node)
node
- The SDKNode child to remove
void setCustomArray(a)
a
- The new value for member4 of the custom Infoset
void setCustomBool(b)
b
- The new value for member5 of the custom Infoset
void setCustomDate(d)
d
- The new value for member3 of the custom Infoset
void setCustomInfosetData()
void setCustomNumber(n)
n
- The new value for member2 of the custom Infoset
void setCustomString(s)
s
- The new value for member1 of the custom Infoset
void setLabelRating(type, val)
void setMetadata(md)
void setName(name)
String
- . The new name of this node.
void updateNode(node, oldName)
|
AdobeBridgeCS5SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |