Class MenuThemeAbstract

Description
Description | Descendents | Vars (details) | Methods (details)

This MenuTheme abstract class implements solely the 

  1. addMenu
    2.
and 
  1. getMenu
    2.

methods. If the user desires a proper complete implementation of the 

  1. MenuTheme
    2.
interface, then there are two ways of doing that:

  1. The user could overload setMenu so that as a new menu is added, it is appropriately incorporated in a 
    1. Container
      2.
    along with the 
    1. Theme
      2.
    component and all other previously added menus. This is the recommended solution.
  2. The user could overload root Theme methods (at least 
    1. printPage()
      2.
    ) to account for added menus. In other words, HTML generating methods will dynamically generate menu-related output as they are called.

A 

  1. MenuTheme
    2.
is an extension of the generic 
  1. Theme
    2.
interface that adds support for multi-level navigation menus. A 
  1. MenuTheme
    2.
, like a normal </code>Theme</code> has a single 
  1. Component
    2.
; however, it allows the user to surround that component with multi-level navigation menus.

  • version: $Id: MenuTheme.abstract.php,v 1.5 2007/09/04 20:25:21 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright &copy; 2005, Middlebury College

Located in /harmoni/core/GUIManager/MenuTheme.abstract.php (line 34) 

ThemeInterface
   |
   --Theme
      |
      --MenuThemeAbstract
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
DobomodeTheme An implementation of a Dobomode theme (as seen on www.dobomode.com)
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $_menus
Method Summary
Description | Descendents | Vars (details) | Methods (details)
void addMenu (ref $menu, integer $level)
ref getMenu (integer $level)
integer getNumberOfMenus ()
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_menus (line 41)

An array storing all menus of this theme. Each element is a 

  1. Menu
    2.
object.

Inherited Variables

Inherited from Theme

Theme::$_component
 Theme::$_componentPostHTML
 Theme::$_componentPreHTML
 Theme::$_componentStyles
 Theme::$_description
 Theme::$_displayName
 Theme::$_globalStyles
 Theme::$_headJavascript
 Theme::$_id
 Theme::$_pageTitle
 Theme::$_postImportMethods
 Theme::$_registeredSPs
 Theme::$_styles
Methods
Description | Descendents | Vars (details) Methods (details)
addMenu (line 51)

Adds a new menu to this theme.

  • access: public
void addMenu (ref $menu, integer $level)
  • ref $menu: object menu A 
    1. Menu
      2.
    object to be added to this theme.
  • integer $level: level A positive integer specifying the 
    1. level
      2.
    of the menu that is being added. Only one menu can exist at any given level. Levels cannot be skipped. Levels allow the user to create a hierarchy of menus.
getMenu (line 85)

Returns the menu (if exists) at the given level.

  • return: object The 
    1. Menu
      2.
    object at the specified level, or 
    1. NULL
      2.
    if no menu was found.
  • access: public
ref getMenu (integer $level)
  • integer $level: level An integer specifying the 
    1. level
      2.
    of the menu that is to be returned. Levels start at 1. Only one menu can exist at any given level. Levels cannot be skipped. Levels allow the user to create a hierarchy of menus.
getNumberOfMenus (line 103)

Returns the number of menus in this Theme.

  • return: The number of menus.
  • access: public
integer getNumberOfMenus ()

Inherited Methods

Inherited From Theme

Theme::Theme()
Theme::addGlobalStyle()
Theme::addStyleForComponentType()
Theme::exportAllRegisteredSPs()
Theme::exportRegisteredSP()
Theme::getAllRegisteredSPs()
Theme::getCollectionClass()
Theme::getComponent()
Theme::getCSS()
Theme::getCustom()
Theme::getDescription()
Theme::getDisplayName()
Theme::getGlobalStyles()
Theme::getId()
Theme::getPostHTMLForComponentType()
Theme::getPreHTMLForComponentType()
Theme::getRegisteredSP()
Theme::getStyleCollection()
Theme::getStyleCollections()
Theme::getStylesForComponentType()
Theme::getTemplate()
Theme::importRegisteredSP()
Theme::printPage()
Theme::registerSP()
Theme::removeStyleCollection()
Theme::setComponent()
Theme::setCustom()
Theme::setDescription()
Theme::setDisplayName()
Theme::setId()
Theme::setPostHTMLForComponentType()
Theme::setPreHTMLForComponentType()
Theme::setTemplate()
Theme::_getAllStyles()

Inherited From ThemeInterface

ThemeInterface::addGlobalStyle()
ThemeInterface::addStyleForComponentType()
ThemeInterface::exportAllRegisteredSPs()
ThemeInterface::exportRegisteredSP()
ThemeInterface::getAllRegisteredSPs()
ThemeInterface::getComponent()
ThemeInterface::getCSS()
ThemeInterface::getDescription()
ThemeInterface::getDisplayName()
ThemeInterface::getGlobalStyle()
ThemeInterface::getPostHTMLForComponentType()
ThemeInterface::getPreHTMLForComponentType()
ThemeInterface::getRegisteredSP()
ThemeInterface::getStylesForComponentType()
ThemeInterface::importRegisteredSP()
ThemeInterface::printPage()
ThemeInterface::registerSP()
ThemeInterface::setComponent()
ThemeInterface::setDescription()
ThemeInterface::setDisplayName()
ThemeInterface::setPostHTMLForComponentType()
ThemeInterface::setPreHTMLForComponentType()

Documentation generated on Wed, 19 Sep 2007 10:25:03 -0400 by phpDocumentor 1.3.0RC3