Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.widget.MenuBarItem.html
bloba2fd867f3a0403410c4bf51f1e903bd95e606a96
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: menu YAHOO.widget.MenuBarItem (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>Menu&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_menu.html">menu</a>
17 &gt; YAHOO.widget.MenuBarItem
19 </p>
20 </div>
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
27 <h2>
32 Class <b>YAHOO.widget.MenuBarItem</b>
33 <span class="extends">
34 - extends <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>
35 </span>
37 <span class="extends">
38 </span>
40 </code>
41 </h2>
42 <!-- class tree goes here -->
47 <div class="summary description">
48 Creates an item for a menu bar.
49 </div>
51 <div class="section constructor details">
52 <h3><a name="constructor_detail">Constructor</a></h3>
53 <div class="content">
54 <div class="detail">
55 <strong>YAHOO.widget.MenuBarItem</strong>
56 <code>
61 p_oObject
67 p_oConfig
69 </code>
70 <div class="description">
71 <dl>
72 <dt>Parameters:</dt>
73 <dd>
74 <code>p_oObject
75 &lt;String&gt;
76 </code>
77 String specifying the text of the menu bar item.
78 </dd>
79 <dd>
80 <code>p_oObject
81 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
82 one-html.html#ID-74680021">HTMLLIElement</a>&gt;
83 </code>
84 Object specifying the
85 <code>&#60;li&#62;</code> element of the menu bar item.
86 </dd>
87 <dd>
88 <code>p_oObject
89 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
90 one-html.html#ID-38450247">HTMLOptGroupElement</a>&gt;
91 </code>
92 Object
93 specifying the <code>&#60;optgroup&#62;</code> element of the menu bar item.
94 </dd>
95 <dd>
96 <code>p_oObject
97 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
98 one-html.html#ID-70901257">HTMLOptionElement</a>&gt;
99 </code>
100 Object specifying
101 the <code>&#60;option&#62;</code> element of the menu bar item.
102 </dd>
103 <dd>
104 <code>p_oConfig
105 &lt;Object&gt;
106 </code>
107 Optional. Object literal specifying the
108 configuration for the menu bar item. See configuration class documentation
109 for more details.
110 </dd>
111 </dl>
114 </div>
115 </div>
116 </div>
117 </div>
119 <div class="section field details">
120 <h3><a name="field_detail">Properties</a></h3>
121 <div class="content">
122 <h4><a name="CSS_CLASS_NAME">CSS_CLASS_NAME</a>
123 <code>- final String</code>
124 </h4>
125 <div class="detail">
126 <div class="description">
127 String representing the CSS class(es) to be applied to the
128 <code>&#60;li&#62;</code> element of the menu bar item.
129 </div>
130 </div>
133 <div class="default">
134 Default Value: "yuimenubaritem"
135 </div>
138 <hr />
141 </div>
142 </div>
144 <div class="section field inheritance">
145 <h4>Properties inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
146 <div class="content">
147 <code>
149 <a href="YAHOO.widget.MenuItem.html#_checkImage">_checkImage</a>,
150 <a href="YAHOO.widget.MenuItem.html#_oAnchor">_oAnchor</a>,
151 <a href="YAHOO.widget.MenuItem.html#_oCheckedIndicator">_oCheckedIndicator</a>,
152 <a href="YAHOO.widget.MenuItem.html#_oHelpTextEM">_oHelpTextEM</a>,
153 <a href="YAHOO.widget.MenuItem.html#_oOnclickAttributeValue">_oOnclickAttributeValue</a>,
154 <a href="YAHOO.widget.MenuItem.html#_oSubmenu">_oSubmenu</a>,
155 <a href="YAHOO.widget.MenuItem.html#_oText">_oText</a>,
156 <a href="YAHOO.widget.MenuItem.html#_sClassName">_sClassName</a>,
157 <a href="YAHOO.widget.MenuItem.html#browser">browser</a>,
158 <a href="YAHOO.widget.MenuItem.html#CHECKED_IMAGE_ALT_TEXT">CHECKED_IMAGE_ALT_TEXT</a>,
159 <a href="YAHOO.widget.MenuItem.html#CHECKED_IMAGE_PATH">CHECKED_IMAGE_PATH</a>,
160 <a href="YAHOO.widget.MenuItem.html#CHECKED_TEXT">CHECKED_TEXT</a>,
161 <a href="YAHOO.widget.MenuItem.html#COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT">COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT</a>,
162 <a href="YAHOO.widget.MenuItem.html#COLLAPSED_SUBMENU_INDICATOR_TEXT">COLLAPSED_SUBMENU_INDICATOR_TEXT</a>,
163 <a href="YAHOO.widget.MenuItem.html#constructor">constructor</a>,
164 <a href="YAHOO.widget.MenuItem.html#CSS_CLASS_NAME">CSS_CLASS_NAME</a>,
165 <a href="YAHOO.widget.MenuItem.html#DISABLED_CHECKED_IMAGE_ALT_TEXT">DISABLED_CHECKED_IMAGE_ALT_TEXT</a>,
166 <a href="YAHOO.widget.MenuItem.html#DISABLED_CHECKED_IMAGE_PATH">DISABLED_CHECKED_IMAGE_PATH</a>,
167 <a href="YAHOO.widget.MenuItem.html#DISABLED_CHECKED_TEXT">DISABLED_CHECKED_TEXT</a>,
168 <a href="YAHOO.widget.MenuItem.html#DISABLED_SUBMENU_INDICATOR_ALT_TEXT">DISABLED_SUBMENU_INDICATOR_ALT_TEXT</a>,
169 <a href="YAHOO.widget.MenuItem.html#DISABLED_SUBMENU_INDICATOR_IMAGE_PATH">DISABLED_SUBMENU_INDICATOR_IMAGE_PATH</a>,
170 <a href="YAHOO.widget.MenuItem.html#DISABLED_SUBMENU_INDICATOR_TEXT">DISABLED_SUBMENU_INDICATOR_TEXT</a>,
171 <a href="YAHOO.widget.MenuItem.html#element">element</a>,
172 <a href="YAHOO.widget.MenuItem.html#EXPANDED_SUBMENU_INDICATOR_ALT_TEXT">EXPANDED_SUBMENU_INDICATOR_ALT_TEXT</a>,
173 <a href="YAHOO.widget.MenuItem.html#EXPANDED_SUBMENU_INDICATOR_TEXT">EXPANDED_SUBMENU_INDICATOR_TEXT</a>,
174 <a href="YAHOO.widget.MenuItem.html#groupIndex">groupIndex</a>,
175 <a href="YAHOO.widget.MenuItem.html#id">id</a>,
176 <a href="YAHOO.widget.MenuItem.html#imageRoot">imageRoot</a>,
177 <a href="YAHOO.widget.MenuItem.html#IMG_ROOT">IMG_ROOT</a>,
178 <a href="YAHOO.widget.MenuItem.html#IMG_ROOT_SSL">IMG_ROOT_SSL</a>,
179 <a href="YAHOO.widget.MenuItem.html#index">index</a>,
180 <a href="YAHOO.widget.MenuItem.html#isSecure">isSecure</a>,
181 <a href="YAHOO.widget.MenuItem.html#parent">parent</a>,
182 <a href="YAHOO.widget.MenuItem.html#SELECTED_CHECKED_IMAGE_PATH">SELECTED_CHECKED_IMAGE_PATH</a>,
183 <a href="YAHOO.widget.MenuItem.html#SELECTED_SUBMENU_INDICATOR_IMAGE_PATH">SELECTED_SUBMENU_INDICATOR_IMAGE_PATH</a>,
184 <a href="YAHOO.widget.MenuItem.html#srcElement">srcElement</a>,
185 <a href="YAHOO.widget.MenuItem.html#SUBMENU_INDICATOR_IMAGE_PATH">SUBMENU_INDICATOR_IMAGE_PATH</a>,
186 <a href="YAHOO.widget.MenuItem.html#SUBMENU_TYPE">SUBMENU_TYPE</a>,
187 <a href="YAHOO.widget.MenuItem.html#submenuIndicator">submenuIndicator</a>,
188 <a href="YAHOO.widget.MenuItem.html#value">value</a>
189 </code>
190 </div>
191 </div>
193 <div class="section method details">
194 <h3><a name="methodDetails">Methods</a></h3>
195 <div class="content">
196 <h4>
197 <a name="init">init</a></h4>
198 <div class="detail">
199 <code>
203 void
204 <strong>init</strong>
208 p_oObject
218 p_oConfig
222 </code>
224 <div class="description">
225 The MenuBarItem class's initialization method. This method is
226 automatically called by the constructor, and sets up all DOM references for
227 pre-existing markup, and creates required markup if it is not already present.
228 </div>
230 <div class="description">
232 <dl>
233 <dt>Parameters:</dt>
234 <dd>
235 <code>p_oObject &lt;String&gt;</code>
236 String specifying the text of the menu bar item.
237 </dd>
238 <dd>
239 <code>p_oObject &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
240 one-html.html#ID-74680021">HTMLLIElement</a>&gt;</code>
241 Object specifying the
242 <code>&#60;li&#62;</code> element of the menu bar item.
243 </dd>
244 <dd>
245 <code>p_oObject &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
246 one-html.html#ID-38450247">HTMLOptGroupElement</a>&gt;</code>
247 Object
248 specifying the <code>&#60;optgroup&#62;</code> element of the menu bar item.
249 </dd>
250 <dd>
251 <code>p_oObject &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
252 one-html.html#ID-70901257">HTMLOptionElement</a>&gt;</code>
253 Object specifying
254 the <code>&#60;option&#62;</code> element of the menu bar item.
255 </dd>
256 <dd>
257 <code>p_oConfig &lt;Object&gt;</code>
258 Optional. Object literal specifying the
259 configuration for the menu bar item. See configuration class documentation
260 for more details.
261 </dd>
262 </dl>
264 <dl>
265 <dt>Returns:
266 <code>
267 void
268 </code></dt>
269 <dd></dd>
270 </dl>
272 </div>
274 </div>
275 <hr />
276 <h4>
277 <a name="toString">toString</a></h4>
278 <div class="detail">
279 <code>
283 String
284 <strong>toString</strong>
287 </code>
289 <div class="description">
290 Returns a string representing the menu bar item.
291 </div>
293 <div class="description">
296 <dl>
297 <dt>Returns:
298 <code>
299 String
300 </code></dt>
301 <dd></dd>
302 </dl>
304 </div>
306 </div>
307 <hr />
308 </div>
309 </div>
311 <div class="section field inheritance">
312 <h4>Methods inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
313 <div class="content">
314 <code>
316 <a href="YAHOO.widget.MenuItem.html#_checkDOMNode">_checkDOMNode</a>,
317 <a href="YAHOO.widget.MenuItem.html#_checkString">_checkString</a>,
318 <a href="YAHOO.widget.MenuItem.html#_createRootNodeStructure">_createRootNodeStructure</a>,
319 <a href="YAHOO.widget.MenuItem.html#_getFirstElement">_getFirstElement</a>,
320 <a href="YAHOO.widget.MenuItem.html#_initSubTree">_initSubTree</a>,
321 <a href="YAHOO.widget.MenuItem.html#_preloadImage">_preloadImage</a>,
322 <a href="YAHOO.widget.MenuItem.html#blur">blur</a>,
323 <a href="YAHOO.widget.MenuItem.html#configChecked">configChecked</a>,
324 <a href="YAHOO.widget.MenuItem.html#configClassName">configClassName</a>,
325 <a href="YAHOO.widget.MenuItem.html#configDisabled">configDisabled</a>,
326 <a href="YAHOO.widget.MenuItem.html#configEmphasis">configEmphasis</a>,
327 <a href="YAHOO.widget.MenuItem.html#configHelpText">configHelpText</a>,
328 <a href="YAHOO.widget.MenuItem.html#configOnClick">configOnClick</a>,
329 <a href="YAHOO.widget.MenuItem.html#configSelected">configSelected</a>,
330 <a href="YAHOO.widget.MenuItem.html#configStrongEmphasis">configStrongEmphasis</a>,
331 <a href="YAHOO.widget.MenuItem.html#configSubmenu">configSubmenu</a>,
332 <a href="YAHOO.widget.MenuItem.html#configTarget">configTarget</a>,
333 <a href="YAHOO.widget.MenuItem.html#configText">configText</a>,
334 <a href="YAHOO.widget.MenuItem.html#configURL">configURL</a>,
335 <a href="YAHOO.widget.MenuItem.html#destroy">destroy</a>,
336 <a href="YAHOO.widget.MenuItem.html#focus">focus</a>,
337 <a href="YAHOO.widget.MenuItem.html#getNextEnabledSibling">getNextEnabledSibling</a>,
338 <a href="YAHOO.widget.MenuItem.html#getPreviousEnabledSibling">getPreviousEnabledSibling</a>,
339 <a href="YAHOO.widget.MenuItem.html#init">init</a>,
340 <a href="YAHOO.widget.MenuItem.html#initDefaultConfig">initDefaultConfig</a>,
341 <a href="YAHOO.widget.MenuItem.html#toString">toString</a>
342 </code>
343 </div>
344 </div>
348 <div class="section field inheritance">
349 <h4>Events inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
350 <div class="content">
351 <code>
353 <a href="YAHOO.widget.MenuItem.html#blurEvent">blurEvent</a>,
354 <a href="YAHOO.widget.MenuItem.html#clickEvent">clickEvent</a>,
355 <a href="YAHOO.widget.MenuItem.html#destroyEvent">destroyEvent</a>,
356 <a href="YAHOO.widget.MenuItem.html#focusEvent">focusEvent</a>,
357 <a href="YAHOO.widget.MenuItem.html#keyDownEvent">keyDownEvent</a>,
358 <a href="YAHOO.widget.MenuItem.html#keyPressEvent">keyPressEvent</a>,
359 <a href="YAHOO.widget.MenuItem.html#keyUpEvent">keyUpEvent</a>,
360 <a href="YAHOO.widget.MenuItem.html#mouseDownEvent">mouseDownEvent</a>,
361 <a href="YAHOO.widget.MenuItem.html#mouseOutEvent">mouseOutEvent</a>,
362 <a href="YAHOO.widget.MenuItem.html#mouseOverEvent">mouseOverEvent</a>,
363 <a href="YAHOO.widget.MenuItem.html#mouseUpEvent">mouseUpEvent</a>
364 </code>
365 </div>
366 </div>
369 <div class="section field inheritance">
370 <h4>Configuration attributes inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
371 <div class="content">
372 <code>
374 <a href="YAHOO.widget.MenuItem.html#checked">checked</a>,
375 <a href="YAHOO.widget.MenuItem.html#classname">classname</a>,
376 <a href="YAHOO.widget.MenuItem.html#disabled">disabled</a>,
377 <a href="YAHOO.widget.MenuItem.html#emphasis">emphasis</a>,
378 <a href="YAHOO.widget.MenuItem.html#helptext">helptext</a>,
379 <a href="YAHOO.widget.MenuItem.html#onclick">onclick</a>,
380 <a href="YAHOO.widget.MenuItem.html#selected">selected</a>,
381 <a href="YAHOO.widget.MenuItem.html#strongemphasis">strongemphasis</a>,
382 <a href="YAHOO.widget.MenuItem.html#submenu">submenu</a>,
383 <a href="YAHOO.widget.MenuItem.html#target">target</a>,
384 <a href="YAHOO.widget.MenuItem.html#text">text</a>,
385 <a href="YAHOO.widget.MenuItem.html#url">url</a>
386 </code>
387 </div>
388 </div>
390 </div>
391 </div>
392 <div class="yui-b">
393 <div class="nav">
395 <div class="module">
396 <h4>Modules</h4>
397 <ul class="content">
399 <li class=""><a href="module_animation.html">animation</a></li>
401 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
403 <li class=""><a href="module_button.html">button</a></li>
405 <li class=""><a href="module_calendar.html">calendar</a></li>
407 <li class=""><a href="module_connection.html">connection</a></li>
409 <li class=""><a href="module_container.html">container</a></li>
411 <li class=""><a href="module_datasource.html">datasource</a></li>
413 <li class=""><a href="module_datatable.html">datatable</a></li>
415 <li class=""><a href="module_dom.html">dom</a></li>
417 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
419 <li class=""><a href="module_element.html">element</a></li>
421 <li class=""><a href="module_event.html">event</a></li>
423 <li class=""><a href="module_history.html">history</a></li>
425 <li class=""><a href="module_logger.html">logger</a></li>
427 <li class="selected"><a href="module_menu.html">menu</a></li>
429 <li class=""><a href="module_slider.html">slider</a></li>
431 <li class=""><a href="module_tabview.html">tabview</a></li>
433 <li class=""><a href="module_treeview.html">treeview</a></li>
435 <li class=""><a href="module_yahoo.html">yahoo</a></li>
436 </ul>
437 </div>
439 <div class="module">
440 <h4>Classes</h4>
441 <ul class="content">
442 <li class=""><a href="YAHOO.widget.ContextMenu.html">YAHOO.widget.ContextMenu</a></li>
443 <li class=""><a href="YAHOO.widget.ContextMenuItem.html">YAHOO.widget.ContextMenuItem</a></li>
444 <li class=""><a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></li>
445 <li class=""><a href="YAHOO.widget.Menubar.html">YAHOO.widget.Menubar</a></li>
446 <li class="selected"><a href="YAHOO.widget.MenuBarItem.html">YAHOO.widget.MenuBarItem</a></li>
447 <li class=""><a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></li>
448 <li class=""><a href="YAHOO.widget.MenuManager.html">YAHOO.widget.MenuManager</a></li>
449 </ul>
450 </div>
452 <div class="module">
453 <h4>Files</h4>
454 <ul class="content">
455 <li class=""><a href="contextmenu.js.html">contextmenu.js</a></li>
456 <li class=""><a href="contextmenuitem.js.html">contextmenuitem.js</a></li>
457 <li class=""><a href="menu.js.html">menu.js</a></li>
458 <li class=""><a href="menubar.js.html">menubar.js</a></li>
459 <li class=""><a href="menubaritem.js.html">menubaritem.js</a></li>
460 <li class=""><a href="menuitem.js.html">menuitem.js</a></li>
461 <li class=""><a href="menumanager.js.html">menumanager.js</a></li>
462 </ul>
463 </div>
465 <div class="module">
466 <h4>Properties</h4>
467 <ul class="content">
468 <li><a href="#CSS_CLASS_NAME">CSS_CLASS_NAME</a>
469 <!--<code>&lt;String&gt;</code>-->
470 </li>
471 </ul>
472 </div>
474 <div class="module">
475 <h4>Methods</h4>
476 <ul class="content">
477 <li><!--<code>void</code>-->
478 <a href="#init">init</a>
479 </li>
480 <li><!--<code>String</code>-->
481 <a href="#toString">toString</a>
482 </li>
483 </ul>
484 </div>
488 </div>
489 </div>
490 </div>
491 <div id="ft">
492 <hr />
493 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
494 </div>
495 </div>
496 </body>
497 </html>