Class treemenu

Description

A hierarchical menu renderer which does not use Javascript to implement the menuoption display.

Located in /treemenu-defs.php (line 38)

RenderableObject
   |
   --treemenu
Direct descendents
Class Description
 class rowmenu A hierarchical menu renderer which does not use Javascript to implement the menuoption display. NB: this renderer is basically the same functionally as the treemenu but is rendered differently.
Variable Summary
Method Summary
 treemenu treemenu ([string $menu_name = "main"], [object $webpage = false], [mixed $stylesheet = ""], [integer $lang = -1], string $stylsheet)
 void get_styles ()
 string html ()
 void set_menu_images ([object $expandimg = false], [object $collapseimg = false], [mixed $menuopimg = false], [object $padimg = false], object $mopimg)
Variables
mixed $Align = "left" (line 49)

Alignment of the menu table

mixed $BorderColor = "black" (line 59)

Colour of top menu item border

mixed $BorderWidth = "" (line 61)

Width of top menu border in px

mixed $collapseimage (line 112)

Image to use for expanded sub-menu

mixed $exists = false (line 103)

Whether this menu exists in the database

mixed $expandimage (line 109)

Image to use for collapsed sub-menu

mixed $heading_item_spacing = 0 (line 85)

Padding before (above) menu options which are

mixed $HighBgColor = "black" (line 57)

Colour of highlighted top menu item background

mixed $HighColor = "white" (line 55)

Colour of highlighted top menu item text

mixed $item_spacing = 0 (line 89)

Padding before (above) 'normal' menu options

mixed $label_padding_left = 0 (line 80)

Padding between menuoption image, and menu item text

mixed $language = 0 (line 43)

Menu language, or default if zero

mixed $LowBgColor = "white" (line 53)

Colour of normal top menu item background

mixed $LowColor = "black" (line 51)

Colour of normal top menu item text

mixed $menu (line 94)

The menu instance

mixed $menuopimage (line 115)

Image to use to indicate a menu option

mixed $menuoption_id (line 106)

Initial menuoption ID

mixed $menu_id = 0 (line 97)

Unique database menu ID

mixed $menu_name = "" (line 41)

Menu name eg: 'main'

mixed $menu_width = 0 (line 75)

Fixed menu width, or zero if not fixed

mixed $padimage (line 118)

Image to use for padding/indenting menu options

mixed $padsize = 10 (line 77)

Size of level indent padding in px

mixed $pseudo_item_spacing = 0 (line 87)

Padding before (above) 'pseudo' menu options

mixed $session_id (line 100)

The current user session ID

mixed $stylesheet = "" (line 45)

Path to the stylesheet for menu

mixed $SubBorderColor = "black" (line 71)

Colour of sub-menu border

mixed $SubBorderWidth = "" (line 73)

Width of sub-menu border in px

mixed $SubHighBgColor = "#666666" (line 69)

Colour of sub-menu highlighted item background

mixed $SubHighColor = "white" (line 67)

Colour of sub-menu highlighted item text

mixed $SubLowBgColor = "#666666" (line 65)

Colour of sub-menu item background

mixed $SubLowColor = "#efefef" (line 63)

Colour of sub-menu item normal text

mixed $Tablestyle = "none" (line 47)

Overall class for the menu table

mixed $top_item_spacing = 0 (line 82)

Padding before (above) the top-level menu options

Methods
Constructor treemenu (line 128)

Constructor Create a new menumaintainer.

treemenu treemenu ([string $menu_name = "main"], [object $webpage = false], [mixed $stylesheet = ""], [integer $lang = -1], string $stylsheet)
  • string $menu_name: Menu name
  • object $webpage: Webpage object that this menu is being created for
  • string $stylsheet: Name of stylesheet file to reference for menu styles
  • integer $lang: Optional language variant of this menu (0 = default)
get_styles (line 227)

Obtain the non-standard styles from the stylesheet

void get_styles ()
html (line 516)

Render the menu as HTML. Please note that the TreeMenu is by design a VERTICAL menu system, so don't expect the 'orientation' style in the stylesheet to have any effect for this class.

  • return: The HTML
string html ()

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.

Redefined in descendants as:
set_menu_images (line 295)

Over-rides the standard '+' and '-' icon images used to indicate a sub-menu can be expanded or collapsed. The values passed should be image image objects as instances of the 'img' class (@see img()).

void set_menu_images ([object $expandimg = false], [object $collapseimg = false], [mixed $menuopimg = false], [object $padimg = false], object $mopimg)
  • object $expandimg: New image for 'expand' graphic
  • object $collapseimg: New image for 'collapse' graphic
  • object $mopimg: New image for 'menu option' graphic
  • object $padimg: New image for 'pad' graphic

Inherited Methods

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3