Formspider APIs


Package api_treenode


Field Summary
 varchar2(200)collapsed CONSTANT := bdf_constant.nodetypecollapsed
          
 varchar2(200)expanded CONSTANT := bdf_constant.nodetypeexpanded
          
 varchar2(200)leaf CONSTANT := bdf_constant.nodetypeleaf
          

Type Summary
 RECORD t_node(nodedisplayname_tx varchar2(4000), nodekey_tx varchar2(255), icon_tx varchar2(255), fontsize_nr number, fontstyle_tx varchar2(255), fontfamily_tx varchar2(255), fontcolor_cd varchar2(255), tooltip_tx varchar2(255), nodestate_tx varchar2(255))
           Record type for the node object.
 RECORD t_position(parentnodekey_tx varchar2(4000), prevsiblingnodekey_tx varchar2(4000))
           Record type to store the positioning of a node in a tree.

Method Summary
  collapse(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Hides the children of the node.
 api_treenode.t_node createnode(in_nodedisplayname_tx IN varchar2, in_nodekey_tx IN varchar2, in_icon_tx IN varchar2 DEFAULT null, in_fontsize_nr IN number DEFAULT null, in_fontstyle_tx IN varchar2 DEFAULT null, in_fontfamily_tx IN varchar2 DEFAULT null, in_fontcolor_cd IN varchar2 DEFAULT null, in_tooltip_tx IN varchar2 DEFAULT null, in_nodestate_tx IN varchar2 DEFAULT collapsed)
           Returns a new node.
  expand(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Displays the children of the node.
 number getchildcount(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns the number of child nodes of a parent node.
 varchar2 getdisplay(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns the display text of the node.
 varchar2 geticon(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns the icon of the node.
 number getid(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns the node ID.
 varchar2 getnextsiblingnodekey(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns the key of the next adjacent node.
 varchar2 getparentnodekey(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns parent node key that the node is under.
 t_position getposition(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns a record which holds parent node key and previous sibling node key of the specified node.
 varchar2 getprevsiblingnodekey(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns the key of the previous adjacent node.
 varchar2 getstate(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Returns whether the node is expanded, collapsed or a leaf.
 varchar2 isprevcollapsed(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2 DEFAULT null)
           Returns whether the node has previously been collapsed.
 varchar2 isprevexpanded(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2 DEFAULT null)
           Returns whether the node has previously been expanded.
  populatechildren(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2 DEFAULT null, in_datasourcename_tx IN varchar2 DEFAULT null)
           Adds child nodes under a parent node.
  setdisplay(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2, in_display_tx IN varchar2 DEFAULT null)
           Updates the display of the node.
  setfont(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2, in_fontcolor_cd IN varchar2 DEFAULT null, in_fontsize_nr IN number DEFAULT null, in_fontfamily_tx IN varchar2 DEFAULT null, in_fontstyle_tx IN varchar2 DEFAULT null)
           Updates the font of the node.
  seticon(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2, in_iconpath_tx IN varchar2 DEFAULT null)
           Updates the icon of the node.
  setposition(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2, in_newparentnodekey_tx IN varchar2 DEFAULT null, in_newprevsiblingnodekey_tx IN varchar2 DEFAULT null)
           Moves the node to another location in the tree.
  setselected(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2)
           Marks the node as selected.
  setstate(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2, in_nodestate_tx IN varchar2 DEFAULT collapsed)
           Updates the state of the node.
  settooltip(in_paneldottreename_tx IN varchar2, in_nodekey_tx IN varchar2, in_tooltip_tx IN varchar2 DEFAULT null)
           Updates node tooltip

Field Detail

collapsed

        public varchar2(200) collapsed CONSTANT := bdf_constant.nodetypecollapsed

expanded

        public varchar2(200) expanded CONSTANT := bdf_constant.nodetypeexpanded

leaf

        public varchar2(200) leaf CONSTANT := bdf_constant.nodetypeleaf

Type Detail

t_node

public RECORD t_node(nodedisplayname_tx varchar2(4000), 
nodekey_tx varchar2(255),
icon_tx varchar2(255),
fontsize_nr number,
fontstyle_tx varchar2(255),
fontfamily_tx varchar2(255),
fontcolor_cd varchar2(255),
tooltip_tx varchar2(255),
nodestate_tx varchar2(255))
Record type for the node object.
Parameters:
nodedisplayname_tx - Display name of the node.
nodekey_tx - The unqiue ID of the node.
icon_tx - The node icon.
fontsize_nr - Font size of the node.
fontstyle_tx - Font style of the node.
fontfamily_tx - Font family of the node.
fontcolor_cd - Font color of the node.
tooltip_tx - Tool tip of the node.
nodestate_tx - The state of the node. Constants representing the possible values for this column are EXPANDED, COLLAPSED and LEAF.


t_position

public RECORD t_position(parentnodekey_tx varchar2(4000), 
prevsiblingnodekey_tx varchar2(4000))
Record type to store the positioning of a node in a tree.
Parameters:
parentnodekey_tx - The unique ID of the parent node.
prevsiblingnodekey_tx - The unique ID of the previous adjacent node.


Method Detail

collapse

public  collapse(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Hides the children of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


createnode

public api_treenode.t_node createnode(in_nodedisplayname_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_icon_tx IN varchar2 DEFAULT null,
in_fontsize_nr IN number DEFAULT null,
in_fontstyle_tx IN varchar2 DEFAULT null,
in_fontfamily_tx IN varchar2 DEFAULT null,
in_fontcolor_cd IN varchar2 DEFAULT null,
in_tooltip_tx IN varchar2 DEFAULT null,
in_nodestate_tx IN varchar2 DEFAULT collapsed)
Returns a new node.

Use api_tree.addNode to add the newly created node to a tree.

Parameters:
in_nodedisplayname_tx - The display text of the node.
in_nodekey_tx - The unqiue ID of the node.
in_icon_tx - The node icon.
in_fontsize_nr - Font size of the node.
in_fontstyle_tx - Font style of the node.
in_fontfamily_tx - Font family of the node.
in_fontcolor_cd - Font color of the node.
in_tooltip_tx - The tooltip of the node.
in_nodestate_tx - The state of the node. Constants representing the possible values for this column are EXPANDED, COLLAPSED and LEAF.
Throws:
e_invalidcolor - Raised when the in_fontcolor_cd value is not recognized.


expand

public  expand(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Displays the children of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getchildcount

public number getchildcount(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns the number of child nodes of a parent node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getdisplay

public varchar2 getdisplay(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns the display text of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


geticon

public varchar2 geticon(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns the icon of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getid

public number getid(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns the node ID.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getnextsiblingnodekey

public varchar2 getnextsiblingnodekey(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns the key of the next adjacent node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getparentnodekey

public varchar2 getparentnodekey(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns parent node key that the node is under.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getposition

public t_position getposition(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns a record which holds parent node key and previous sibling node key of the specified node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getprevsiblingnodekey

public varchar2 getprevsiblingnodekey(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns the key of the previous adjacent node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


getstate

public varchar2 getstate(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Returns whether the node is expanded, collapsed or a leaf.

The values that may be returned from this function are defined as the following constants: EXPANDED, COLLAPSDE, LEAF.

Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.

See also:
EXPANDED
COLLAPSED
LEAF

isprevcollapsed

public varchar2 isprevcollapsed(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2 DEFAULT null)
Returns whether the node has previously been collapsed.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


isprevexpanded

public varchar2 isprevexpanded(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2 DEFAULT null)
Returns whether the node has previously been expanded.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


populatechildren

public  populatechildren(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2 DEFAULT null,
in_datasourcename_tx IN varchar2 DEFAULT null)
Adds child nodes under a parent node.

Any existing child nodes under the parent node are deleted. If parameter in_nodekey_tx is null, then new nodes are created at the top level of the tree. In_datasourceName_tx specifies the name of the datasource that is queried to create the new nodes. All tree component bindings such as displayColumn, tooltipColumn etc... is automatically bound to this datasource and continue to work if the datasource contains the column specified in design time for the binding. Otherwise, the binding is simply ignored. If in_datasourceName_tx is null, the nodes are created using the default tree datasource specified in design time.

Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the parent node.
in_datasourcename_tx - The name of datasource that is queried to create new nodes. If in_datasourcename_tx is null then default datasource specified in design time is queried.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.
e_invaliddatasourcename - Raised when the datasource does not exist.


setdisplay

public  setdisplay(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_display_tx IN varchar2 DEFAULT null)
Updates the display of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
in_display_tx - The new display text of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


setfont

public  setfont(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_fontcolor_cd IN varchar2 DEFAULT null,
in_fontsize_nr IN number DEFAULT null,
in_fontfamily_tx IN varchar2 DEFAULT null,
in_fontstyle_tx IN varchar2 DEFAULT null)
Updates the font of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
in_fontcolor_cd - The new color of the font.

This input parameter accepts colors in RGB format. It also accepts predefined colors that are represented as constants in the API_COLOR package.

in_fontsize_nr - The new font size of the node label.
in_fontfamily_tx - The new font family of the node label.
in_fontstyle_tx - The new font style of the node label.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.
e_invalidcolor - Raised when the in_fontcolor_cd value is not recognized.

See also:
api_color

seticon

public  seticon(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_iconpath_tx IN varchar2 DEFAULT null)
Updates the icon of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
in_iconpath_tx - The path of the icon for the tree.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


setposition

public  setposition(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_newparentnodekey_tx IN varchar2 DEFAULT null,
in_newprevsiblingnodekey_tx IN varchar2 DEFAULT null)
Moves the node to another location in the tree.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_newparentnodekey_tx - The unique ID of the new parent node
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.
e_notfoundunderparentnode - Raised when node in_prevSiblingNodeKey_tx is not a child node of in_parentNodeKey_tx.
e_sameposition - Raised when node already exists in the target location.
e_invalidsetpositionparameter - Raised when in_newParentNodeKey_tx and in_newPrevSiblingNodeKey_tx do not define a valid location in the tree
e_invalidparentnode - Raised when the new parent node is a child of the node being moved.


setselected

public  setselected(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2)
Marks the node as selected.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


setstate

public  setstate(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_nodestate_tx IN varchar2 DEFAULT collapsed)
Updates the state of the node.
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - The unique ID of the node.
in_nodestate_tx - The new state of the node.

The constants for the valid values for this input parameter are EXPANDED, COLLAPSED, LEAF.

See also:
EXPANDED
COLLAPSED
LEAF

settooltip

public  settooltip(in_paneldottreename_tx IN varchar2, 
in_nodekey_tx IN varchar2,
in_tooltip_tx IN varchar2 DEFAULT null)
Updates node tooltip
Parameters:
in_paneldottreename_tx - The fully qualified name of the tree in panelName.treeName format. Example: panel1.tree1
in_nodekey_tx - Node key
in_tooltip_tx - Node tooltip (Default value: null)
Throws:
e_invalidtreename - Raised when the tree does not exist.
e_invalidinputformat - Raised when the value in in_panelDotTreeName_tx is not recognized.
e_invalidnodekey - Raised when the node key does not exist.


Formspider APIs