GINodeTree

Module: UI

This control is based on the YUI TreeView Control version 2.9.0 (scripts are included in the minified version of the API) and provides a hierarchical representation of a DAB node (the root of the tree).

Required CSS:


                         <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.9.0/build/fonts/fonts-min.css" />
                         <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.9.0/build/treeview/assets/skins/sam/treeview.css" />

When a tree node is expanded, the method expand is called on the correspondent GINode available in the data property of the expanded tree node (if the GINode is simple the tree node is not expanded). The maximum number of nodes that can be retrieve at each call of the expand method can be set with options.pageSize or by means of the GINodeTree/pageSize:method method (the default is 10). If the expanded tree node has more than GINodeTree/pageSize:method children, a special tree node is created with the title "Click to get more results..."; by expanding this node the expandNext method is called on the correspondent parent GINode.

As depicted in the image above (the test page is available here) each GINode is rendered using its report title; rendering and/or functionalities customization (e.g. icons visualization besides the title) can be done with the options.onCreateNode and options.onLoadComplete functions (see also GINodeTree/onCreateNode:method and GINodeTree/onLoadComplete:method methods)

Constructor

`GINodeTree`

(

dabNode
divId
[options]

)

Parameters:

dabNode DAB

the DAB node which is the root of tree hierarchy
divId String

the id of the <div> in which to insert the tree
[options] Object optional

object literal of optional properties
- [onCreateNode] Function optional
  
  callback function called to when a new tree node is created; this function can be used to customize the new tree node aspect and/or functionalities. See here for the default implementation
  - giNode GINode
    the GINode to render
  - parentTreeNode YAHOO.widget.HTMLNode
    the parent tree node
  - expandNext Boolean
    if true the node to create is the special node which retrieves the next nodes of the GINode related to parentTreeNode
  - isRoot Boolean
    if true the node to create is the root of the tree
    
    Returns: a string or object containing the data that will be used to render the new tree node
- [onLoadComplete] Function optional
  
  callback function called when all the expanded node children have been rendered (see also GINodeTree/onLoadComplete:method method)
  - resultPage Page
    the page resulting from the expansion
  - treeNodes YAHOO.widget.HTMLNode []
    array of rendered tree nodes. Each tree node provides the correspondent GINode in the data property
  - moreTreeNode YAHOO.widget.HTMLNode
    special tree node rendered with the title "Click to get more results..." which allows to retrieve the next page of nodes of the correspondent parent GINode that can be retrieved in the data property
- [onError] Function optional
  
  callback function called if an error occurs during the execution of the expand method on the target tree node
  - treeNode YAHOO.widget.HTMLNode
    the target tree node related GINode
  - error String
    the error message
- [pageSize] Integer optional
  
  the maximum size of the returned expansion page, default is 10 (see also GINodeTree/pageSize:method method)

Index
Properties

Item Index

Properties

`tree`

YAHOO.widget.TreeView

The tree which renders the DAB node hierarchical structure

`treeRoot`

YAHOO.widget.HTMLNode

The root of the tree with the DAB node in the data property