Class: PhpExt_Menu_Menu

Source Location: /PhpExt/Menu/Menu.php

Class PhpExt_Menu_Menu

Class Overview

A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class when you want a specialzed menu based off of another component (like for example).

Located in /PhpExt/Menu/Menu.php [line 30]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Menu_Menu

Properties

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Menu_ColorMenu	A menu containing a Ext.menu.ColorItem component (which provides a basic color picker).
PhpExt_Menu_DateMenu	A menu containing a Ext.menu.DateItem component (which provides a date picker).

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()

PhpExt_Observable::attachListener()

Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.

PhpExt_Observable::getConfigParams()

PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

[ Top ]

Property Summary

mixed	$AllowOtherMenus
mixed	$DefaultAlign
mixed	$Defaults
mixed	$Items
mixed	$MinWidth
mixed	$Shadow
mixed	$SubMenuAlign
PhpExt_Menu_BaseItemCollection	$_items

[ Top ]

Method Summary

PhpExt_Menu_Menu	__construct()
PhpExt_Menu_Menu	addCheckItem()	Helper function to quick add a checkitem
PhpExt_Menu_Menu	addItem()	Helper function to quick add an item
PhpExt_Menu_Menu	addSeparator()	Helper function to quick add a separator
PhpExt_Menu_Menu	addTextItem()	Helper function to quick add a textitem
boolean	getAllowOtherMenus()	True to allow multiple menus to be displayed at the same time (defaults to false)
boolean	getDefaultAlign()	The default PhpExt_Ext::combineAnchors() anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")
PhpExt_Config_ConfigObject	getDefaults()	A config object that will be applied to all items added to this container either via the items config or via the add method. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the menu.
PhpExt_Menu_BaseItemCollection	getItems()	An array of items to be added to this menu. See add for a list of valid item types.
integer	getMinWidth()	The minimum width of the menu in pixels (defaults to 120)
string	getShadow()	True or PhpExt_Shadow::$MODE_SIDES for the default effect, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_SIDES)
string	getSubMenuAlign()	The PhpExt_Ext::combineAnchors() anchor position value to use for submenus of this menu (defaults to "tl-tr?")
PhpExt_Menu_Menu	setAllowOtherMenus()	True to allow multiple menus to be displayed at the same time (defaults to false)
PhpExt_Menu_Menu	setDefaultAlign()	The default PhpExt_Ext::combineAnchors() anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")
PhpExt_Menu_Menu	setDefaults()	A config object that will be applied to all items added to this container either via the items config or via the add method. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the menu.
PhpExt_Menu_Menu	setMinWidth()	The minimum width of the menu in pixels (defaults to 120)
PhpExt_Menu_Menu	setShadow()	True or PhpExt_Shadow::$MODE_SIDES for the default effect, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_SIDES)
PhpExt_Menu_Menu	setSubMenuAlign()	The PhpExt_Ext::combineAnchors() anchor position value to use for submenus of this menu (defaults to "tl-tr?")

[ Top ]

Properties

mixed $AllowOtherMenus = false [line 192]

API Tags:

Access:

public

[ Top ]

mixed $DefaultAlign = null [line 193]

API Tags:

Access:

public

[ Top ]

mixed $Defaults = null [line 194]

API Tags:

Access:

public

[ Top ]

mixed $Items = array() [line 195]

API Tags:

Access:

public

[ Top ]

mixed $MinWidth = null [line 196]

API Tags:

Access:

public

[ Top ]

mixed $Shadow = null [line 197]

API Tags:

Access:

public

[ Top ]

mixed $SubMenuAlign = null [line 198]

API Tags:

Access:

public

[ Top ]

PhpExt_Menu_BaseItemCollection $_items [line 90]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 201]

PhpExt_Menu_Menu __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Observable::__construct()

Redefined in descendants as:

[ Top ]

addCheckItem [line 110]

PhpExt_Menu_Menu addCheckItem(

$key, 
$text, [
$handler = null] 
)

Helper function to quick add a checkitem

Parameters:

	$key:
	$text:
	$handler:

