The Menu class creates a container that holds a vertical list representing
a set of options or commands. Menu is the base class for all
menu containers.
|
BOTTOM_LEFT<static> : String |
Overlay |
<static> Constant representing the top bottom left corner of an element, used for configuring the context eleme... |
|
BOTTOM_RIGHT<static> : String |
Overlay |
<static> Constant representing the bottom right corner of an element, used for configuring the context element ... |
|
CSS_CLASS_NAME : String |
Menu |
@description String representing the CSS class(es) to be applied to the
menu's <div> element.
@default "yuime... |
|
CSS_OVERLAY<static> : String |
Overlay |
<static> Constant representing the default CSS class used for an Overlay |
|
GROUP_TITLE_TAG_NAME : String |
Menu |
@description String representing the tagname of the HTML element used to
title the menu's item groups.
@default H6
@f... |
|
ITEM_TYPE : YAHOO.widget.MenuItem |
Menu |
@description Object representing the type of menu item to instantiate and
add when parsing the child nodes (either ... |
|
TOP_LEFT<static> : String |
Overlay |
<static> Constant representing the top left corner of an element, used for configuring the context element alig... |
|
TOP_RIGHT<static> : String |
Overlay |
<static> Constant representing the top right corner of an element, used for configuring the context element ali... |
|
activeItem : YAHOO.widget.MenuItem |
Menu |
@description Object reference to the item in the menu that has focus.
@default null |
|
cfg :
| Menu |
@config container
@description HTML element reference or string specifying the id
attribute of the HTML element that ... |
|
itemData : Array |
Menu |
@description Array of items to be added to the menu. The array can contain
strings representing the text for each it... |
|
javascript : String |
Overlay |
<static> The URL that will be placed in the iframe |
|
lazyLoad : Boolean |
Menu |
@description Boolean indicating if the menu's "lazy load" feature is
enabled. If set to "true," initialization and r... |
|
parent : YAHOO.widget.MenuItem |
Menu |
@description Object reference to the menu's parent menu or menu item.
This property can be set via the constructor us... |
|
srcElement :
| Menu |
@description Object reference to the HTML element (either
<select> or <div>) used to
create the menu.... |
|
value : Array |
Menu |
@config submenualignment
@description Array defining how submenus should be aligned to their
parent menu item. The fo... |
|
Menu() |
Menu |
|
|
_onClick(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description "click" event handler for the menu.
@protected |
|
_onKeyDown(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description "keydown" event handler for the menu.
@protected |
|
_onMouseOut(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description "mouseout" event handler for the menu.
@protected |
|
_onMouseOver(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description "mouseover" event handler for the menu.
@protected |
|
addItem(YAHOO.widget.MenuItem p_oItem , String p_oItem , Object p_oItem , Number p_nGroupIndex ) : YAHOO.widget.MenuItem |
Menu |
@description Appends an item to the menu. |
|
addItems(Array p_aItems , Number p_nGroupIndex ) : Array |
Menu |
@description Adds an array of items to the menu. |
|
align(String elementAlign , String contextAlign ) : void |
Overlay |
Aligns the Overlay to its context element using the specified corner points (represented by the constants TOP_LEFT, T... |
|
center() : void |
Overlay |
Centers the container in the viewport. |
|
clearActiveItem(Boolean p_bBlur ) : void |
Menu |
@description Sets the "selected" configuration property of the menu's active
item to "false" and hides the item's sub... |
|
configConstrainToViewport(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "constraintoviewport" property is changed. |
|
configContainer(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description Event handler for when the "container" configuration property
of the menu changes. |
|
configContext(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "context" property is changed. |
|
configFixedCenter(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "fixedcenter" property is changed. |
|
configHeight(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "height" property is changed. |
|
configHideDelay(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description Event handler for when the "hidedelay" configuration property
of the menu changes. |
|
configIframe(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description Event handler for when the "iframe" configuration property of
the menu changes. |
|
configPosition(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description Event handler for when the "position" configuration property
of the menu changes. |
|
configVisible(String p_sType , Array p_aArgs , YAHOO.widget.Menu p_oMenu ) : void |
Menu |
@description Event handler for when the "visible" configuration property
the menu changes. |
|
configWidth(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "width" property is changed. |
|
configX(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "x" property is changed. |
|
configXY(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "xy" property is changed. |
|
configY(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "y" property is changed. |
|
configzIndex(String type , Object[] args , Object obj ) : void |
Overlay |
The default event handler fired when the "zIndex" property is changed. |
|
destroy() : void |
Menu |
@description Removes the menu's <div> element
(and accompanying child nodes) from the document. |
|
doCenterOnDOMEvent() : void |
Overlay |
Center event handler used for centering on scroll/resize, but only if the Overlay is visible |
|
enforceConstraints(String type , Array args , Array obj ) : void |
Menu |
@description The default event handler executed when the moveEvent is fired,
if the "constraintoviewport" configurati... |
|
getItem(Number p_nItemIndex , Number p_nGroupIndex ) : YAHOO.widget.MenuItem |
Menu |
@description Returns the item at the specified index. |
|
getItemGroups() : Array |
Menu |
@description Returns a multi-dimensional array of all of the items in the menu. |
|
getRoot() : void |
Menu |
@description Finds the menu's root menu. |
|
hideIframe() : void |
Overlay |
Hides the iframe shim, if it has been enabled |
|
hideMacGeckoScrollbars() : void |
Overlay |
Adds a special CSS class to the Overlay when Mac/Gecko is in use, to work around a Gecko bug where
scrollbars cannot ... |
|
init(String p_oElement , String p_oElement , , Object p_oConfig ) : void |
Menu |
@description The Menu class's initialization method. This method is
automatically called by the constructor, and sets... |
|
initDefaultConfig() : void |
Menu |
@description Initializes the class's configurable properties which can be
changed using the menu's Config object ("cf... |
|
initEvents() : void |
Menu |
@description Initializes the custom events for the menu. |
|
insertItem(YAHOO.widget.MenuItem p_oItem , String p_oItem , Object p_oItem , Number p_nItemIndex , Number p_nGroupIndex ) : YAHOO.widget.MenuItem |
Menu |
@description Inserts an item into the menu at the specified index. |
|
moveTo(Number x , Number y ) : void |
Overlay |
Moves the Overlay to the specified position. This function is identical to calling this.cfg.setProperty("xy", [x,y]); |
|
onDomResize() : void |
Menu |
Event handler called when the resize monitor element's "resize" evet is fired. |
|
removeItem(YAHOO.widget.MenuItem p_oObject , Number p_oObject , Number p_nGroupIndex ) : YAHOO.widget.MenuItem |
Menu |
@description Removes the specified item from the menu. |
|
setInitialFocus() : void |
Menu |
@description Sets focus to the menu's first enabled item. |
|
setInitialSelection() : void |
Menu |
@description Sets the "selected" configuration property of the menu's first
enabled item to "true." |
|
setItemGroupTitle(String p_sGroupTitle , Number p_nGroupIndex ) : void |
Menu |
@description Sets the title of a group of menu items. |
|
showIframe() : void |
Overlay |
Shows the iframe shim, if it has been enabled |
|
showMacGeckoScrollbars() : void |
Overlay |
Removes a special CSS class from the Overlay when Mac/Gecko is in use, to work around a Gecko bug where
scrollbars ca... |
|
syncPosition() : void |
Overlay |
Synchronizes the Panel's "xy", "x", and "y" properties with the Panel's position in the DOM. This is primarily used t... |
|
toString() : String |
Menu |
@description Returns a string representing the menu. |
|
windowResizeHandler<static>(DOMEvent e ) : void |
Overlay |
<static> The DOM event handler used to fire the CustomEvent for window resize |
|
windowScrollHandler<static>(DOMEvent e ) : void |
Overlay |
<static> The DOM event handler used to fire the CustomEvent for window scroll |
BOTTOM_LEFT<static>
public String BOTTOM_LEFT<static>
<static> Constant representing the top bottom left corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
BOTTOM_RIGHT<static>
public String BOTTOM_RIGHT<static>
<static> Constant representing the bottom right corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
CSS_CLASS_NAME
public String CSS_CLASS_NAME
@description String representing the CSS class(es) to be applied to the
menu's <div>
element.
@default "yuimenu"
@final
This property is defined by Menu.
CSS_OVERLAY<static>
public String CSS_OVERLAY<static>
<static> Constant representing the default CSS class used for an Overlay
This property is defined by
Overlay.
GROUP_TITLE_TAG_NAME
public String GROUP_TITLE_TAG_NAME
@description String representing the tagname of the HTML element used to
title the menu's item groups.
@default H6
@final
This property is defined by Menu.
ITEM_TYPE
public YAHOO.widget.MenuItem ITEM_TYPE
@description Object representing the type of menu item to instantiate and
add when parsing the child nodes (either <li>
element,
<optgroup>
element or <option>
)
of the menu's source HTML element.
@default YAHOO.widget.MenuItem
@final
This property is defined by Menu.
TOP_LEFT<static>
public String TOP_LEFT<static>
<static> Constant representing the top left corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
TOP_RIGHT<static>
public String TOP_RIGHT<static>
<static> Constant representing the top right corner of an element, used for configuring the context element alignment
This property is defined by
Overlay.
activeItem
public YAHOO.widget.MenuItem activeItem
@description Object reference to the item in the menu that has focus.
@default null
This property is defined by Menu.
itemData
public Array itemData
@description Array of items to be added to the menu. The array can contain
strings representing the text for each item to be created, object literals
representing the menu item configuration properties, or MenuItem instances.
This property should be set via the constructor using the configuration
object literal.
@default null
This property is defined by Menu.
javascript
public String javascript
<static> The URL that will be placed in the iframe
This property is defined by
Overlay.
lazyLoad
public Boolean lazyLoad
@description Boolean indicating if the menu's "lazy load" feature is
enabled. If set to "true," initialization and rendering of the menu's
items will be deferred until the first time it is made visible. This
property should be set via the constructor using the configuration
object literal.
@default false
This property is defined by Menu.
parent
public YAHOO.widget.MenuItem parent
@description Object reference to the menu's parent menu or menu item.
This property can be set via the constructor using the configuration
object literal.
@default null
This property is defined by Menu.
value
public Array value
@config submenualignment
@description Array defining how submenus should be aligned to their
parent menu item. The format is: [itemCorner, submenuCorner]. By default
a submenu's top left corner is aligned to its parent menu item's top
right corner.
@default ["tl","tr"]
This property is defined by Menu.
This method is defined by Menu.