Class: HTML_TreeMenu_DHTML

Source Location: /HTML_TreeMenu-1.1.2/TreeMenu.php

Class HTML_TreeMenu_DHTML

Class Overview

HTML_TreeMenu_DHTML class

This class is a presentation class for the tree structure created using the TreeMenu/TreeNode. It presents the traditional tree, static for browsers that can't handle the DHTML.

Located in /HTML_TreeMenu-1.1.2/TreeMenu.php [line 329]

HTML_TreeMenu_Presentation
   |
   --HTML_TreeMenu_DHTML

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From HTML_TreeMenu_Presentation

HTML_TreeMenu_Presentation::$menu

Inherited From HTML_TreeMenu_Presentation

HTML_TreeMenu_Presentation::HTML_TreeMenu_Presentation()

Base constructor simply sets the menu object

HTML_TreeMenu_Presentation::printMenu()

Prints the HTML generated by the toHTML() method.

[ Top ]

Property Summary

mixed	$defaultClass	The default CSS class for the nodes
string	$images	Path to the images
mixed	$isDynamic	Dynamic status of the treemenu. If true (default) this has no effect. If false it will override all dynamic status vars and set the menu to be fully expanded an non-dynamic.
string	$linkTarget	Target for the links generated
bool	$noTopLevelImages	Whether to skip first level branch images
bool	$userPersistence	Whether to use clientside persistence or not

[ Top ]

Method Summary

HTML_TreeMenu_DHTML	HTML_TreeMenu_DHTML()	Constructor, takes the tree structure as
string	toHTML()	Returns the HTML for the menu. This method can be used instead of printMenu() to use the menu system with a template system.

[ Top ]

Properties

mixed $defaultClass [line 359]

The default CSS class for the nodes

[ Top ]

string $images [line 342]

Path to the images

[ Top ]

mixed $isDynamic [line 336]

Dynamic status of the treemenu. If true (default) this has no effect. If false it will override all dynamic status vars and set the menu to be fully expanded an non-dynamic.

[ Top ]

string $linkTarget [line 348]

Target for the links generated

[ Top ]

bool $noTopLevelImages [line 365]

Whether to skip first level branch images

[ Top ]

bool $userPersistence [line 354]

Whether to use clientside persistence or not

[ Top ]

Methods

Constructor HTML_TreeMenu_DHTML [line 386]

HTML_TreeMenu_DHTML HTML_TreeMenu_DHTML(

&$structure, [array
$options = array()], [bool
$isDynamic = true], object
$structure 
)

Constructor, takes the tree structure as

an argument and an array of options which can consist of:

images - The path to the images folder. Defaults to "images"
linkTarget - The target for the link. Defaults to "_self"
defaultClass - The default CSS class to apply to a node. Default is none.
usePersistence - Whether to use clientside persistence. This persistence is achieved using cookies. Default is true.
noTopLevelImages - Whether to skip displaying the first level of images if there is multiple top level branches.

And also a boolean for whether the entire tree is dynamic or not. This overrides any perNode dynamic settings.

Parameters:

object	$structure:	The menu structure
array	$options:	Array of options
bool	$isDynamic:	Whether the tree is dynamic or not
	&$structure:

[ Top ]

toHTML [line 411]

string toHTML(
)

Returns the HTML for the menu. This method can be used instead of printMenu() to use the menu system with a template system.

API Tags:

Return:	The HTML for the menu
Access:	public

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:26:33 -0500 by phpDocumentor 1.3.1

	HTML_TreeMenu

[ class tree: HTML_TreeMenu ] [ index: HTML_TreeMenu ] [ all elements ]