API Tags:

Access:

public

[ Top ]

addItem [line 126]

PhpExt_Menu_Menu addItem(

$key, PhpExt_Menu_BaseItem
$item 
)

Helper function to quick add an item

Parameters:

	$key:
PhpExt_Menu_BaseItem	$item:

API Tags:

Access:

public

[ Top ]

addSeparator [line 102]

PhpExt_Menu_Menu addSeparator(

$key 
)

Helper function to quick add a separator

Parameters:

$key:

API Tags:

Access:

public

[ Top ]

addTextItem [line 118]

PhpExt_Menu_Menu addTextItem(

$key, 
$text, [
$handler = null] 
)

Helper function to quick add a textitem

Parameters:

	$key:
	$text:
	$handler:

API Tags:

Access:

public

[ Top ]

getAllowOtherMenus [line 46]

boolean getAllowOtherMenus(
)

True to allow multiple menus to be displayed at the same time (defaults to false)

API Tags:

Access:

public

[ Top ]

getDefaultAlign [line 64]

boolean getDefaultAlign(
)

The default PhpExt_Ext::combineAnchors() anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")

API Tags:

Access:

public

[ Top ]

getDefaults [line 82]

PhpExt_Config_ConfigObject getDefaults(
)

A config object that will be applied to all items added to this container either via the items config or via the add method. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the menu.

API Tags:

Access:

public

[ Top ]

getItems [line 95]

PhpExt_Menu_BaseItemCollection getItems(
)

An array of items to be added to this menu. See add for a list of valid item types.

API Tags:

Access:

public

[ Top ]

getMinWidth [line 146]

integer getMinWidth(
)

The minimum width of the menu in pixels (defaults to 120)

API Tags:

Access:

public

[ Top ]

getShadow [line 170]

string getShadow(
)

True or PhpExt_Shadow::$MODE_SIDES for the default effect, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_SIDES)

API Tags:

Access:	public
Uses:	PhpExt_Shadow::$MODE_SIDES
Uses:	PhpExt_Shadow::$MODE_FRAME
Uses:	PhpExt_Shadow::$MODE_DROP

[ Top ]

getSubMenuAlign [line 188]

string getSubMenuAlign(
)

The PhpExt_Ext::combineAnchors() anchor position value to use for submenus of this menu (defaults to "tl-tr?")

API Tags:

Access:

public

[ Top ]

setAllowOtherMenus [line 38]

PhpExt_Menu_Menu setAllowOtherMenus(
boolean
$value 
)

True to allow multiple menus to be displayed at the same time (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setDefaultAlign [line 56]

PhpExt_Menu_Menu setDefaultAlign(
boolean
$value 
)

The default PhpExt_Ext::combineAnchors() anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setDefaults [line 74]

PhpExt_Menu_Menu setDefaults(
PhpExt_Config_ConfigObject
$value 
)

Parameters:

PhpExt_Config_ConfigObject

$value:

API Tags:

Access:

public

[ Top ]

setMinWidth [line 138]

PhpExt_Menu_Menu setMinWidth(
integer
$value 
)

The minimum width of the menu in pixels (defaults to 120)

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setShadow [line 159]

PhpExt_Menu_Menu setShadow(
string
$value 
)

True or PhpExt_Shadow::$MODE_SIDES for the default effect, PhpExt_Shadow::MODE_FRAME for 4-way shadow, and PhpExt_Shadow::MODE_DROP for bottom-right shadow (defaults to PhpExt_Shadow::MODE_SIDES)

Parameters:

string

$value:

API Tags:

Access:	public
Uses:	PhpExt_Shadow::$MODE_SIDES
Uses:	PhpExt_Shadow::$MODE_FRAME
Uses:	PhpExt_Shadow::$MODE_DROP

[ Top ]

setSubMenuAlign [line 180]

PhpExt_Menu_Menu setSubMenuAlign(
string
$value 
)

The PhpExt_Ext::combineAnchors() anchor position value to use for submenus of this menu (defaults to "tl-tr?")

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:56:41 -0500 by phpDocumentor 1.4.0