Class HTML_TreeMenu_DHTML

Description

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 /include/TreeMenu.php (line 532)

HTML_TreeMenu_Presentation
   |
   --HTML_TreeMenu_DHTML
Variable Summary
Method Summary
HTML_TreeMenu_DHTML HTML_TreeMenu_DHTML ( &$structure, [array $options = array()], [bool $isDynamic = true], object $structure)
string toHTML ()
Variables
mixed $defaultClass (line 562)

The default CSS class for the nodes

string $images (line 545)

Path to the images

mixed $isDynamic (line 539)

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 $jsObjectName (line 574)

Name of Jabbascript object to use

string $linkTarget (line 551)

Target for the links generated

bool $noTopLevelImages (line 568)

Whether to skip first level branch images

bool $usePersistence (line 557)

Whether to use clientside persistence or not

Inherited Variables

Inherited from HTML_TreeMenu_Presentation

HTML_TreeMenu_Presentation::$menu
Methods
Constructor HTML_TreeMenu_DHTML (line 601)

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.

HTML_TreeMenu_DHTML HTML_TreeMenu_DHTML ( &$structure, [array $options = array()], [bool $isDynamic = true], object $structure)
  • object $structure: The menu structure
  • array $options: Array of options
  • bool $isDynamic: Whether the tree is dynamic or not
  • &$structure
toHTML (line 628)

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
string toHTML ()

Inherited Methods

Inherited From HTML_TreeMenu_Presentation

HTML_TreeMenu_Presentation::HTML_TreeMenu_Presentation()
HTML_TreeMenu_Presentation::printMenu()

Documentation generated on Wed, 05 Oct 2011 10:36:47 +0200 by phpDocumentor 1.4.1