TreeNode represents a node in the tree. More...

Public Member Functions
	TreeNode ($id, $title, $value="", $checked=false, $closedStyle="tree_node_closed", $openStyle="tree_node_open", $link=null, $target="")
	Create a new TreeNode. More...

	writeHTML ()
	Write the node out as HTML to the output buffer. More...

	add ($n)
	Add a child TreeNode (or an array of children) More...

	calculateOpenState ()
	Recursively determine whether the branch of the tree of which this node is the root should be displayed as open, based on the selection state of the node and its children. More...

	selectByValue ($value)

Public Attributes
	$children = array()

	$id

	$title

	$value

	$checked

	$closedStyle

	$openStyle

	$leafStyle

	$open

	$link

	$onDemand

	$disabled

	$target

	$extras
	Extra data/controls to be shown with this tree node. More...

Detailed Description

TreeNode represents a node in the tree.

Both leaf and branch nodes are represented using instances of this class. If a node is to be a branch, child TreeNodes can be added via the add() method.

Definition at line 61 of file tree.inc.

Member Function Documentation

◆ add()

TreeNode::add ( $n )

Add a child TreeNode (or an array of children)

Parameters

mixed $n the child or children to add

Definition at line 251 of file tree.inc.

      {
           if (is_array($n))
           {
                for($i = 0; $i < count($n); ++$i)
                {
                     $this->children[] = $n[$i];
                }
           }
           else
           {
                $this->children[] = $n;
           }
      }

◆ calculateOpenState()

TreeNode::calculateOpenState ( )

Recursively determine whether the branch of the tree of which this node is the root should be displayed as open, based on the selection state of the node and its children.

Definition at line 271 of file tree.inc.

      {
           if ($this->open) return true;
           if ($this->checked)
           {
                $this->open = true;
                return true;
           }
           
           $c = count($this->children);
           
           for($i = 0; $i < $c; ++$i)
           {
                if ($this->children[$i]->calculateOpenState())
                {
                     $this->open = true;
                     return true;
                }
           }
           
           $this->open = false;
           return false;
      }

◆ selectByValue()

TreeNode::selectByValue ( $value )

Definition at line 295 of file tree.inc.

      {
           if ($value === '')
           {
                $this->checked = false;
           }
           else if ($this->value == $value)
           {
                $this->checked = true;
           }
           
           $c = count($this->children);
           
           for($i = 0; $i < $c; ++$i)
           {
                $this->children[$i]->selectByValue($value);
           }
      }

◆ TreeNode()

TreeNode::TreeNode	(	$id,
		$title,
		$value = `""`,
		$checked = `false`,
		$closedStyle = `"tree_node_closed"`,
		$openStyle = `"tree_node_open"`,
		$link = `null`,
		$target = `""`
	)

Create a new TreeNode.

Parameters

string	$id	the ID for this node
string	$title	the Title text for this node
string	$value	the value for this node. If non-empty, a checkbox is generated when the node is displayed.
boolean	$checked	flag indicating whether the node should display as selected
string	$closedStyle	CSS class to use when the node is closed.
string	$openStyle	CSS class to use when the node is open.
string	$link	optional hyperlink URL for the node.
string	$target	optional target to load the URL.

Definition at line 91 of file tree.inc.

      {
           $this->id          = $id;
           $this->title       = $title;
           $this->value       = $value;
           $this->checked     = $checked;
           $this->closedStyle = $closedStyle;
           $this->openStyle   = $openStyle;
           $this->open        = false;
           $this->link            = $link;
           $this->leafStyle   = "tree_node_leaf";
           $this->onDemand    = "";
           $this->disabled        = false;
           $this->target      = $target;
           $this->extras     = "";
      }

◆ writeHTML()

TreeNode::writeHTML ( )

Write the node out as HTML to the output buffer.

This method recursively descends into all child nodes.

