Docs For Class JAdminCssMenu

Description

Tree based class to render the admin menu

since: 1.5

Located in /administrator/modules/mod_menu/menu.php (line 19)

JObject
   |
   --JAdminCssMenu

Variable Summary

string $_css

object $_current

object $_root

Method Summary

JAdminCssMenu __construct ()

void addChild (JMenuNode &$node, [boolean $setCurrent = false])

void addSeparator ()

string getIconClass (string $identifier)

void getParent ()

void renderLevel (integer $depth)

void renderMenu ([string $id = 'menu'], [string $class = ''])

void reset ()

Variables

string $_css = null (line 26)

CSS string to add to document head

access: protected

object $_current = null (line 40)

Current working node

access: protected

object $_root = null (line 33)

Root node

access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 45)

Constructor

access: public

JAdminCssMenu __construct ()

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

addChild (line 59)

Method to add a child

access: public

void addChild (JMenuNode &$node, [boolean $setCurrent = false])

JMenuNode &$node: The node to process
boolean $setCurrent: True to set as current working node

addSeparator (line 94)

Method to add a separator node

access: public

void addSeparator ()

getIconClass (line 265)

Method to get the CSS class name for an icon identifier or create one if a custom image path is passed as the identifier

return: CSS class name
since: 1.5
access: public

string getIconClass (string $identifier)

string $identifier: Icon identification string

getParent (line 74)

Method to get the parent

access: public

void getParent ()

renderLevel (line 149)

Method to render a given level of a menu

access: public

void renderLevel (integer $depth)

integer $depth: The level of the menu to be rendered

renderMenu (line 107)

Method to render the menu

access: public

void renderMenu ([string $id = 'menu'], [string $class = ''])

string $id: The id of the menu to be rendered
string $class: The class of the menu to be rendered

reset (line 84)

Method to get the parent

access: public

void reset ()

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()