Docs For Class SubMenu

Description

<##>

version: $Id: SubMenu.class.php,v 1.3 2007/09/04 20:25:22 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 9/21/06

Located in /harmoni/core/GUIManager/Components/SubMenu.class.php (line 23)

ComponentInterface
   |
   --Component
      |
      --Container
         |
         --Menu
            |
            --SubMenu

Method Summary

SubMenu SubMenu (ref $layout, integer $index, optional 2)

Variables

Inherited Variables

Inherited from Menu

Menu::$_selectedId

Inherited from Container

Container::$_components
Container::$_constraints
Container::$_layout

Inherited from Component

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

Methods

Constructor SubMenu (line 42)

The constructor.

access: public

SubMenu SubMenu (ref $layout, 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.
ref $layout
: object layout The
```
Layout
```
of this container.
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.

Inherited Methods

Inherited From Menu

Menu::Menu()
Menu::add()
Menu::getSelected()
Menu::isSelected()
Menu::select()

Inherited From Container

Container::Container()
Container::add()
Container::addPlaceholder()
Container::getComponent()
Container::getComponentAlignmentX()
Container::getComponentAlignmentY()
Container::getComponentHeight()
Container::getComponents()
Container::getComponentsCount()
Container::getComponentWidth()
Container::getLayout()
Container::insertAtPlaceholder()
Container::remove()
Container::removeAll()
Container::render()
Container::setLayout()

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