Class WFYAHOO_widget_Menu

Description

A YAHOO Menu widget for our framework. This widget allows you to easily create vertical or horizontal multi-level menus.

PHOCOA Builder Setup:

Required:
menuItems - An array of objects implementing WFMenuItem

Optional:
horizontal - TRUE to make this a menu bar. FALSE for a vertical set of menu items. Default: TRUE.

Located in /framework/widgets/yahoo/WFYAHOO_widget_Menu.php (line 22)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFYAHOO
            |
            --WFYAHOO_widget_Menu
Variable Summary
mixed $horizontal
mixed $menuItems
Method Summary
static void exposedProperties ()
WFYAHOO_widget_Menu __construct ( $id,  $page)
void initJS ( $blockContent)
void menuItemToHTML ( $item, [ $root = true])
void render ([ $blockContent = NULL])
void setHorizontal ( $h)
void setMenuItems (array $items)
void setMenuItemsMenuPath ( $items)
void setMenuItemsNestedArray ( $items)
void valueForUndefinedKey ( $key)
Variables
Methods
static method exposedProperties (line 75)
  • access: public
static void exposedProperties ()

Redefinition of:
WFWidget::exposedProperties()
Constructor __construct (line 30)

Constructor.

WFYAHOO_widget_Menu __construct ( $id,  $page)
  • $id
  • $page

Redefinition of:
WFYAHOO::__construct()
Constructor.
canPushValueBinding (line 159)
void canPushValueBinding ()

Redefinition of:
WFYAHOO::canPushValueBinding()
initJS (line 102)
void initJS ( $blockContent)
  • $blockContent

Redefinition of:
WFYAHOO::initJS()
The initJS function is where YUI widgets perform their bootstrap/initialization.
menuItemToHTML (line 118)
void menuItemToHTML ( $item, [ $root = true])
  • $item
  • $root
render (line 83)
void render ([ $blockContent = NULL])
  • $blockContent

Redefinition of:
WFYAHOO::render()
IMPORTANT: The subclasses should get the base class's html, then add the needed code.
setHorizontal (line 55)
void setHorizontal ( $h)
  • $h
setMenuItems (line 42)
void setMenuItems (array $items)
  • array $items: An array of objects conforming to WFMenuItem.
setMenuItemsMenuPath (line 50)
void setMenuItemsMenuPath ( $items)
  • $items
setMenuItemsNestedArray (line 46)
void setMenuItemsNestedArray ( $items)
  • $items
setupExposedBindings (line 60)
void setupExposedBindings ()

Redefinition of:
WFWidget::setupExposedBindings()
Set up all exposed bindings for this widget.
valueForUndefinedKey (line 165)

This is a hack...

  • todo: Do we need a WFObject::keyExists() function or similar that can "check" for a binding without having to call the accessor? or WFObject::canSetKey()? Or do binding need to have a "readyonly" or "writeonly" option?
void valueForUndefinedKey ( $key)
  • $key

Redefinition of:
WFObject::valueForUndefinedKey()
Called by valueForKey() if the key cannot be located through normal methods.

Inherited Methods

Inherited From WFYAHOO

WFYAHOO::__construct()
WFYAHOO::canPushValueBinding()
WFYAHOO::initJS()
WFYAHOO::jsForSimplePropertyConfig()
WFYAHOO::jsValueForValue()
WFYAHOO::render()
WFYAHOO::yuiloader()

Inherited From WFWidget

WFWidget::__construct()
WFWidget::addError()
WFWidget::addErrors()
WFWidget::bind()
WFWidget::bindingByName()
WFWidget::bindings()
WFWidget::canPushValueBinding()
WFWidget::errors()
WFWidget::exposedBindings()
WFWidget::exposedProperties()
WFWidget::formattedValue()
WFWidget::formatter()
WFWidget::hasRestoredState()
WFWidget::hidden()
WFWidget::name()
WFWidget::processBindingOptions()
WFWidget::propagateValueToBinding()
WFWidget::pullBindings()
WFWidget::pushBindings()
WFWidget::restoreState()
WFWidget::setFormatter()
WFWidget::setHidden()
WFWidget::setName()
WFWidget::setupExposedBindings()
WFWidget::setValue()
WFWidget::setWidgetLabel()
WFWidget::unbind()
WFWidget::value()
WFWidget::valueForBinding()
WFWidget::widgetLabel()

Inherited From WFView

WFView::__construct()
WFView::addChild()
WFView::allConfigFinishedLoading()
WFView::children()
WFView::cloneWithID()
WFView::enabled()
WFView::exposedProperties()
WFView::getForm()
WFView::getJSActions()
WFView::getListenerJS()
WFView::getListenerJSInScriptTag()
WFView::getOnEvent()
WFView::getWidgetDir()
WFView::getWidgetWWWDir()
WFView::id()
WFView::importCSS()
WFView::importJS()
WFView::jsEndHTML()
WFView::jsStartHTML()
WFView::page()
WFView::parent()
WFView::removeChild()
WFView::render()
WFView::setEnabled()
WFView::setId()
WFView::setJSonBlur()
WFView::setJSonClick()
WFView::setListener()
WFView::setOnEvent()
WFView::setParent()
WFView::yuiPath()

Inherited From WFObject

WFObject::__construct()
WFObject::exposedProperties()
WFObject::getClass()
WFObject::keyPathToTargetAndKey()
WFObject::setValueForKey()
WFObject::setValueForKeyPath()
WFObject::setValuesForKeys()
WFObject::validatedSetValueForKey()
WFObject::validatedSetValueForKeyPath()
WFObject::validateObject()
WFObject::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForStaticKey()
WFObject::valueForStaticKeyPath()
WFObject::valueForTargetAndKeyPath()
WFObject::valueForUndefinedKey()
WFObject::valueForUndefinedStaticKey()
WFObject::valuesForKeyPaths()
WFObject::valuesForKeys()
WFObject::_valueForStaticKey()
WFObject::__toString()

Documentation generated on Thu, 14 May 2009 16:20:49 -0400 by phpDocumentor 1.4.2