Class P4A_Menu_Item

Description

Rapresents every menu item.

Located in /p4a/objects/widgets/menu.php (line 168)

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_Menu_Item
Variable Summary
 string $key
 menu_item $_active_item
 string $_icon
Method Summary
 P4A_Menu_Item P4A_Menu_Item (string $name)
 void &addItem (string $name, [string $label = null])
 void dropItem (string $name)
 void getActiveItem ()
 string getAsString ()
 string getIcon ()
 boolean hasItems ()
 void onClick ()
 void setAccessKey (string $key)
 void setActiveItem (string $name)
 void setIcon (string $icon)
 void unsetAccessKey ()
Variables
P4A_Collection $items = null (line 175)

Subelements array.

  • access: private
string $key = null (line 189)

Stores the shortkey associated with the element.

  • access: private
menu_item $_active_item = null (line 182)

The element/subelement currently active.

  • access: private
string $_icon = null (line 196)

Icon associated to the element

  • access: private

Inherited Variables

Inherited from P4A_Widget

P4A_Widget::$actions
P4A_Widget::$enabled
P4A_Widget::$label
P4A_Widget::$map_actions
P4A_Widget::$properties
P4A_Widget::$style
P4A_Widget::$template_name
P4A_Widget::$use_template
P4A_Widget::$value
P4A_Widget::$visible
P4A_Widget::$_temp_vars
P4A_Widget::$_tpl_vars

Inherited from P4A_Object

P4A_Object::$_helpers
P4A_Object::$_id
P4A_Object::$_map_actions
P4A_Object::$_name
P4A_Object::$_objects
P4A_Object::$_parent_id
Methods
Constructor P4A_Menu_Item (line 203)

Class constructor.

  • access: private
P4A_Menu_Item P4A_Menu_Item (string $name)
  • string $name: Mnemonic identifier for the object.
addItem (line 218)

Adds an element to the element.

  • access: public
void &addItem (string $name, [string $label = null])
  • string $name: Mnemonic identifier for the element.
  • string $label: Item's label.
dropItem (line 234)

Removes an element from the element.

  • access: public
void dropItem (string $name)
  • string $name: Mnemonic identifier for the element.
getActiveItem (line 273)

Returns the active item name

  • access: public
void getActiveItem ()
getAsString (line 335)

Renders HTML

  • access: public
string getAsString ()

Redefinition of:
P4A_Widget::getAsString()
Returns the HTML rendered widget.
getIcon (line 314)

Gets icon name

  • access: public
string getIcon ()
hasItems (line 249)

Returns true if the element has subelements.

  • access: public
boolean hasItems ()
onClick (line 325)

What is executed on a click on the element.

If the current element has subitems, than we pass the action to the subitem.

  • access: public
void onClick ()

Redefinition of:
P4A_Widget::onClick()
Wrapper used to add the handling of OnClick action.
setAccessKey (line 284)

Sets the access key for the element.

void setAccessKey (string $key)
  • string $key: The access key.

Redefinition of:
P4A_Widget::setAccessKey()
setActiveItem (line 263)

Sets the desidered subelement as active.

  • access: private
void setActiveItem (string $name)
  • string $name: Mnemonic identifier for the element.
setIcon (line 304)

Sets the icon

  • access: public
void setIcon (string $icon)
  • string $icon
unsetAccessKey (line 294)

Removes the access key for the element.

void unsetAccessKey ()

Inherited Methods

Inherited From P4A_Widget

 P4A_Widget::addAction()
 P4A_Widget::addAjaxAction()
 P4A_Widget::addTempVar()
 P4A_Widget::changeEvent()
 P4A_Widget::clearTemplateVars()
 P4A_Widget::clearTempVars()
 P4A_Widget::composeStringActions()
 P4A_Widget::composeStringClassStyle()
 P4A_Widget::composeStringProperties()
 P4A_Widget::composeStringStyle()
 P4A_Widget::disable()
 P4A_Widget::display()
 P4A_Widget::dropAction()
 P4A_Widget::dropTempVar()
 P4A_Widget::enable()
 P4A_Widget::fetchTemplate()
 P4A_Widget::getAccessKey()
 P4A_Widget::getAsString()
 P4A_Widget::getHeight()
 P4A_Widget::getLabel()
 P4A_Widget::getProperty()
 P4A_Widget::getStyleProperty()
 P4A_Widget::getValue()
 P4A_Widget::getWidth()
 P4A_Widget::isEnabled()
 P4A_Widget::isVisible()
 P4A_Widget::onBlur()
 P4A_Widget::onChange()
 P4A_Widget::onClick()
 P4A_Widget::onDblClick()
 P4A_Widget::onFocus()
 P4A_Widget::onKeyDown()
 P4A_Widget::onKeyPress()
 P4A_Widget::onKeyUp()
 P4A_Widget::onMouseDown()
 P4A_Widget::onMouseMove()
 P4A_Widget::onMouseOver()
 P4A_Widget::onMouseUp()
 P4A_Widget::onReturnPress()
 P4A_Widget::onSelect()
 P4A_Widget::p4a_widget()
 P4A_Widget::raise()
 P4A_Widget::redesign()
 P4A_Widget::requireConfirmation()
 P4A_Widget::setAccessKey()
 P4A_Widget::setBgcolor()
 P4A_Widget::setBgimage()
 P4A_Widget::setDefaultLabel()
 P4A_Widget::setFontColor()
 P4A_Widget::setFontWeight()
 P4A_Widget::setHeight()
 P4A_Widget::setInvisible()
 P4A_Widget::setLabel()
 P4A_Widget::setProperty()
 P4A_Widget::setStyleProperty()
 P4A_Widget::setValue()
 P4A_Widget::setVisible()
 P4A_Widget::setWidth()
 P4A_Widget::unrequireConfirmation()
 P4A_Widget::unsetProperty()
 P4A_Widget::unsetStyleProperty()
 P4A_Widget::useTemplate()

Inherited From P4A_Object

 P4A_Object::actionHandler()
 P4A_Object::build()
 P4A_Object::destroy()
 P4A_Object::dropIntercept()
 P4A_Object::errorHandler()
 P4A_Object::getId()
 P4A_Object::getName()
 P4A_Object::getObjectType()
 P4A_Object::getParentID()
 P4A_Object::implementMethod()
 P4A_Object::intercept()
 P4A_Object::isActionTriggered()
 P4A_Object::p4a_object()
 P4A_Object::setName()
 P4A_Object::setParentID()
 P4A_Object::void()
 P4A_Object::_loadHelper()
 P4A_Object::__call()

Documentation generated on Mon, 07 Jan 2008 11:29:26 +0100 by phpDocumentor 1.4.0