Docs For Class MenuItemLinkWithAdditionalHtml

Description

The

MenuItemLink

class is an extension of the

MenuItem

interface adding support for attaching extra data like URL, target window, an access key (shortcut), a toolTip, etc.

MenuItem

is an extension of

Component

;

MenuItems

have display names and the ability to be added to

Menu

objects.

version: $Id: MenuItemLinkWithAdditionalHtml.class.php,v 1.2 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/MenuItemLinkWithAdditionalHtml.class.php (line 18)

ComponentInterface
   |
   --Component
      |
      --MenuItemLink
         |
         --MenuItemLinkWithAdditionalHtml

Variable Summary

string $_additionalHtml

Method Summary

MenuItemLinkWithAdditionalHtml MenuItemLinkWithAdditionalHtml (string $displayName, string $url, boolean $selected, integer $index, [string $target = null], [string $accessKey = null], [string $toolTip = null], [mixed $additionalHtml = ''])

void render (ref $theme, [string $tabs = ""])

Variables

string $_additionalHtml (line 28)

var: <##>
since: 1/24/06
access: private

Inherited Variables

Inherited from MenuItemLink

MenuItemLink::$_accessKey
MenuItemLink::$_attributes
MenuItemLink::$_displayName
MenuItemLink::$_selected
MenuItemLink::$_target
MenuItemLink::$_toolTip
MenuItemLink::$_url

Inherited from Component

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

Methods

Constructor MenuItemLinkWithAdditionalHtml (line 46)

The constructor.

access: public

MenuItemLinkWithAdditionalHtml MenuItemLinkWithAdditionalHtml (string $displayName, string $url, boolean $selected, integer $index, [string $target = null], [string $accessKey = null], [string $toolTip = null], [mixed $additionalHtml = ''])

string $displayName: displayName The display name of this menu item.
string $url: url The url of this menu item.
boolean $selected: selected The selected state 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.
string $target: target The target window of this menu item.
string $accessKey: accessKey The access key (shortcut) of this menu item.
string $toolTip: toolTip The toolTip of this menu item.

render (line 67)

Renders the component on the screen.

access: public

void render (ref $theme, [string $tabs = ""])

ref $theme: object theme The Theme object to use in producing the result of this method.
string $tabs: tabs This is a string (normally a bunch of tabs) that will be prepended to each text line. This argument is optional but its usage is highly recommended in order to produce a nicely formatted HTML output.

Redefinition of:

MenuItemLink::render(): Renders the component on the screen.

Inherited Methods

Inherited From MenuItemLink

MenuItemLink::MenuItemLink()
MenuItemLink::addAttribute()
MenuItemLink::getAccessKey()
MenuItemLink::getDisplayName()
MenuItemLink::getTarget()
MenuItemLink::getToolTip()
MenuItemLink::getURL()
MenuItemLink::isSelected()
MenuItemLink::render()
MenuItemLink::setAccessKey()
MenuItemLink::setDisplayName()
MenuItemLink::setSelected()
MenuItemLink::setTarget()
MenuItemLink::setToolTip()
MenuItemLink::setURL()

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