Class: HTML_TreeMenu_DHTML

Source Location: /HTML_TreeMenu-1.2.0/TreeMenu.php

Class Overview

HTML_TreeMenu_Presentation
   |
   --HTML_TreeMenu_DHTML

HTML_TreeMenu_DHTML class

Variables

Methods

Inherited Variables

Class: HTML_TreeMenu_Presentation

HTML_TreeMenu_Presentation::$menu

Inherited Methods

Class: 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.

Class Details

[line 530]
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.

[ Top ]

Class Variables

$defaultClass =

[line 560]

The default CSS class for the nodes

Type:

mixed

[ Top ]

$images =

[line 543]

Path to the images

Type:

string

[ Top ]

$isDynamic =

[line 537]

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.

Type:

mixed

[ Top ]

$jsObjectName =

[line 572]

Name of Jabbascript object to use

Type:

string

[ Top ]

$linkTarget =

[line 549]

Target for the links generated

Type:

string

[ Top ]

$noTopLevelImages =

[line 566]

Whether to skip first level branch images

Type:

bool

[ Top ]

$usePersistence =

[line 555]

Whether to use clientside persistence or not

Type:

bool

[ Top ]

Method Detail

HTML_TreeMenu_DHTML (Constructor) [line 599]

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.
maxDepth - The maximum depth of indentation. Useful for ensuring deeply nested trees don't go way off to the right of your page etc. Defaults to no limit.
jsObjectName - Name to use for jabbascript object. Set this if you have different menus that should maintain their persistence information separately.

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 626]

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.

Return: The HTML for the menu
Access: public

[ Top ]