Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.widget.ContextMenuItem.html
blob222a5cad74f7ccf1ada3fd6fefb3ebf7fcf234f6
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.ContextMenuItem (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.ContextMenuItem
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.ContextMenuItem</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 context menu.
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.ContextMenuItem</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 context menu 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 context menu 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 context
94 menu item.
95 </dd>
96 <dd>
97 <code>p_oObject
98 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
99 one-html.html#ID-70901257">HTMLOptionElement</a>&gt;
100 </code>
101 Object specifying
102 the <code>&#60;option&#62;</code> element of the context menu item.
103 </dd>
104 <dd>
105 <code>p_oConfig
106 &lt;Object&gt;
107 </code>
108 Optional. Object literal specifying the
109 configuration for the context menu item. See configuration class
110 documentation for more details.
111 </dd>
112 </dl>
115 </div>
116 </div>
117 </div>
118 </div>
121 <div class="section field inheritance">
122 <h4>Properties inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
123 <div class="content">
124 <code>
126 <a href="YAHOO.widget.MenuItem.html#_checkImage">_checkImage</a>,
127 <a href="YAHOO.widget.MenuItem.html#_oAnchor">_oAnchor</a>,
128 <a href="YAHOO.widget.MenuItem.html#_oCheckedIndicator">_oCheckedIndicator</a>,
129 <a href="YAHOO.widget.MenuItem.html#_oHelpTextEM">_oHelpTextEM</a>,
130 <a href="YAHOO.widget.MenuItem.html#_oOnclickAttributeValue">_oOnclickAttributeValue</a>,
131 <a href="YAHOO.widget.MenuItem.html#_oSubmenu">_oSubmenu</a>,
132 <a href="YAHOO.widget.MenuItem.html#_oText">_oText</a>,
133 <a href="YAHOO.widget.MenuItem.html#_sClassName">_sClassName</a>,
134 <a href="YAHOO.widget.MenuItem.html#browser">browser</a>,
135 <a href="YAHOO.widget.MenuItem.html#CHECKED_IMAGE_ALT_TEXT">CHECKED_IMAGE_ALT_TEXT</a>,
136 <a href="YAHOO.widget.MenuItem.html#CHECKED_IMAGE_PATH">CHECKED_IMAGE_PATH</a>,
137 <a href="YAHOO.widget.MenuItem.html#CHECKED_TEXT">CHECKED_TEXT</a>,
138 <a href="YAHOO.widget.MenuItem.html#COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT">COLLAPSED_SUBMENU_INDICATOR_ALT_TEXT</a>,
139 <a href="YAHOO.widget.MenuItem.html#COLLAPSED_SUBMENU_INDICATOR_TEXT">COLLAPSED_SUBMENU_INDICATOR_TEXT</a>,
140 <a href="YAHOO.widget.MenuItem.html#constructor">constructor</a>,
141 <a href="YAHOO.widget.MenuItem.html#CSS_CLASS_NAME">CSS_CLASS_NAME</a>,
142 <a href="YAHOO.widget.MenuItem.html#DISABLED_CHECKED_IMAGE_ALT_TEXT">DISABLED_CHECKED_IMAGE_ALT_TEXT</a>,
143 <a href="YAHOO.widget.MenuItem.html#DISABLED_CHECKED_IMAGE_PATH">DISABLED_CHECKED_IMAGE_PATH</a>,
144 <a href="YAHOO.widget.MenuItem.html#DISABLED_CHECKED_TEXT">DISABLED_CHECKED_TEXT</a>,
145 <a href="YAHOO.widget.MenuItem.html#DISABLED_SUBMENU_INDICATOR_ALT_TEXT">DISABLED_SUBMENU_INDICATOR_ALT_TEXT</a>,
146 <a href="YAHOO.widget.MenuItem.html#DISABLED_SUBMENU_INDICATOR_IMAGE_PATH">DISABLED_SUBMENU_INDICATOR_IMAGE_PATH</a>,
147 <a href="YAHOO.widget.MenuItem.html#DISABLED_SUBMENU_INDICATOR_TEXT">DISABLED_SUBMENU_INDICATOR_TEXT</a>,
148 <a href="YAHOO.widget.MenuItem.html#element">element</a>,
149 <a href="YAHOO.widget.MenuItem.html#EXPANDED_SUBMENU_INDICATOR_ALT_TEXT">EXPANDED_SUBMENU_INDICATOR_ALT_TEXT</a>,
150 <a href="YAHOO.widget.MenuItem.html#EXPANDED_SUBMENU_INDICATOR_TEXT">EXPANDED_SUBMENU_INDICATOR_TEXT</a>,
151 <a href="YAHOO.widget.MenuItem.html#groupIndex">groupIndex</a>,
152 <a href="YAHOO.widget.MenuItem.html#id">id</a>,
153 <a href="YAHOO.widget.MenuItem.html#imageRoot">imageRoot</a>,
154 <a href="YAHOO.widget.MenuItem.html#IMG_ROOT">IMG_ROOT</a>,
155 <a href="YAHOO.widget.MenuItem.html#IMG_ROOT_SSL">IMG_ROOT_SSL</a>,
156 <a href="YAHOO.widget.MenuItem.html#index">index</a>,
157 <a href="YAHOO.widget.MenuItem.html#isSecure">isSecure</a>,
158 <a href="YAHOO.widget.MenuItem.html#parent">parent</a>,
159 <a href="YAHOO.widget.MenuItem.html#SELECTED_CHECKED_IMAGE_PATH">SELECTED_CHECKED_IMAGE_PATH</a>,
160 <a href="YAHOO.widget.MenuItem.html#SELECTED_SUBMENU_INDICATOR_IMAGE_PATH">SELECTED_SUBMENU_INDICATOR_IMAGE_PATH</a>,
161 <a href="YAHOO.widget.MenuItem.html#srcElement">srcElement</a>,
162 <a href="YAHOO.widget.MenuItem.html#SUBMENU_INDICATOR_IMAGE_PATH">SUBMENU_INDICATOR_IMAGE_PATH</a>,
163 <a href="YAHOO.widget.MenuItem.html#SUBMENU_TYPE">SUBMENU_TYPE</a>,
164 <a href="YAHOO.widget.MenuItem.html#submenuIndicator">submenuIndicator</a>,
165 <a href="YAHOO.widget.MenuItem.html#value">value</a>
166 </code>
167 </div>
168 </div>
170 <div class="section method details">
171 <h3><a name="methodDetails">Methods</a></h3>
172 <div class="content">
173 <h4>
174 <a name="init">init</a></h4>
175 <div class="detail">
176 <code>
180 void
181 <strong>init</strong>
185 p_oObject
195 p_oConfig
199 </code>
201 <div class="description">
202 The ContextMenuItem class's initialization method. This method
203 is automatically called by the constructor, and sets up all DOM references
204 for pre-existing markup, and creates required markup if it is not
205 already present.
206 </div>
208 <div class="description">
210 <dl>
211 <dt>Parameters:</dt>
212 <dd>
213 <code>p_oObject &lt;String&gt;</code>
214 String specifying the text of the context menu item.
215 </dd>
216 <dd>
217 <code>p_oObject &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
218 one-html.html#ID-74680021">HTMLLIElement</a>&gt;</code>
219 Object specifying the
220 <code>&#60;li&#62;</code> element of the context menu item.
221 </dd>
222 <dd>
223 <code>p_oObject &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
224 one-html.html#ID-38450247">HTMLOptGroupElement</a>&gt;</code>
225 Object
226 specifying the <code>&#60;optgroup&#62;</code> element of the context
227 menu item.
228 </dd>
229 <dd>
230 <code>p_oObject &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
231 one-html.html#ID-70901257">HTMLOptionElement</a>&gt;</code>
232 Object specifying
233 the <code>&#60;option&#62;</code> element of the context menu item.
234 </dd>
235 <dd>
236 <code>p_oConfig &lt;Object&gt;</code>
237 Optional. Object literal specifying the
238 configuration for the context menu item. See configuration class
239 documentation for more details.
240 </dd>
241 </dl>
243 <dl>
244 <dt>Returns:
245 <code>
246 void
247 </code></dt>
248 <dd></dd>
249 </dl>
251 </div>
253 </div>
254 <hr />
255 <h4>
256 <a name="toString">toString</a></h4>
257 <div class="detail">
258 <code>
262 String
263 <strong>toString</strong>
266 </code>
268 <div class="description">
269 Returns a string representing the context menu item.
270 </div>
272 <div class="description">
275 <dl>
276 <dt>Returns:
277 <code>
278 String
279 </code></dt>
280 <dd></dd>
281 </dl>
283 </div>
285 </div>
286 <hr />
287 </div>
288 </div>
290 <div class="section field inheritance">
291 <h4>Methods inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
292 <div class="content">
293 <code>
295 <a href="YAHOO.widget.MenuItem.html#_checkDOMNode">_checkDOMNode</a>,
296 <a href="YAHOO.widget.MenuItem.html#_checkString">_checkString</a>,
297 <a href="YAHOO.widget.MenuItem.html#_createRootNodeStructure">_createRootNodeStructure</a>,
298 <a href="YAHOO.widget.MenuItem.html#_getFirstElement">_getFirstElement</a>,
299 <a href="YAHOO.widget.MenuItem.html#_initSubTree">_initSubTree</a>,
300 <a href="YAHOO.widget.MenuItem.html#_preloadImage">_preloadImage</a>,
301 <a href="YAHOO.widget.MenuItem.html#blur">blur</a>,
302 <a href="YAHOO.widget.MenuItem.html#configChecked">configChecked</a>,
303 <a href="YAHOO.widget.MenuItem.html#configClassName">configClassName</a>,
304 <a href="YAHOO.widget.MenuItem.html#configDisabled">configDisabled</a>,
305 <a href="YAHOO.widget.MenuItem.html#configEmphasis">configEmphasis</a>,
306 <a href="YAHOO.widget.MenuItem.html#configHelpText">configHelpText</a>,
307 <a href="YAHOO.widget.MenuItem.html#configOnClick">configOnClick</a>,
308 <a href="YAHOO.widget.MenuItem.html#configSelected">configSelected</a>,
309 <a href="YAHOO.widget.MenuItem.html#configStrongEmphasis">configStrongEmphasis</a>,
310 <a href="YAHOO.widget.MenuItem.html#configSubmenu">configSubmenu</a>,
311 <a href="YAHOO.widget.MenuItem.html#configTarget">configTarget</a>,
312 <a href="YAHOO.widget.MenuItem.html#configText">configText</a>,
313 <a href="YAHOO.widget.MenuItem.html#configURL">configURL</a>,
314 <a href="YAHOO.widget.MenuItem.html#destroy">destroy</a>,
315 <a href="YAHOO.widget.MenuItem.html#focus">focus</a>,
316 <a href="YAHOO.widget.MenuItem.html#getNextEnabledSibling">getNextEnabledSibling</a>,
317 <a href="YAHOO.widget.MenuItem.html#getPreviousEnabledSibling">getPreviousEnabledSibling</a>,
318 <a href="YAHOO.widget.MenuItem.html#init">init</a>,
319 <a href="YAHOO.widget.MenuItem.html#initDefaultConfig">initDefaultConfig</a>,
320 <a href="YAHOO.widget.MenuItem.html#toString">toString</a>
321 </code>
322 </div>
323 </div>
327 <div class="section field inheritance">
328 <h4>Events inherited from <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>:</h4>
329 <div class="content">
330 <code>
332 <a href="YAHOO.widget.MenuItem.html#blurEvent">blurEvent</a>,
333 <a href="YAHOO.widget.MenuItem.html#clickEvent">clickEvent</a>,
334 <a href="YAHOO.widget.MenuItem.html#destroyEvent">destroyEvent</a>,
335 <a href="YAHOO.widget.MenuItem.html#focusEvent">focusEvent</a>,
336 <a href="YAHOO.widget.MenuItem.html#keyDownEvent">keyDownEvent</a>,
337 <a href="YAHOO.widget.MenuItem.html#keyPressEvent">keyPressEvent</a>,
338 <a href="YAHOO.widget.MenuItem.html#keyUpEvent">keyUpEvent</a>,
339 <a href="YAHOO.widget.MenuItem.html#mouseDownEvent">mouseDownEvent</a>,
340 <a href="YAHOO.widget.MenuItem.html#mouseOutEvent">mouseOutEvent</a>,
341 <a href="YAHOO.widget.MenuItem.html#mouseOverEvent">mouseOverEvent</a>,
342 <a href="YAHOO.widget.MenuItem.html#mouseUpEvent">mouseUpEvent</a>
343 </code>
344 </div>
345 </div>
348 <div class="section field inheritance">
349 <h4>Configuration attributes 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#checked">checked</a>,
354 <a href="YAHOO.widget.MenuItem.html#classname">classname</a>,
355 <a href="YAHOO.widget.MenuItem.html#disabled">disabled</a>,
356 <a href="YAHOO.widget.MenuItem.html#emphasis">emphasis</a>,
357 <a href="YAHOO.widget.MenuItem.html#helptext">helptext</a>,
358 <a href="YAHOO.widget.MenuItem.html#onclick">onclick</a>,
359 <a href="YAHOO.widget.MenuItem.html#selected">selected</a>,
360 <a href="YAHOO.widget.MenuItem.html#strongemphasis">strongemphasis</a>,
361 <a href="YAHOO.widget.MenuItem.html#submenu">submenu</a>,
362 <a href="YAHOO.widget.MenuItem.html#target">target</a>,
363 <a href="YAHOO.widget.MenuItem.html#text">text</a>,
364 <a href="YAHOO.widget.MenuItem.html#url">url</a>
365 </code>
366 </div>
367 </div>
369 </div>
370 </div>
371 <div class="yui-b">
372 <div class="nav">
374 <div class="module">
375 <h4>Modules</h4>
376 <ul class="content">
378 <li class=""><a href="module_animation.html">animation</a></li>
380 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
382 <li class=""><a href="module_button.html">button</a></li>
384 <li class=""><a href="module_calendar.html">calendar</a></li>
386 <li class=""><a href="module_connection.html">connection</a></li>
388 <li class=""><a href="module_container.html">container</a></li>
390 <li class=""><a href="module_datasource.html">datasource</a></li>
392 <li class=""><a href="module_datatable.html">datatable</a></li>
394 <li class=""><a href="module_dom.html">dom</a></li>
396 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
398 <li class=""><a href="module_element.html">element</a></li>
400 <li class=""><a href="module_event.html">event</a></li>
402 <li class=""><a href="module_history.html">history</a></li>
404 <li class=""><a href="module_logger.html">logger</a></li>
406 <li class="selected"><a href="module_menu.html">menu</a></li>
408 <li class=""><a href="module_slider.html">slider</a></li>
410 <li class=""><a href="module_tabview.html">tabview</a></li>
412 <li class=""><a href="module_treeview.html">treeview</a></li>
414 <li class=""><a href="module_yahoo.html">yahoo</a></li>
415 </ul>
416 </div>
418 <div class="module">
419 <h4>Classes</h4>
420 <ul class="content">
421 <li class=""><a href="YAHOO.widget.ContextMenu.html">YAHOO.widget.ContextMenu</a></li>
422 <li class="selected"><a href="YAHOO.widget.ContextMenuItem.html">YAHOO.widget.ContextMenuItem</a></li>
423 <li class=""><a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></li>
424 <li class=""><a href="YAHOO.widget.Menubar.html">YAHOO.widget.Menubar</a></li>
425 <li class=""><a href="YAHOO.widget.MenuBarItem.html">YAHOO.widget.MenuBarItem</a></li>
426 <li class=""><a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></li>
427 <li class=""><a href="YAHOO.widget.MenuManager.html">YAHOO.widget.MenuManager</a></li>
428 </ul>
429 </div>
431 <div class="module">
432 <h4>Files</h4>
433 <ul class="content">
434 <li class=""><a href="contextmenu.js.html">contextmenu.js</a></li>
435 <li class=""><a href="contextmenuitem.js.html">contextmenuitem.js</a></li>
436 <li class=""><a href="menu.js.html">menu.js</a></li>
437 <li class=""><a href="menubar.js.html">menubar.js</a></li>
438 <li class=""><a href="menubaritem.js.html">menubaritem.js</a></li>
439 <li class=""><a href="menuitem.js.html">menuitem.js</a></li>
440 <li class=""><a href="menumanager.js.html">menumanager.js</a></li>
441 </ul>
442 </div>
445 <div class="module">
446 <h4>Methods</h4>
447 <ul class="content">
448 <li><!--<code>void</code>-->
449 <a href="#init">init</a>
450 </li>
451 <li><!--<code>String</code>-->
452 <a href="#toString">toString</a>
453 </li>
454 </ul>
455 </div>
459 </div>
460 </div>
461 </div>
462 <div id="ft">
463 <hr />
464 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
465 </div>
466 </div>
467 </body>
468 </html>