Docs For Class MenuInterface

Description

A

Menu

is a

Container

that stores a number of MenuItem objects. The familiar add/get/remove

Container

methods can be used to manage the

MenuItems

.

version: $Id: Menu.interface.php,v 1.5 2007/09/04 20:25:22 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/Components/Menu.interface.php (line 17)

ComponentInterface
   |
   --ContainerInterface
      |
      --MenuInterface

Method Summary

ref getSelected ()

boolean isSelected (integer $id)

void select (integer $id)

Methods

getSelected (line 24)

Returns the menu item that is currently selected.

return: object The menu item that is currently selected.
access: public

ref getSelected ()

isSelected (line 37)

Determines whether the

MenuItem

with the given id is selected. Ids reflect the order in which menu items are added. That is, the very first menu item has an id of 1, the second menu item has an id of 2, and so forth.

return:
```
TRUE
```
, if the menu item with the given id is selected.
access: public

boolean isSelected (integer $id)

integer $id: id The id of the menu item.

select (line 48)

Selects the

MenuItem

with the given id, and deselects all the others. Ids reflect the order in which menu items are added. That is, the very first menu item has an id of 1, the second menu item has an id of 2, and so forth.

access: public

void select (integer $id)

integer $id: id The id of the menu item to select.

Inherited Methods

Inherited From ContainerInterface

ContainerInterface::add()
ContainerInterface::getComponent()
ContainerInterface::getComponentAlignmentX()
ContainerInterface::getComponentAlignmentY()
ContainerInterface::getComponentHeight()
ContainerInterface::getComponents()
ContainerInterface::getComponentsCount()
ContainerInterface::getComponentWidth()
ContainerInterface::getLayout()
ContainerInterface::remove()
ContainerInterface::removeAll()
ContainerInterface::setLayout()

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()