Docs For Class MenuItem

Description

MenuItem

components are a direct implementation of the

MenuItemInterface

interface. Their functionality is limited to displaying a text block

MenuItem

is an extension of

Component

;

MenuItems

have display names and the ability to be added to

Menu

objects.

version: $Id: MenuItem.class.php,v 1.1 2006/01/20 20:52:40 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/Components/MenuItem.class.php (line 20)

ComponentInterface
   |
   --Component
      |
      --MenuItem

Variable Summary

string $_text

Method Summary

MenuItem MenuItem (string $text, integer $index, optional 2)

string getDisplayName ()

void setDisplayName (string $text)

Variables

string $_text (line 27)

The display name of this menu item.

var: _text
access: private

Inherited Variables

Inherited from Component

Component::$_content
Component::$_id
Component::$_index
Component::$_postHTML
Component::$_preHTML
Component::$_styleCollections
Component::$_type

Methods

Constructor MenuItem (line 44)

The constructor.

access: public

MenuItem MenuItem (string $text, integer $index, optional 2)

optional 2
: object StyleCollections styles,... Zero, one, or more StyleCollection objects that will be added to the newly created Component. Warning, this will result in copying the objects instead of referencing them as using
```
addStyle()
```
would do.
string $text: text The display name of this menu item.
integer $index
: index The index of this component. The index has no semantic meaning: you can think of the index as 'level' of the component. Alternatively, the index could serve as means of distinguishing between components with the same type. Most often one would use the index in conjunction with the
```
getStylesForComponentType()
```
and
```
addStyleForComponentType()
```
methods.

getDisplayName (line 64)

Returns the display name of this menu item.

return: The display name of this menu item.
access: public

string getDisplayName ()

setDisplayName (line 73)

Sets the display name of this menu item.

access: public

void setDisplayName (string $text)

string $text: text The new display name.

Inherited Methods

Inherited From Component

Component::Component()
Component::addStyle()
Component::getId()
Component::getIndex()
Component::getPostHTML()
Component::getPreHTML()
Component::getStyle()
Component::getStyles()
Component::getType()
Component::removeStyle()
Component::render()
Component::setId()
Component::setPostHTML()
Component::setPreHTML()

Inherited From ComponentInterface

ComponentInterface::addStyle()
ComponentInterface::getIndex()
ComponentInterface::getPostHTML()
ComponentInterface::getPreHTML()
ComponentInterface::getStyle()
ComponentInterface::getStyles()
ComponentInterface::getType()
ComponentInterface::removeStyle()
ComponentInterface::render()
ComponentInterface::setPostHTML()
ComponentInterface::setPreHTML()