Class: HTML_TreeMenu_DHTML

Source Location: /HTML_TreeMenu-1.1.2/TreeMenu.php

Class Overview [line 329]

HTML_TreeMenu_Presentation
   |
   --HTML_TreeMenu_DHTML

HTML_TreeMenu_DHTML class

Author(s):

Version:

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

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

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

The default CSS class for the nodes

Type: mixed

Overrides:

[ Top ]

$images

[line 342]

Path to the images

Type: string

Overrides:

[ Top ]

$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.

Type: mixed

Overrides:

[ Top ]

$linkTarget

[line 348]

Target for the links generated

Type: string

Overrides:

[ Top ]

$noTopLevelImages

[line 365]

Whether to skip first level branch images

Type: bool

Overrides:

[ Top ]

$userPersistence

[line 354]

Whether to use clientside persistence or not

Type: bool

Overrides:

[ Top ]


Class Methods

HTML_TreeMenu_DHTML

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

[line 386]

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

string toHTML( )

[line 411]

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

Tags:

  • return - The HTML for the menu
  • access - public

Parameters:

[ Top ]


Class Constants


Documentation generated on Sat, 05 Sep 2009 16:39:36 -0500 by phpDocumentor 1.4.3