Class HVmenu

Description

HVMenu class This module is being retained for legacy applications which still use the core javascript system (version 5.41) which was written by Ger Versluis 24 December 2001.

  • deprecated: HVmenu javascript no longer packaged with Axyl. Use Xmenu instead.

Located in /hvmenu-defs.php (line 57)

RenderableObject
   |
   --HVmenu
Variable Summary
Method Summary
 HVmenu HVmenu ([string $menu_name = "main"], [object $webpage = false], [mixed $stylesheet = ""], [integer $lang = -1], string $stylsheet)
 void display_in_webpage (object $webpage)
 string html ()
Variables
mixed $item_height = 18 (line 87)

Height of menu items in pixels

mixed $item_width = 150 (line 84)

Width of all menu items in pixels

mixed $language = 0 (line 62)

Menu language

mixed $menuhref = "" (line 75)

WWW menu URL - theme aware

mixed $menuvarsfile = "" (line 72)

Path to menu variables file - theme aware

mixed $menu_id = 0 (line 69)

Unique database menu ID

mixed $menu_level = 0 (line 81)

Level of menu to render

mixed $menu_name = "" (line 60)

Menu name eg: 'main'

mixed $relative_positioned = false (line 78)

Positioned relatively, or not

mixed $stylesheet = "" (line 64)

Name of stylesheet file to get menu styles from

Methods
Constructor HVmenu (line 97)

Constructor Create the HV menu object.

HVmenu HVmenu ([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 (zero = default)
display_in_webpage (line 201)

Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.

NB: Normally the webpage passed in here is $RESPONSE. NOTE: The 'menu_com.js' module is not distributed with the Axyl library due to being non-free. It must be placed into the '$LIBDIR' of your website (see below) to enable this to work. There are various versions of this javascript menuing module available on the 'net.

void display_in_webpage (object $webpage)
  • object $webpage: Webpage object that this menu is being created for
html (line 217)

This renders the field as HTML.

Inserts the HTML DIV tag which the HVmenu will use to position itself to. The name of the DIV is taken from the unique menu ID, and corresponds to the TargetLoc variable defined above..

  • return: The menu anchor point (DIV) as 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.

Inherited Methods

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3