Definition at line 112 of file tree.inc.

      {
           global $_activeTree;
           
           $c = count($this->children);
  
           if ($this->link)
           {
                $title = "<a href='{$this->link}' target='{$this->target}'>{$this->title}</a>{$this->extras}";
           }
           else
           {
                $title = "<a href='#' onclick='";
                
                if ($_activeTree->onSelect)
                {
                     $title .= "{$_activeTree->onSelect}(\"{$this->value}\");";
                }
                else if ($_activeTree->selectMode != 'navigation')
                {
                     $title .= "new DOMEvent(event).stop(); Tree.toggleCheckbox(this, \"{$_activeTree->id}\", \"{$_activeTree->selectMode}\")";
                }
                $title .= "; return false'";
                
                if ($_activeTree->selectOnRightClick)
                {
                     $title .= " oncontextmenu='Tree.selectCheckbox(this, \"{$_activeTree->id}\", \"{$_activeTree->selectOnRightClickMode}\");'";
                }
                
                $title .= ">{$this->title}</a>{$this->extras}";
           }
           
           if ($c == 0 && !$this->onDemand)
           {
                // Leaf node
                echo "<div id='{$this->id}' class='{$this->leafStyle}'>";
  
                if (isset($this->value) && $this->value !== "" && $_activeTree->selectMode != 'navigation')
                {
 ?>
                <input type="checkbox" class="checkbox" name="<? echo $this->id?>" value="<? echo $this->value?>"<? 
                     if ($this->checked) echo " checked";
                     if ($this->disabled) echo " disabled";
                     if ($_activeTree->selectMode == "single") 
                     {
                          echo " onclick=\"Tree.clearCheckBoxes('{$_activeTree->id}', this);";
                          if ($_activeTree->onSelect)
                          {
                               echo " {$_activeTree->onSelect}('{$this->value}');";
                          }
                          echo "\"";
                     }
                     else if ($_activeTree->onSelect)
                     {
                          echo " onclick=\"{$_activeTree->onSelect}('{$this->value}');\"";
                     }
                      ?>/>
 <?
                }
           
                echo "$title</div>";
           }
           else
           {
                if ($this->open)
                {
                     $style = $this->openStyle;
                     $display = "block";
                }
                else
                {
                     $style = $this->closedStyle;
                     $display = "none";
                }
                               
                if ($this->onDemand)
                {
                     $cmd = "Tree.loadOnDemand('{$this->id}', '{$this->onDemand}');";
                     
                     if ($this->open)
                     {
 ?>
 <script type="text/javascript">
      window.addEvent('domready', function() {Tree.loadOnDemand('<?echo $this->id?>', '<?echo $this->onDemand?>');});
 </script>
 <?
                     }                        
                }
                else
                {
                     $cmd = "";
                }
                
                $cmd .= "Tree.toggleFolder('{$this->id}', '{$this->openStyle}', '{$this->closedStyle}');";
 ?>
           <div id='<?echo $this->id?>' class='<?echo $style?>' onclick="<?echo $cmd ?>">
 <?
                if (isset($this->value) && $this->value !== "" && $_activeTree->selectMode != 'navigation')
                {
 ?>
                <input type="checkbox" class="checkbox" name="<? echo $this->id?>" value="<? echo $this->value?>" <? 
                     if ($this->checked) echo " checked";
                     if ($this->disabled) echo " disabled";
                     if ($_activeTree->selectMode == "single") 
                     {
                          echo " onclick=\"Tree.clearCheckBoxes('{$_activeTree->id}', this);";
                          if ($_activeTree->onSelect)
                          {
                               echo " {$_activeTree->onSelect}('{$this->value}');";
                          }
                          echo "\"";
                     }
                     else if ($_activeTree->onSelect)
                     {
                          echo " onclick=\"{$_activeTree->onSelect}('{$this->value}');\"";
                     }
                      ?>/>
 <?
                }
 ?>
           <?echo $title?></div>
           <div id='<?echo $this->id?>_contents' style='padding-left: <?echo $_activeTree->indent ?>; display: <? echo $display?>'>
                
 <?             
                for($i = 0; $i < $c; ++$i)
                {
                     $this->children[$i]->writeHTML();
                }
 ?>
           </div>
 <?
           }
      }

Member Data Documentation

◆ $checked

TreeNode::$checked

Definition at line 68 of file tree.inc.

◆ $children

TreeNode::$children = array()

Definition at line 63 of file tree.inc.

◆ $closedStyle

TreeNode::$closedStyle

Definition at line 69 of file tree.inc.

◆ $disabled

TreeNode::$disabled

Definition at line 75 of file tree.inc.

◆ $extras

TreeNode::$extras

Extra data/controls to be shown with this tree node.

Definition at line 77 of file tree.inc.

◆ $id

TreeNode::$id

Definition at line 65 of file tree.inc.

◆ $leafStyle

TreeNode::$leafStyle

Definition at line 71 of file tree.inc.

◆ $link

TreeNode::$link

Definition at line 73 of file tree.inc.

◆ $onDemand

TreeNode::$onDemand

Definition at line 74 of file tree.inc.

◆ $open

TreeNode::$open

Definition at line 72 of file tree.inc.

◆ $openStyle

TreeNode::$openStyle

Definition at line 70 of file tree.inc.

◆ $target

TreeNode::$target

Definition at line 76 of file tree.inc.

◆ $title

TreeNode::$title

Definition at line 66 of file tree.inc.

◆ $value

TreeNode::$value

Definition at line 67 of file tree.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/tree.inc

Public Member Functions

Public Attributes