webgui/www/extras/yui/docs/YAHOO.widget.Menu.html
JT Smith cfd09a5cb6 upgraded to yui 0.12.0
upgraded to yui-ext 0.33 rc2
2006-11-28 02:23:34 +00:00

4489 lines
237 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: menu YAHOO.widget.Menu (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css">
<link rel="stylesheet" type="text/css" href="assets/api.css">
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1>Yahoo! UI Library</h1>
<h3>Menu Library&nbsp;</h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_menu.html">menu</a>
&gt; YAHOO.widget.Menu
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<h2>
Class <b>YAHOO.widget.Menu</b>
<span class="extends">
- extends <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<dl class="subclasses">
<dt>Known Subclasses:</dd>
<dd>
<a href="YAHOO.widget.ContextMenu.html">YAHOO.widget.ContextMenu</a>
<a href="YAHOO.widget.Menubar.html">YAHOO.widget.Menubar</a>
</dd>
</dl>
<div class="summary description">
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.
</div>
<div class="section constructor details">
<h3><a name="constructor_detail">Constructor</a></h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Menu</strong>
<code>
(
p_oElement
,
p_oConfig
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oElement
&lt;String&gt;
</code>
String specifying the id attribute of the
<code>&#60;div&#62;</code> element of the menu.
</dd>
<dd>
<code>p_oElement
&lt;String&gt;
</code>
String specifying the id attribute of the
<code>&#60;select&#62;</code> element to be used as the data source
for the menu.
</dd>
<dd>
<code>p_oElement
&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a>&gt;
</code>
Object
specifying the <code>&#60;div&#62;</code> element of the menu.
</dd>
<dd>
<code>p_oElement
&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>&gt;
</code>
Object specifying the <code>&#60;select&#62;</code> element to be used as
the data source for the menu.
</dd>
<dd>
<code>p_oConfig
&lt;Object&gt;
</code>
Optional. Object literal specifying the
configuration for the menu. See configuration class documentation for
more details.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3><a name="field_detail">Properties</a></h3>
<div class="content">
<h4><a name="_aGroupTitleElements">_aGroupTitleElements</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
Array of HTML element used to title groups of menu items.
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
<h4><a name="_aItemGroups">_aItemGroups</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
Array of menu items.
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
<h4><a name="_aListElements">_aListElements</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
Array of <code>&#60;ul&#62;</code> elements, each of which is
the parent node for each item's <code>&#60;li&#62;</code> element.
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
<h4><a name="_bHandledMouseOutEvent">_bHandledMouseOutEvent</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating the current state of the menu's
"mouseout" event.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="_bHandledMouseOverEvent">_bHandledMouseOverEvent</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating the current state of the menu's
"mouseover" event.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="_hideDelayEventHandlersAssigned">_hideDelayEventHandlersAssigned</a>
<code>- private Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the "mouseover" and "mouseout" event
handlers used for hiding the menu via a call to "window.setTimeout" have
already been assigned.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="_nHideDelayId">_nHideDelayId</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Number representing the time-out setting used to cancel the
hiding of a menu.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
<h4><a name="_nShowDelayId">_nShowDelayId</a>
<code>- private Number</code>
</h4>
<div class="detail">
<div class="description">
Number representing the time-out setting used to cancel the
showing of a menu.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
<h4><a name="activeItem">activeItem</a>
<code>- YAHOO.widget.MenuItem</code>
</h4>
<div class="detail">
<div class="description">
Object reference to the item in the menu that has focus.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
<h4><a name="CSS_CLASS_NAME">CSS_CLASS_NAME</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the CSS class(es) to be applied to the
menu's <code>&#60;div&#62;</code> element.
</div>
</div>
<div class="default">
Default Value: "yuimenu"
</div>
<hr />
<h4><a name="getNextItemSibling">getNextItemSibling</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
Returns the next sibling of an item in an array.
</div>
</div>
<hr />
<h4><a name="GROUP_TITLE_TAG_NAME">GROUP_TITLE_TAG_NAME</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the tagname of the HTML element used to
title the menu's item groups.
</div>
</div>
<div class="default">
Default Value: H6
</div>
<hr />
<h4><a name="ITEM_TYPE">ITEM_TYPE</a>
<code>- final YAHOO.widget.MenuItem</code>
</h4>
<div class="detail">
<div class="description">
Object representing the type of menu item to instantiate and
add when parsing the child nodes (either <code>&#60;li&#62;</code> element,
<code>&#60;optgroup&#62;</code> element or <code>&#60;option&#62;</code>)
of the menu's source HTML element.
</div>
</div>
<div class="default">
Default Value: YAHOO.widget.MenuItem
</div>
<hr />
<h4><a name="itemData">itemData</a>
<code>- Array</code>
</h4>
<div class="detail">
<div class="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.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
<h4><a name="lazyLoad">lazyLoad</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="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.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
<h4><a name="parent">parent</a>
<code>- YAHOO.widget.MenuItem</code>
</h4>
<div class="detail">
<div class="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.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
<h4><a name="srcElement">srcElement</a>
<code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a></code>
</h4>
<div class="detail">
<div class="description">
Object reference to the HTML element (either
<code>&#60;select&#62;</code> or <code>&#60;div&#62;</code>) used to
create the menu.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Module.html#body">body</a>,
<a href="YAHOO.widget.Module.html#browser">browser</a>,
<a href="YAHOO.widget.Module.html#cfg">cfg</a>,
<a href="YAHOO.widget.Module.html#contructor">contructor</a>,
<a href="YAHOO.widget.Module.html#element">element</a>,
<a href="YAHOO.widget.Module.html#footer">footer</a>,
<a href="YAHOO.widget.Module.html#header">header</a>,
<a href="YAHOO.widget.Module.html#id">id</a>,
<a href="YAHOO.widget.Module.html#imageRoot">imageRoot</a>,
<a href="YAHOO.widget.Module.html#isSecure">isSecure</a>,
<a href="YAHOO.widget.Module.html#platform">platform</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Overlay.html#YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized</a>
</code>
</div>
</div>
<div class="section method details">
<h3><a name="methodDetails">Methods</a></h3>
<div class="content">
<h4>
<a name="_addItemToGroup">_addItemToGroup</a></h4>
<div class="detail">
<code>
private
YAHOO.widget.MenuItem
<strong>_addItemToGroup</strong>
(
p_nGroupIndex
,
p_oItem
,
p_nItemIndex
)
</code>
<div class="description">
Adds a menu item to a group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Number indicating the group to which the
item belongs.
</dd>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance to be added to the menu.
</dd>
<dd>
<code>p_oItem &lt;String&gt;</code>
String specifying the text of the item to be added
to the menu.
</dd>
<dd>
<code>p_oItem &lt;Object&gt;</code>
Object literal containing a set of menu item
configuration properties.
</dd>
<dd>
<code>p_nItemIndex &lt;Number&gt;</code>
Optional. Number indicating the index at
which the menu item should be added.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_cancelHideDelay">_cancelHideDelay</a></h4>
<div class="detail">
<code>
private
void
<strong>_cancelHideDelay</strong>
(
)
</code>
<div class="description">
Cancels the call to "hideMenu."
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_cancelShowDelay">_cancelShowDelay</a></h4>
<div class="detail">
<code>
private
void
<strong>_cancelShowDelay</strong>
(
)
</code>
<div class="description">
Cancels the call to the "showMenu."
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_checkPosition">_checkPosition</a></h4>
<div class="detail">
<code>
private
Boolean
<strong>_checkPosition</strong>
(
p_sPosition
)
</code>
<div class="description">
Checks to make sure that the value of the "position" property
is one of the supported strings. Returns true if the position is supported.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sPosition &lt;Object&gt;</code>
String specifying the position of the menu.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_configureSubmenu">_configureSubmenu</a></h4>
<div class="detail">
<code>
private
void
<strong>_configureSubmenu</strong>
(
p_oItem
)
</code>
<div class="description">
Subscribes the menu item's submenu to its parent menu's events.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance with the submenu to be configured.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_createItemGroup">_createItemGroup</a></h4>
<div class="detail">
<code>
private
Array
<strong>_createItemGroup</strong>
(
p_nIndex
)
</code>
<div class="description">
Creates a new menu item group (array) and its associated
<code>&#60;ul&#62;</code> element. Returns an aray of menu item groups.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
Number indicating the group to create.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_execHideDelay">_execHideDelay</a></h4>
<div class="detail">
<code>
private
void
<strong>_execHideDelay</strong>
(
)
</code>
<div class="description">
Hides the menu after the number of milliseconds specified by
the "hidedelay" configuration property.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_execShowDelay">_execShowDelay</a></h4>
<div class="detail">
<code>
private
void
<strong>_execShowDelay</strong>
(
p_oMenu
)
</code>
<div class="description">
Shows the menu after the number of milliseconds specified by
the "showdelay" configuration property have ellapsed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object specifying the menu that should
be made visible.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_getFirstEnabledItem">_getFirstEnabledItem</a></h4>
<div class="detail">
<code>
private
YAHOO.widget.MenuItem
<strong>_getFirstEnabledItem</strong>
(
)
</code>
<div class="description">
Returns the first enabled item in the menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_getItemGroup">_getItemGroup</a></h4>
<div class="detail">
<code>
private
Array
<strong>_getItemGroup</strong>
(
p_nIndex
)
</code>
<div class="description">
Returns the menu item group at the specified index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
Number indicating the index of the menu item group
to be retrieved.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_getOffsetWidth">_getOffsetWidth</a></h4>
<div class="detail">
<code>
private
void
<strong>_getOffsetWidth</strong>
(
)
</code>
<div class="description">
Returns the offset width of the menu's
<code>&#60;div&#62;</code> element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_initSubTree">_initSubTree</a></h4>
<div class="detail">
<code>
private
void
<strong>_initSubTree</strong>
(
)
</code>
<div class="description">
Iterates the childNodes of the source element to find nodes
used to instantiate menu and menu items.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onBeforeHide">_onBeforeHide</a></h4>
<div class="detail">
<code>
private
void
<strong>_onBeforeHide</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"beforehide" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that fired
the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onBeforeRender">_onBeforeRender</a></h4>
<div class="detail">
<code>
private
void
<strong>_onBeforeRender</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"beforerender" event handler for the menu. Appends all of the
<code>&#60;ul&#62;</code>, <code>&#60;li&#62;</code> and their accompanying
title elements to the body element of the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onBeforeShow">_onBeforeShow</a></h4>
<div class="detail">
<code>
private
void
<strong>_onBeforeShow</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"beforeshow" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onClick">_onClick</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onClick</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"click" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onInit">_onInit</a></h4>
<div class="detail">
<code>
private
void
<strong>_onInit</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"init" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onKeyDown">_onKeyDown</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onKeyDown</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"keydown" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMenuItemBlur">_onMenuItemBlur</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuItemBlur</strong>
(
p_sType
,
p_aArgs
)
</code>
<div class="description">
"blur" event handler for the menu's items.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMenuItemConfigChange">_onMenuItemConfigChange</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuItemConfigChange</strong>
(
p_sType
,
p_aArgs
,
p_oItem
)
</code>
<div class="description">
"configchange" event handler for the menu's items.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object representing the menu item
that fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMenuItemFocus">_onMenuItemFocus</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuItemFocus</strong>
(
p_sType
,
p_aArgs
,
p_oItem
)
</code>
<div class="description">
"focus" event handler for the menu's items.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object representing the menu item
that fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMouseOut">_onMouseOut</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseOut</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"mouseout" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onMouseOver">_onMouseOver</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseOver</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"mouseover" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onParentMenuConfigChange">_onParentMenuConfigChange</a></h4>
<div class="detail">
<code>
private
void
<strong>_onParentMenuConfigChange</strong>
(
p_sType
,
p_aArgs
,
p_oSubmenu
)
</code>
<div class="description">
"configchange" event handler for a submenu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the submenu that
subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onParentMenuRender">_onParentMenuRender</a></h4>
<div class="detail">
<code>
private
void
<strong>_onParentMenuRender</strong>
(
p_sType
,
p_aArgs
,
p_oSubmenu
)
</code>
<div class="description">
"render" event handler for a submenu. Renders a
submenu in response to the firing of its parent's "render" event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the submenu that
subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onRender">_onRender</a></h4>
<div class="detail">
<code>
private
void
<strong>_onRender</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"render" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onShow">_onShow</a></h4>
<div class="detail">
<code>
private
void
<strong>_onShow</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
"show" event handler for the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that fired
the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onSubmenuBeforeShow">_onSubmenuBeforeShow</a></h4>
<div class="detail">
<code>
private
void
<strong>_onSubmenuBeforeShow</strong>
(
p_sType
,
p_aArgs
,
p_oSubmenu
)
</code>
<div class="description">
"beforeshow" event handler for a submenu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the submenu that
subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onSubmenuHide">_onSubmenuHide</a></h4>
<div class="detail">
<code>
private
void
<strong>_onSubmenuHide</strong>
(
p_sType
,
p_aArgs
,
p_oSubmenu
)
</code>
<div class="description">
"hide" Custom Event handler for a submenu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the submenu that
subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_onSubmenuShow">_onSubmenuShow</a></h4>
<div class="detail">
<code>
private
void
<strong>_onSubmenuShow</strong>
(
p_sType
,
p_aArgs
,
p_oSubmenu
)
</code>
<div class="description">
"show" event handler for a submenu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the submenu that
subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_removeItemFromGroupByIndex">_removeItemFromGroupByIndex</a></h4>
<div class="detail">
<code>
private
YAHOO.widget.MenuItem
<strong>_removeItemFromGroupByIndex</strong>
(
p_nGroupIndex
,
p_nItemIndex
)
</code>
<div class="description">
Removes a menu item from a group by index. Returns the menu
item that was removed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Number indicating the group to which the menu
item belongs.
</dd>
<dd>
<code>p_nItemIndex &lt;Number&gt;</code>
Number indicating the index of the menu item
to be removed.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_removeItemFromGroupByValue">_removeItemFromGroupByValue</a></h4>
<div class="detail">
<code>
private
YAHOO.widget.MenuItem
<strong>_removeItemFromGroupByValue</strong>
(
p_nGroupIndex
,
p_oItem
)
</code>
<div class="description">
Removes a menu item from a group by reference. Returns the
menu item that was removed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Number indicating the group to which the
menu item belongs.
</dd>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance to be removed.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_subscribeToItemEvents">_subscribeToItemEvents</a></h4>
<div class="detail">
<code>
private
void
<strong>_subscribeToItemEvents</strong>
(
p_oItem
)
</code>
<div class="description">
Subscribes a menu to a menu item's event.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance whose events should be subscribed to.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="_updateItemProperties">_updateItemProperties</a></h4>
<div class="detail">
<code>
private
void
<strong>_updateItemProperties</strong>
(
p_nGroupIndex
)
</code>
<div class="description">
Updates the "index," "groupindex," and "className" properties
of the menu items in the specified group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Number indicating the group of items to update.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="addItem">addItem</a></h4>
<div class="detail">
<code>
YAHOO.widget.MenuItem
<strong>addItem</strong>
(
p_oItem
,
p_nGroupIndex
)
</code>
<div class="description">
Appends an item to the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance to be added to the menu.
</dd>
<dd>
<code>p_oItem &lt;String&gt;</code>
String specifying the text of the item to be added
to the menu.
</dd>
<dd>
<code>p_oItem &lt;Object&gt;</code>
Object literal containing a set of menu item
configuration properties.
</dd>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Optional. Number indicating the group to
which the item belongs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="addItems">addItems</a></h4>
<div class="detail">
<code>
Array
<strong>addItems</strong>
(
p_aItems
,
p_nGroupIndex
)
</code>
<div class="description">
Adds an array of items to the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_aItems &lt;Array&gt;</code>
Array of items to be added to the menu. The array
can contain strings specifying the text for each item to be created, object
literals specifying each of the menu item configuration properties,
or MenuItem instances.
</dd>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Optional. Number specifying the group to
which the items belongs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="clearActiveItem">clearActiveItem</a></h4>
<div class="detail">
<code>
void
<strong>clearActiveItem</strong>
(
p_bBlur
)
</code>
<div class="description">
Sets the "selected" configuration property of the menu's active
item to "false" and hides the item's submenu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_bBlur &lt;Boolean&gt;</code>
Boolean indicating if the menu's active item
should be blurred.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="configContainer">configContainer</a></h4>
<div class="detail">
<code>
void
<strong>configContainer</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
Event handler for when the "container" configuration property
of the menu changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="configHideDelay">configHideDelay</a></h4>
<div class="detail">
<code>
void
<strong>configHideDelay</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
Event handler for when the "hidedelay" configuration property
of the menu changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="configIframe">configIframe</a></h4>
<div class="detail">
<code>
void
<strong>configIframe</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
Event handler for when the "iframe" configuration property of
the menu changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="configPosition">configPosition</a></h4>
<div class="detail">
<code>
void
<strong>configPosition</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
Event handler for when the "position" configuration property
of the menu changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="configVisible">configVisible</a></h4>
<div class="detail">
<code>
void
<strong>configVisible</strong>
(
p_sType
,
p_aArgs
,
p_oMenu
)
</code>
<div class="description">
Event handler for when the "visible" configuration property
the menu changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event that
was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event was fired.
</dd>
<dd>
<code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
Object representing the menu that
fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="destroy">destroy</a></h4>
<div class="detail">
<code>
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
Removes the menu's <code>&#60;div&#62;</code> element
(and accompanying child nodes) from the document.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="disableAutoSubmenuDisplay">disableAutoSubmenuDisplay</a></h4>
<div class="detail">
<code>
private
void
<strong>disableAutoSubmenuDisplay</strong>
(
p_oEvent
)
</code>
<div class="description">
"click" event handler for the document
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oEvent &lt;Event&gt;</code>
Object reference for the DOM event object
passed back by the event utility (YAHOO.util.Event).
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="enforceConstraints">enforceConstraints</a></h4>
<div class="detail">
<code>
void
<strong>enforceConstraints</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler executed when the moveEvent is fired,
if the "constraintoviewport" configuration property is set to true.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The name of the event that was fired.
</dd>
<dd>
<code>args &lt;Array&gt;</code>
Collection of arguments sent when the
event was fired.
</dd>
<dd>
<code>obj &lt;Array&gt;</code>
Array containing the current Menu instance
and the item that fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getItem">getItem</a></h4>
<div class="detail">
<code>
YAHOO.widget.MenuItem
<strong>getItem</strong>
(
p_nItemIndex
,
p_nGroupIndex
)
</code>
<div class="description">
Returns the item at the specified index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nItemIndex &lt;Number&gt;</code>
Number indicating the ordinal position of the
item to be retrieved.
</dd>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Optional. Number indicating the group to which
the item belongs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getItemGroups">getItemGroups</a></h4>
<div class="detail">
<code>
Array
<strong>getItemGroups</strong>
(
)
</code>
<div class="description">
Returns a multi-dimensional array of all of the items in the menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="getRoot">getRoot</a></h4>
<div class="detail">
<code>
void
<strong>getRoot</strong>
(
)
</code>
<div class="description">
Finds the menu's root menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
p_oElement
,
p_oConfig
)
</code>
<div class="description">
The Menu class's initialization method. This method is
automatically called by the constructor, and sets up all DOM references
for pre-existing markup, and creates required markup if it is not
already present.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oElement &lt;String&gt;</code>
String specifying the id attribute of the
<code>&#60;div&#62;</code> element of the menu.
</dd>
<dd>
<code>p_oElement &lt;String&gt;</code>
String specifying the id attribute of the
<code>&#60;select&#62;</code> element to be used as the data source
for the menu.
</dd>
<dd>
<code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a>&gt;</code>
Object
specifying the <code>&#60;div&#62;</code> element of the menu.
</dd>
<dd>
<code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>&gt;</code>
Object specifying the <code>&#60;select&#62;</code> element to be used as
the data source for the menu.
</dd>
<dd>
<code>p_oConfig &lt;Object&gt;</code>
Optional. Object literal specifying the
configuration for the menu. See configuration class documentation for
more details.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="initDefaultConfig">initDefaultConfig</a></h4>
<div class="detail">
<code>
void
<strong>initDefaultConfig</strong>
(
)
</code>
<div class="description">
Initializes the class's configurable properties which can be
changed using the menu's Config object ("cfg").
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="initEvents">initEvents</a></h4>
<div class="detail">
<code>
void
<strong>initEvents</strong>
(
)
</code>
<div class="description">
Initializes the custom events for the menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="insertItem">insertItem</a></h4>
<div class="detail">
<code>
YAHOO.widget.MenuItem
<strong>insertItem</strong>
(
p_oItem
,
p_nItemIndex
,
p_nGroupIndex
)
</code>
<div class="description">
Inserts an item into the menu at the specified index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance to be added to the menu.
</dd>
<dd>
<code>p_oItem &lt;String&gt;</code>
String specifying the text of the item to be added
to the menu.
</dd>
<dd>
<code>p_oItem &lt;Object&gt;</code>
Object literal containing a set of menu item
configuration properties.
</dd>
<dd>
<code>p_nItemIndex &lt;Number&gt;</code>
Number indicating the ordinal position at which
the item should be added.
</dd>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Optional. Number indicating the group to which
the item belongs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="onDomResize">onDomResize</a></h4>
<div class="detail">
<code>
void
<strong>onDomResize</strong>
(
)
</code>
<div class="description">
Event handler called when the resize monitor element's "resize" evet is fired.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="removeItem">removeItem</a></h4>
<div class="detail">
<code>
YAHOO.widget.MenuItem
<strong>removeItem</strong>
(
p_oObject
,
p_nGroupIndex
)
</code>
<div class="description">
Removes the specified item from the menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oObject &lt;YAHOO.widget.MenuItem&gt;</code>
Object reference for the MenuItem
instance to be removed from the menu.
</dd>
<dd>
<code>p_oObject &lt;Number&gt;</code>
Number specifying the index of the item
to be removed.
</dd>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Optional. Number specifying the group to
which the item belongs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.MenuItem
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="setInitialFocus">setInitialFocus</a></h4>
<div class="detail">
<code>
void
<strong>setInitialFocus</strong>
(
)
</code>
<div class="description">
Sets focus to the menu's first enabled item.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="setInitialSelection">setInitialSelection</a></h4>
<div class="detail">
<code>
void
<strong>setInitialSelection</strong>
(
)
</code>
<div class="description">
Sets the "selected" configuration property of the menu's first
enabled item to "true."
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="setItemGroupTitle">setItemGroupTitle</a></h4>
<div class="detail">
<code>
void
<strong>setItemGroupTitle</strong>
(
p_sGroupTitle
,
p_nGroupIndex
)
</code>
<div class="description">
Sets the title of a group of menu items.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sGroupTitle &lt;String&gt;</code>
String specifying the title of the group.
</dd>
<dd>
<code>p_nGroupIndex &lt;Number&gt;</code>
Optional. Number specifying the group to which
the title belongs.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
<h4>
<a name="toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representing the menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Module.html#appendToBody">appendToBody</a>,
<a href="YAHOO.widget.Module.html#appendToFooter">appendToFooter</a>,
<a href="YAHOO.widget.Module.html#appendToHeader">appendToHeader</a>,
<a href="YAHOO.widget.Module.html#configMonitorResize">configMonitorResize</a>,
<a href="YAHOO.widget.Module.html#configVisible">configVisible</a>,
<a href="YAHOO.widget.Module.html#destroy">destroy</a>,
<a href="YAHOO.widget.Module.html#hide">hide</a>,
<a href="YAHOO.widget.Module.html#init">init</a>,
<a href="YAHOO.widget.Module.html#initDefaultConfig">initDefaultConfig</a>,
<a href="YAHOO.widget.Module.html#initEvents">initEvents</a>,
<a href="YAHOO.widget.Module.html#initResizeMonitor">initResizeMonitor</a>,
<a href="YAHOO.widget.Module.html#onDomResize">onDomResize</a>,
<a href="YAHOO.widget.Module.html#render">render</a>,
<a href="YAHOO.widget.Module.html#setBody">setBody</a>,
<a href="YAHOO.widget.Module.html#setFooter">setFooter</a>,
<a href="YAHOO.widget.Module.html#setHeader">setHeader</a>,
<a href="YAHOO.widget.Module.html#show">show</a>,
<a href="YAHOO.widget.Module.html#toString">toString</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Overlay.html#align">align</a>,
<a href="YAHOO.widget.Overlay.html#center">center</a>,
<a href="YAHOO.widget.Overlay.html#configConstrainToViewport">configConstrainToViewport</a>,
<a href="YAHOO.widget.Overlay.html#configContext">configContext</a>,
<a href="YAHOO.widget.Overlay.html#configFixedCenter">configFixedCenter</a>,
<a href="YAHOO.widget.Overlay.html#configHeight">configHeight</a>,
<a href="YAHOO.widget.Overlay.html#configIframe">configIframe</a>,
<a href="YAHOO.widget.Overlay.html#configVisible">configVisible</a>,
<a href="YAHOO.widget.Overlay.html#configWidth">configWidth</a>,
<a href="YAHOO.widget.Overlay.html#configX">configX</a>,
<a href="YAHOO.widget.Overlay.html#configXY">configXY</a>,
<a href="YAHOO.widget.Overlay.html#configY">configY</a>,
<a href="YAHOO.widget.Overlay.html#configzIndex">configzIndex</a>,
<a href="YAHOO.widget.Overlay.html#destroy">destroy</a>,
<a href="YAHOO.widget.Overlay.html#doCenterOnDOMEvent">doCenterOnDOMEvent</a>,
<a href="YAHOO.widget.Overlay.html#enforceConstraints">enforceConstraints</a>,
<a href="YAHOO.widget.Overlay.html#hideIframe">hideIframe</a>,
<a href="YAHOO.widget.Overlay.html#hideMacGeckoScrollbars">hideMacGeckoScrollbars</a>,
<a href="YAHOO.widget.Overlay.html#init">init</a>,
<a href="YAHOO.widget.Overlay.html#initDefaultConfig">initDefaultConfig</a>,
<a href="YAHOO.widget.Overlay.html#initEvents">initEvents</a>,
<a href="YAHOO.widget.Overlay.html#moveTo">moveTo</a>,
<a href="YAHOO.widget.Overlay.html#onDomResize">onDomResize</a>,
<a href="YAHOO.widget.Overlay.html#showIframe">showIframe</a>,
<a href="YAHOO.widget.Overlay.html#showMacGeckoScrollbars">showMacGeckoScrollbars</a>,
<a href="YAHOO.widget.Overlay.html#syncPosition">syncPosition</a>,
<a href="YAHOO.widget.Overlay.html#toString">toString</a>
</code>
</div>
</div>
<div class="section method details">
<h3><a name="methodDetails">Events</a></h3>
<div class="content">
<h4>
<a name="clickEvent">clickEvent</a></h4>
<div class="detail">
<code>
<strong>clickEvent</strong>
(
)
</code>
<div class="description">
Fires when the user clicks the on the menu. Passes back the
DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="itemAddedEvent">itemAddedEvent</a></h4>
<div class="detail">
<code>
<strong>itemAddedEvent</strong>
(
)
</code>
<div class="description">
Fires when an item is added to the menu.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="itemRemovedEvent">itemRemovedEvent</a></h4>
<div class="detail">
<code>
<strong>itemRemovedEvent</strong>
(
)
</code>
<div class="description">
Fires when an item is removed to the menu.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="keyDownEvent">keyDownEvent</a></h4>
<div class="detail">
<code>
<strong>keyDownEvent</strong>
(
)
</code>
<div class="description">
Fires when the user presses a key when one of the menu's items
has focus. Passes back the DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="keyPressEvent">keyPressEvent</a></h4>
<div class="detail">
<code>
<strong>keyPressEvent</strong>
(
)
</code>
<div class="description">
Fires when the user presses an alphanumeric key when one of the
menu's items has focus. Passes back the DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="keyUpEvent">keyUpEvent</a></h4>
<div class="detail">
<code>
<strong>keyUpEvent</strong>
(
)
</code>
<div class="description">
Fires when the user releases a key when one of the menu's items
has focus. Passes back the DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="mouseDownEvent">mouseDownEvent</a></h4>
<div class="detail">
<code>
<strong>mouseDownEvent</strong>
(
)
</code>
<div class="description">
Fires when the user mouses down on the menu. Passes back the
DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="mouseOutEvent">mouseOutEvent</a></h4>
<div class="detail">
<code>
<strong>mouseOutEvent</strong>
(
)
</code>
<div class="description">
Fires when the mouse has left the menu. Passes back the DOM
Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="mouseOverEvent">mouseOverEvent</a></h4>
<div class="detail">
<code>
<strong>mouseOverEvent</strong>
(
)
</code>
<div class="description">
Fires when the mouse has entered the menu. Passes back
the DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
<h4>
<a name="mouseUpEvent">mouseUpEvent</a></h4>
<div class="detail">
<code>
<strong>mouseUpEvent</strong>
(
)
</code>
<div class="description">
Fires when the user releases a mouse button while the mouse is
over the menu. Passes back the DOM Event object as an argument.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Module.html#appendEvent">appendEvent</a>,
<a href="YAHOO.widget.Module.html#beforeHideEvent">beforeHideEvent</a>,
<a href="YAHOO.widget.Module.html#beforeInitEvent">beforeInitEvent</a>,
<a href="YAHOO.widget.Module.html#beforeRenderEvent">beforeRenderEvent</a>,
<a href="YAHOO.widget.Module.html#beforeShowEvent">beforeShowEvent</a>,
<a href="YAHOO.widget.Module.html#changeBodyEvent">changeBodyEvent</a>,
<a href="YAHOO.widget.Module.html#changeContentEvent">changeContentEvent</a>,
<a href="YAHOO.widget.Module.html#changeFooterEvent">changeFooterEvent</a>,
<a href="YAHOO.widget.Module.html#changeHeaderEvent">changeHeaderEvent</a>,
<a href="YAHOO.widget.Module.html#destroyEvent">destroyEvent</a>,
<a href="YAHOO.widget.Module.html#hideEvent">hideEvent</a>,
<a href="YAHOO.widget.Module.html#initEvent">initEvent</a>,
<a href="YAHOO.widget.Module.html#renderEvent">renderEvent</a>,
<a href="YAHOO.widget.Module.html#showEvent">showEvent</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Overlay.html#beforeMoveEvent">beforeMoveEvent</a>,
<a href="YAHOO.widget.Overlay.html#moveEvent">moveEvent</a>,
<a href="YAHOO.widget.Overlay.html#YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent</a>,
<a href="YAHOO.widget.Overlay.html#YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent</a>
</code>
</div>
</div>
<div class="section field details">
<h3><a name="field_detail">Configuration Attributes</a></h3>
<div class="content">
<h4><a name="autosubmenudisplay">autosubmenudisplay</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if submenus are automatically made
visible when the user mouses over the menu's items.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
<h4><a name="clicktohide">clicktohide</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the menu will automatically be
hidden if the user clicks outside of it.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
<h4><a name="constraintoviewport">constraintoviewport</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the menu will try to remain inside
the boundaries of the size of viewport.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
<h4><a name="container">container</a>
<code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-58190037">HTMLElement</a>|String</code>
</h4>
<div class="detail">
<div class="description">
HTML element reference or string specifying the id
attribute of the HTML element that the menu's markup should be rendered into.
</div>
</div>
<div class="default">
Default Value: document.body
</div>
<hr />
<h4><a name="hidedelay">hidedelay</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Number indicating the time (in milliseconds) that should
expire before the menu is hidden.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
<h4><a name="position">position</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String indicating how a menu should be positioned on the
screen. Possible values are "static" and "dynamic." Static menus are
visible by default and reside in the normal flow of the document
(CSS position: static). Dynamic menus are hidden by default, reside
out of the normal flow of the document (CSS position: absolute), and
can overlay other elements on the screen.
</div>
</div>
<div class="default">
Default Value: dynamic
</div>
<hr />
<h4><a name="showdelay">showdelay</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Number indicating the time (in milliseconds) that should
expire before a submenu is made visible when the user mouses over
the menu's items.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
<h4><a name="submenualignment">submenualignment</a>
<code>- Array</code>
</h4>
<div class="detail">
<div class="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.
</div>
</div>
<div class="default">
Default Value: ["tl","tr"]
</div>
<hr />
<h4><a name="visible">visible</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating whether or not the menu is visible. If
the menu's "position" configuration property is set to "dynamic" (the
default), this property toggles the menu's <code>&#60;div&#62;</code>
element's "visibility" style property between "visible" (true) or
"hidden" (false). If the menu's "position" configuration property is
set to "static" this property toggles the menu's
<code>&#60;div&#62;</code> element's "display" style property
between "block" (true) or "none" (false).
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Module.html#effect">effect</a>,
<a href="YAHOO.widget.Module.html#monitorresize">monitorresize</a>,
<a href="YAHOO.widget.Module.html#visible">visible</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a href="YAHOO.widget.Overlay.html#constraintoviewport">constraintoviewport</a>,
<a href="YAHOO.widget.Overlay.html#context">context</a>,
<a href="YAHOO.widget.Overlay.html#fixedcenter">fixedcenter</a>,
<a href="YAHOO.widget.Overlay.html#height">height</a>,
<a href="YAHOO.widget.Overlay.html#iframe">iframe</a>,
<a href="YAHOO.widget.Overlay.html#width">width</a>,
<a href="YAHOO.widget.Overlay.html#x">x</a>,
<a href="YAHOO.widget.Overlay.html#xy">xy</a>,
<a href="YAHOO.widget.Overlay.html#y">y</a>,
<a href="YAHOO.widget.Overlay.html#zIndex">zIndex</a>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li><a href="module_animation.html">animation</a></li>
<li><a href="module_autocomplete.html">autocomplete</a></li>
<li><a href="module_calendar.html">calendar</a></li>
<li><a href="module_connection.html">connection</a></li>
<li><a href="module_container.html">container</a></li>
<li><a href="module_dom.html">dom</a></li>
<li><a href="module_dragdrop.html">dragdrop</a></li>
<li><a href="module_event.html">event</a></li>
<li><a href="module_logger.html">logger</a></li>
<li><a href="module_menu.html">menu</a></li>
<li><a href="module_slider.html">slider</a></li>
<li><a href="module_tabview.html">tabview</a></li>
<li><a href="module_treeview.html">treeview</a></li>
<li><a href="module_yahoo.html">yahoo</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li><a href="YAHOO.widget.ContextMenu.html">YAHOO.widget.ContextMenu</a></li>
<li><a href="YAHOO.widget.ContextMenuItem.html">YAHOO.widget.ContextMenuItem</a></li>
<li><a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></li>
<li><a href="YAHOO.widget.Menubar.html">YAHOO.widget.Menubar</a></li>
<li><a href="YAHOO.widget.MenuBarItem.html">YAHOO.widget.MenuBarItem</a></li>
<li><a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></li>
<li><a href="YAHOO.widget.MenuManager.html">YAHOO.widget.MenuManager</a></li>
<li><a href="YAHOO.widget.MenuModule.html">YAHOO.widget.MenuModule</a></li>
<li><a href="YAHOO.widget.MenuModuleItem.html">YAHOO.widget.MenuModuleItem</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li><a href="contextmenu.js.html">contextmenu.js</a></li>
<li><a href="contextmenuitem.js.html">contextmenuitem.js</a></li>
<li><a href="menu.js.html">menu.js</a></li>
<li><a href="menubar.js.html">menubar.js</a></li>
<li><a href="menubaritem.js.html">menubaritem.js</a></li>
<li><a href="menuitem.js.html">menuitem.js</a></li>
<li><a href="menumanager.js.html">menumanager.js</a></li>
<li><a href="menumodule.js.html">menumodule.js</a></li>
<li><a href="menumoduleitem.js.html">menumoduleitem.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li><a href="#_aGroupTitleElements">_aGroupTitleElements</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_aItemGroups">_aItemGroups</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_aListElements">_aListElements</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_bHandledMouseOutEvent">_bHandledMouseOutEvent</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_bHandledMouseOverEvent">_bHandledMouseOverEvent</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_hideDelayEventHandlersAssigned">_hideDelayEventHandlersAssigned</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_nHideDelayId">_nHideDelayId</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#_nShowDelayId">_nShowDelayId</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#activeItem">activeItem</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#CSS_CLASS_NAME">CSS_CLASS_NAME</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#getNextItemSibling">getNextItemSibling</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#GROUP_TITLE_TAG_NAME">GROUP_TITLE_TAG_NAME</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#ITEM_TYPE">ITEM_TYPE</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#itemData">itemData</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#lazyLoad">lazyLoad</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#parent">parent</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
<li><a href="#srcElement">srcElement</a>
<!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#_addItemToGroup">_addItemToGroup</a>
</li>
<li><!--<code>void</code>-->
<a href="#_cancelHideDelay">_cancelHideDelay</a>
</li>
<li><!--<code>void</code>-->
<a href="#_cancelShowDelay">_cancelShowDelay</a>
</li>
<li><!--<code>Boolean</code>-->
<a href="#_checkPosition">_checkPosition</a>
</li>
<li><!--<code>void</code>-->
<a href="#_configureSubmenu">_configureSubmenu</a>
</li>
<li><!--<code>Array</code>-->
<a href="#_createItemGroup">_createItemGroup</a>
</li>
<li><!--<code>void</code>-->
<a href="#_execHideDelay">_execHideDelay</a>
</li>
<li><!--<code>void</code>-->
<a href="#_execShowDelay">_execShowDelay</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#_getFirstEnabledItem">_getFirstEnabledItem</a>
</li>
<li><!--<code>Array</code>-->
<a href="#_getItemGroup">_getItemGroup</a>
</li>
<li><!--<code>void</code>-->
<a href="#_getOffsetWidth">_getOffsetWidth</a>
</li>
<li><!--<code>void</code>-->
<a href="#_initSubTree">_initSubTree</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onBeforeHide">_onBeforeHide</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onBeforeRender">_onBeforeRender</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onBeforeShow">_onBeforeShow</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onClick">_onClick</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onInit">_onInit</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onKeyDown">_onKeyDown</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMenuItemBlur">_onMenuItemBlur</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMenuItemConfigChange">_onMenuItemConfigChange</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMenuItemFocus">_onMenuItemFocus</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMouseOut">_onMouseOut</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onMouseOver">_onMouseOver</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onParentMenuConfigChange">_onParentMenuConfigChange</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onParentMenuRender">_onParentMenuRender</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onRender">_onRender</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onShow">_onShow</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onSubmenuBeforeShow">_onSubmenuBeforeShow</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onSubmenuHide">_onSubmenuHide</a>
</li>
<li><!--<code>void</code>-->
<a href="#_onSubmenuShow">_onSubmenuShow</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#_removeItemFromGroupByIndex">_removeItemFromGroupByIndex</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#_removeItemFromGroupByValue">_removeItemFromGroupByValue</a>
</li>
<li><!--<code>void</code>-->
<a href="#_subscribeToItemEvents">_subscribeToItemEvents</a>
</li>
<li><!--<code>void</code>-->
<a href="#_updateItemProperties">_updateItemProperties</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#addItem">addItem</a>
</li>
<li><!--<code>Array</code>-->
<a href="#addItems">addItems</a>
</li>
<li><!--<code>void</code>-->
<a href="#clearActiveItem">clearActiveItem</a>
</li>
<li><!--<code>void</code>-->
<a href="#configContainer">configContainer</a>
</li>
<li><!--<code>void</code>-->
<a href="#configHideDelay">configHideDelay</a>
</li>
<li><!--<code>void</code>-->
<a href="#configIframe">configIframe</a>
</li>
<li><!--<code>void</code>-->
<a href="#configPosition">configPosition</a>
</li>
<li><!--<code>void</code>-->
<a href="#configVisible">configVisible</a>
</li>
<li><!--<code>void</code>-->
<a href="#destroy">destroy</a>
</li>
<li><!--<code>void</code>-->
<a href="#disableAutoSubmenuDisplay">disableAutoSubmenuDisplay</a>
</li>
<li><!--<code>void</code>-->
<a href="#enforceConstraints">enforceConstraints</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#getItem">getItem</a>
</li>
<li><!--<code>Array</code>-->
<a href="#getItemGroups">getItemGroups</a>
</li>
<li><!--<code>void</code>-->
<a href="#getRoot">getRoot</a>
</li>
<li><!--<code>void</code>-->
<a href="#init">init</a>
</li>
<li><!--<code>void</code>-->
<a href="#initDefaultConfig">initDefaultConfig</a>
</li>
<li><!--<code>void</code>-->
<a href="#initEvents">initEvents</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#insertItem">insertItem</a>
</li>
<li><!--<code>void</code>-->
<a href="#onDomResize">onDomResize</a>
</li>
<li><!--<code>YAHOO.widget.MenuItem</code>-->
<a href="#removeItem">removeItem</a>
</li>
<li><!--<code>void</code>-->
<a href="#setInitialFocus">setInitialFocus</a>
</li>
<li><!--<code>void</code>-->
<a href="#setInitialSelection">setInitialSelection</a>
</li>
<li><!--<code>void</code>-->
<a href="#setItemGroupTitle">setItemGroupTitle</a>
</li>
<li><!--<code>String</code>-->
<a href="#toString">toString</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li>
<a href="#clickEvent">clickEvent</a>
</li>
<li>
<a href="#itemAddedEvent">itemAddedEvent</a>
</li>
<li>
<a href="#itemRemovedEvent">itemRemovedEvent</a>
</li>
<li>
<a href="#keyDownEvent">keyDownEvent</a>
</li>
<li>
<a href="#keyPressEvent">keyPressEvent</a>
</li>
<li>
<a href="#keyUpEvent">keyUpEvent</a>
</li>
<li>
<a href="#mouseDownEvent">mouseDownEvent</a>
</li>
<li>
<a href="#mouseOutEvent">mouseOutEvent</a>
</li>
<li>
<a href="#mouseOverEvent">mouseOverEvent</a>
</li>
<li>
<a href="#mouseUpEvent">mouseUpEvent</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li>
<a href="#autosubmenudisplay">autosubmenudisplay</a>
</li>
<li>
<a href="#clicktohide">clicktohide</a>
</li>
<li>
<a href="#constraintoviewport">constraintoviewport</a>
</li>
<li>
<a href="#container">container</a>
</li>
<li>
<a href="#hidedelay">hidedelay</a>
</li>
<li>
<a href="#position">position</a>
</li>
<li>
<a href="#showdelay">showdelay</a>
</li>
<li>
<a href="#submenualignment">submenualignment</a>
</li>
<li>
<a href="#visible">visible</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2006 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>