Formspider APIs


Package api_tree


Type Summary
 RECORD t_draggednode(draggednodekey_tx varchar2(255), oldparentnodekey_tx varchar2(255), parentnodekey_tx varchar2(255), prevsiblingnodekey_tx varchar2(255))
           Record type for the Dragged Node object.

Method Summary
  addnode(in_paneldottreename_tx IN varchar2, in_parentnodekey_tx IN varchar2 DEFAULT null, in_prevsiblingnodekey_tx IN varchar2 DEFAULT null, in_node_r IN api_treenode.t_node)
           Adds a new node to the tree.
 varchar2 getcollapsednodekey(in_paneldottreename_tx IN varchar2)
           Returns the key of the currently collapsed node.
 varchar2 getcurrentselection(in_paneldottreename_tx IN varchar2)
           Returns the node key of the selected node.
 t_draggednode getdraggednode(in_paneldottreename_tx IN varchar2)
           Returns a record which holds old and new parent node key and new previous sibling node key of dragged node if exists.
 varchar2 getexpandednodekey(in_paneldottreename_tx IN varchar2)
           Returns the key of the currently expanded node.
 number getid(in_paneldottreename_tx IN varchar2)
           Returns the run time ID of the tree.
 varchar2 getrightclickednodekey(in_paneldottreename_tx IN varchar2)
           Returns the key of the node the user right clicked.
 varchar2 getselectednodekey(in_paneldottreename_tx IN varchar2)
           Returns the node key of the last selected node.
  removenode(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Deletes a node from the tree.

Type Detail

t_draggednode

public RECORD t_draggednode(draggednodekey_tx varchar2(255), 
oldparentnodekey_tx varchar2(255),
parentnodekey_tx varchar2(255),
prevsiblingnodekey_tx varchar2(255))
Record type for the Dragged Node object.
Parameters:
draggednodekey_tx - Dragged nodekey
oldparentnodekey_tx - Old parent nodekey
parentnodekey_tx - New parent nodekey
prevsiblingnodekey_tx - Sibling nodekey


Method Detail

addnode

public  addnode(in_paneldottreename_tx IN varchar2, 
in_parentnodekey_tx IN varchar2 DEFAULT null,
in_prevsiblingnodekey_tx IN varchar2 DEFAULT null,
in_node_r IN api_treenode.t_node)
Adds a new node to the tree.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_parentnodekey_tx - The key of the node that will have the new node as its child in the tree hierarchy. Defaults to null which will make the node a top level node.
in_prevsiblingnodekey_tx - The key of the node that the new node will appear after. Defaults to null which will make the new node the first child of the node of the parent node.
in_node_r - The new node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.
e_notfoundunderparentnode - Raised when node in_prevSiblingNodeKey_tx is not a child node of in_parentNodeKey_tx.


getcollapsednodekey

public varchar2 getcollapsednodekey(in_paneldottreename_tx IN varchar2)
Returns the key of the currently collapsed node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


getcurrentselection

public varchar2 getcurrentselection(in_paneldottreename_tx IN varchar2)
Returns the node key of the selected node. It returns null if the selected node is deleted.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


getdraggednode

public t_draggednode getdraggednode(in_paneldottreename_tx IN varchar2)
Returns a record which holds old and new parent node key and new previous sibling node key of dragged node if exists.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


getexpandednodekey

public varchar2 getexpandednodekey(in_paneldottreename_tx IN varchar2)
Returns the key of the currently expanded node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


getid

public number getid(in_paneldottreename_tx IN varchar2)
Returns the run time ID of the tree.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


getrightclickednodekey

public varchar2 getrightclickednodekey(in_paneldottreename_tx IN varchar2)
Returns the key of the node the user right clicked.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


getselectednodekey

public varchar2 getselectednodekey(in_paneldottreename_tx IN varchar2)
Returns the node key of the last selected node. This function returns the same value until a new selection is made by the user even if the last selected node is deleted.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.


removenode

public  removenode(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Deletes a node from the tree.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique value that identified a node in the tree.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the format of the input parameter is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


Formspider APIs