TreeControl Class Reference

The TreeControl provides a class that can be used to generate dynamic tree controls for use in PHP forms (or pages). More...

Public Member Functions
	TreeControl ($id, $title="", $style="tree", $scroll=true, $width=500, $height=400)
	Create a new TreeControl. More...
	writeScript ()
	writeHTML ()
	Outputs the TreeControl as HTML to the current output buffer. More...
	setValue ($value)
	writeNodes ()
	add ($n)
	Adds a child TreeNode (or an array of children) More...

Public Attributes
	$id
	$title
	$style
	$scroll
	$width
	$height
	$selectMode = "multi"
	$value
	$indent = "16px"
	$children
	$selectOnRightClick = false
	$selectOnRightClickMode = "context"

Detailed Description

The TreeControl provides a class that can be used to generate dynamic tree controls for use in PHP forms (or pages).

Definition at line 321 of file tree.inc.

Member Function Documentation

add()

TreeControl::add

(

$n

)

Adds a child TreeNode (or an array of children)

Parameters

mixed

$n

the child or children to add

Definition at line 438 of file tree.inc.

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

setValue()

TreeControl::setValue

(

$value

)

Definition at line 411 of file tree.inc.

     {
          $this->value = $value;
          $c = count($this->children);
          
          for($i = 0; $i < $c; ++$i)
          {
               $this->children[$i]->selectByValue($value);
          }
     }

TreeControl()

TreeControl::TreeControl	(		$id,
			$title = "",
			$style = "tree",
			$scroll = true,
			$width = 500,
			$height = 400
	)

Create a new TreeControl.

Parameters

string	$id	the ID for the control
string	$title	the title text for the control
string	$style	the base CSS class for the tree
boolean	$scroll	flag indicating whether the control should display scrollbars when the contents overflow a fixed width or height.
integer	$width	width of the control in pixels
integer	$height	height of the control in pixels

Definition at line 347 of file tree.inc.

     {
          $this->id = $id;
          $this->title = $title;
          $this->style = $style;
          $this->scroll = $scroll;
          $this->width = $width;
          $this->height = $height;
     }

writeHTML()

TreeControl::writeHTML

(

)

Outputs the TreeControl as HTML to the current output buffer.

Definition at line 368 of file tree.inc.

     {
          global $_activeTree;
          
          $_activeTree= $this;
          
          $this->writeScript();
          $width = is_numeric($this->width) ? "{$this->width}px" : $this->width;
          $height = is_numeric($this->height) ? "{$this->height}px" : $this->height;
          
          if ($this->selectMode == "single")
          {
?>
<input type='hidden' name='<?echo $this->id ?>' id='<?echo $this->id?>' value='<?echo $this->value ?>'/>
<? 
          }
?><table id="<?echo $this->id?>_table" class="<? echo $this->style?>" cellpadding="0" cellspacing="0" <? if ($this->width) echo "style='width:{$width}'"; ?>>
           <? 
           if ($this->title)
           {
           ?>        
           <tr>
            <th><? echo $this->title?></th>
           </tr>
           <?
           }
           
           $w = $width ? $width : "100%";
           ?>
           <tr>
            <td>
             <div style="padding: 0; margin: 0; width: <? echo $w?>;<? if ($this->height > 0) { ?> height: <?echo $this->height?>px;<? } ?><?if ($this->scroll) echo "overflow: auto"?>">
<?
          $this->writeNodes();
?>
             </div>
            </td>
           </tr>
          </table>
<?
          $_activeTree = null;
     }

writeNodes()

TreeControl::writeNodes

(

)

Definition at line 422 of file tree.inc.

     {
          $c = count($this->children);
          
          for($i = 0; $i < $c; ++$i)
          {
               $this->children[$i]->calculateOpenState();
               $this->children[$i]->writeHTML();
          }    
     }

writeScript()

TreeControl::writeScript

(

)

Deprecated:

include the /fakoli/js/tree.js support file instead.

Writes the JavaScript support functions for the tree.

Definition at line 361 of file tree.inc.

     {
     }

Member Data Documentation

$children

TreeControl::$children

Definition at line 332 of file tree.inc.

$height

TreeControl::$height

Definition at line 328 of file tree.inc.

$id

TreeControl::$id

Definition at line 323 of file tree.inc.

$indent

TreeControl::$indent = "16px"

Definition at line 331 of file tree.inc.

$scroll

TreeControl::$scroll

Definition at line 326 of file tree.inc.

$selectMode

TreeControl::$selectMode = "multi"

Definition at line 329 of file tree.inc.

$selectOnRightClick

TreeControl::$selectOnRightClick = false

Definition at line 333 of file tree.inc.

$selectOnRightClickMode

TreeControl::$selectOnRightClickMode = "context"

Definition at line 334 of file tree.inc.

$style

TreeControl::$style

Definition at line 325 of file tree.inc.

$title

TreeControl::$title

Definition at line 324 of file tree.inc.

$value

TreeControl::$value

Definition at line 330 of file tree.inc.

$width

TreeControl::$width

Definition at line 327 of file tree.inc.

---

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

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