1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.menu.Menu-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.menu.Menu-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.menu.Menu-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="inner-link" href="#Ext.menu.Menu-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
---|
7 | <a class="bookmark" href="../docs/?class=Ext.menu.Menu"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
8 | </div> |
---|
9 | <div class="inheritance res-block"> |
---|
10 | <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a> |
---|
11 | <img src="resources/elbow-end.gif"/>Menu</pre></div> |
---|
12 | <h1>Class Ext.menu.Menu</h1> |
---|
13 | <table cellspacing="0"> |
---|
14 | <tr><td class="label">Package:</td><td class="hd-info">Ext.menu</td></tr> |
---|
15 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Menu.js" target="_blank">Menu.js</a></td></tr> |
---|
16 | <tr><td class="label">Class:</td><td class="hd-info">Menu</td></tr> |
---|
17 | <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.menu.ColorMenu" href="output/Ext.menu.ColorMenu.html">ColorMenu</a>, <a ext:cls="Ext.menu.DateMenu" href="output/Ext.menu.DateMenu.html">DateMenu</a></td></tr> |
---|
18 | <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr> |
---|
19 | </table> |
---|
20 | <div class="description"> |
---|
21 | * |
---|
22 | A menu object. This is the container to which you add all other menu items. Menu can also serve as a base class |
---|
23 | when you want a specialized menu based off of another component (like <a ext:cls="Ext.menu.DateMenu" href="output/Ext.menu.DateMenu.html">Ext.menu.DateMenu</a> for example). </div> |
---|
24 | |
---|
25 | <div class="hr"></div> |
---|
26 | <a id="Ext.menu.Menu-configs"></a> |
---|
27 | <h2>Config Options</h2> |
---|
28 | <table cellspacing="0" class="member-table"> |
---|
29 | <tr> |
---|
30 | <th class="sig-header" colspan="2">Config Options</th> |
---|
31 | <th class="msource-header">Defined By</th> |
---|
32 | </tr> |
---|
33 | <tr class="config-row"> |
---|
34 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
35 | <td class="sig"> |
---|
36 | <a id="Ext.menu.Menu-allowOtherMenus"></a> |
---|
37 | <b>allowOtherMenus</b> : Boolean <div class="mdesc"> |
---|
38 | True to allow multiple menus to be displayed at the same time (defaults to false) </div> |
---|
39 | </td> |
---|
40 | <td class="msource">Menu</td> |
---|
41 | </tr> |
---|
42 | <tr class="config-row alt expandable"> |
---|
43 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
44 | <td class="sig"> |
---|
45 | <a id="Ext.menu.Menu-defaultAlign"></a> |
---|
46 | <b>defaultAlign</b> : String <div class="mdesc"> |
---|
47 | <div class="short">The default Ext.Element.alignTo anchor position value for this menu relative to its element of origin (defaults to "t...</div> |
---|
48 | <div class="long"> |
---|
49 | The default <a ext:cls="Ext.Element" ext:member="alignTo" href="output/Ext.Element.html#alignTo">Ext.Element.alignTo</a> anchor position value for this menu relative to its element of origin (defaults to "tl-bl?") </div> |
---|
50 | </div> |
---|
51 | </td> |
---|
52 | <td class="msource">Menu</td> |
---|
53 | </tr> |
---|
54 | <tr class="config-row expandable"> |
---|
55 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
56 | <td class="sig"> |
---|
57 | <a id="Ext.menu.Menu-defaults"></a> |
---|
58 | <b>defaults</b> : Object <div class="mdesc"> |
---|
59 | <div class="short">A config object that will be applied to all items added to this container either via the items config or via the add ...</div> |
---|
60 | <div class="long"> |
---|
61 | A config object that will be applied to all items added to this container either via the <a ext:cls="Ext.menu.Menu" ext:member="items" href="output/Ext.menu.Menu.html#items">items</a> config or via the <a ext:cls="Ext.menu.Menu" ext:member="add" href="output/Ext.menu.Menu.html#add">add</a> method. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the menu. </div> |
---|
62 | </div> |
---|
63 | </td> |
---|
64 | <td class="msource">Menu</td> |
---|
65 | </tr> |
---|
66 | <tr class="config-row alt expandable"> |
---|
67 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
68 | <td class="sig"> |
---|
69 | <a id="Ext.menu.Menu-ignoreParentClicks"></a> |
---|
70 | <b>ignoreParentClicks</b> : Boolean <div class="mdesc"> |
---|
71 | <div class="short">True to ignore clicks on any item in this menu that is a parent item (displays a submenu) so that the submenu is not ...</div> |
---|
72 | <div class="long"> |
---|
73 | True to ignore clicks on any item in this menu that is a parent item (displays a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false). </div> |
---|
74 | </div> |
---|
75 | </td> |
---|
76 | <td class="msource">Menu</td> |
---|
77 | </tr> |
---|
78 | <tr class="config-row"> |
---|
79 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
80 | <td class="sig"> |
---|
81 | <a id="Ext.menu.Menu-items"></a> |
---|
82 | <b>items</b> : Mixed <div class="mdesc"> |
---|
83 | An array of items to be added to this menu. See <a ext:cls="Ext.menu.Menu" ext:member="add" href="output/Ext.menu.Menu.html#add">add</a> for a list of valid item types. </div> |
---|
84 | </td> |
---|
85 | <td class="msource">Menu</td> |
---|
86 | </tr> |
---|
87 | <tr class="config-row inherited alt expandable"> |
---|
88 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
89 | <td class="sig"> |
---|
90 | <a id="Ext.menu.Menu-listeners"></a> |
---|
91 | <b>listeners</b> : Object <div class="mdesc"> |
---|
92 | <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div> |
---|
93 | <div class="long"> |
---|
94 | (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div> |
---|
95 | </div> |
---|
96 | </td> |
---|
97 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td> |
---|
98 | </tr> |
---|
99 | <tr class="config-row"> |
---|
100 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
101 | <td class="sig"> |
---|
102 | <a id="Ext.menu.Menu-minWidth"></a> |
---|
103 | <b>minWidth</b> : Number <div class="mdesc"> |
---|
104 | The minimum width of the menu in pixels (defaults to 120) </div> |
---|
105 | </td> |
---|
106 | <td class="msource">Menu</td> |
---|
107 | </tr> |
---|
108 | <tr class="config-row alt expandable"> |
---|
109 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
110 | <td class="sig"> |
---|
111 | <a id="Ext.menu.Menu-shadow"></a> |
---|
112 | <b>shadow</b> : Boolean/String <div class="mdesc"> |
---|
113 | <div class="short">True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "si...</div> |
---|
114 | <div class="long"> |
---|
115 | True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "sides") </div> |
---|
116 | </div> |
---|
117 | </td> |
---|
118 | <td class="msource">Menu</td> |
---|
119 | </tr> |
---|
120 | <tr class="config-row"> |
---|
121 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
122 | <td class="sig"> |
---|
123 | <a id="Ext.menu.Menu-subMenuAlign"></a> |
---|
124 | <b>subMenuAlign</b> : String <div class="mdesc"> |
---|
125 | The <a ext:cls="Ext.Element" ext:member="alignTo" href="output/Ext.Element.html#alignTo">Ext.Element.alignTo</a> anchor position value to use for submenus of this menu (defaults to "tl-tr?") </div> |
---|
126 | </td> |
---|
127 | <td class="msource">Menu</td> |
---|
128 | </tr> |
---|
129 | </table> |
---|
130 | <a id="Ext.menu.Menu-props"></a> |
---|
131 | <h2>Public Properties</h2> |
---|
132 | <table cellspacing="0" class="member-table"> |
---|
133 | <tr> |
---|
134 | <th class="sig-header" colspan="2">Property</th> |
---|
135 | <th class="msource-header">Defined By</th> |
---|
136 | </tr> |
---|
137 | <tr class="property-row"> |
---|
138 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
139 | <td class="sig"> |
---|
140 | <a id="Ext.menu.Menu-items"></a> |
---|
141 | <b>items</b> : Ext.util.MixedCollection <div class="mdesc"> |
---|
142 | A MixedCollection of this Menu's items </div> |
---|
143 | </td> |
---|
144 | <td class="msource">Menu</td> |
---|
145 | </tr> |
---|
146 | </table> |
---|
147 | <a id="Ext.menu.Menu-methods"></a> |
---|
148 | <h2>Public Methods</h2> |
---|
149 | <table cellspacing="0" class="member-table"> |
---|
150 | <tr> |
---|
151 | <th class="sig-header" colspan="2">Method</th> |
---|
152 | <th class="msource-header">Defined By</th> |
---|
153 | </tr> |
---|
154 | <tr class="method-row expandable"> |
---|
155 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
156 | <td class="sig"> |
---|
157 | <a id="Ext.menu.Menu-Menu"></a> |
---|
158 | <b>Menu</b>( <code>Object config</code> ) <div class="mdesc"> |
---|
159 | <div class="short">Creates a new Menu</div> |
---|
160 | <div class="long"> |
---|
161 | Creates a new Menu <div class="mdetail-params"> |
---|
162 | <strong>Parameters:</strong> |
---|
163 | <ul><li><code>config</code> : Object<div class="sub-desc">Configuration options</div></li> </ul> |
---|
164 | <strong>Returns:</strong> |
---|
165 | <ul> |
---|
166 | <li><code></code></li> |
---|
167 | </ul> |
---|
168 | </div> |
---|
169 | </div> |
---|
170 | </div> |
---|
171 | </td> |
---|
172 | <td class="msource">Menu</td> |
---|
173 | </tr> |
---|
174 | <tr class="method-row alt expandable"> |
---|
175 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
176 | <td class="sig"> |
---|
177 | <a id="Ext.menu.Menu-add"></a> |
---|
178 | <b>add</b>( <code>Mixed args</code> ) : Ext.menu.Item <div class="mdesc"> |
---|
179 | <div class="short">Adds one or more items of any type supported by the Menu class, or that can be converted into menu items. |
---|
180 | Any of the ...</div> |
---|
181 | <div class="long"> |
---|
182 | Adds one or more items of any type supported by the Menu class, or that can be converted into menu items. |
---|
183 | Any of the following are valid: |
---|
184 | <ul> |
---|
185 | <li>Any menu item object based on <a ext:cls="Ext.menu.BaseItem" href="output/Ext.menu.BaseItem.html">Ext.menu.BaseItem</a></li> |
---|
186 | <li>An HTMLElement object which will be converted to a menu item</li> |
---|
187 | <li>A menu item config object that will be created as a new menu item</li> |
---|
188 | <li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise |
---|
189 | it will be converted into a <a ext:cls="Ext.menu.TextItem" href="output/Ext.menu.TextItem.html">Ext.menu.TextItem</a> and added</li> |
---|
190 | </ul> |
---|
191 | Usage: |
---|
192 | <pre><code><i>// Create the menu</i> |
---|
193 | <b>var</b> menu = <b>new</b> Ext.menu.Menu(); |
---|
194 | |
---|
195 | <i>// Create a menu item to add by reference</i> |
---|
196 | <b>var</b> menuItem = <b>new</b> Ext.menu.Item({ text: <em>'New Item!'</em> }); |
---|
197 | |
---|
198 | <i>// Add a bunch of items at once using different methods.</i> |
---|
199 | <i>// Only the last item added will be returned.</i> |
---|
200 | <b>var</b> item = menu.add( |
---|
201 | menuItem, <i>// add existing item by ref</i> |
---|
202 | <em>'Dynamic Item'</em>, <i>// <b>new</b> TextItem</i> |
---|
203 | <em>'-'</em>, <i>// <b>new</b> separator</i> |
---|
204 | { text: <em>'Config Item'</em> } <i>// <b>new</b> item by config</i> |
---|
205 | );</code></pre> <div class="mdetail-params"> |
---|
206 | <strong>Parameters:</strong> |
---|
207 | <ul><li><code>args</code> : Mixed<div class="sub-desc">One or more menu items, menu item configs or other objects that can be converted to menu items</div></li> </ul> |
---|
208 | <strong>Returns:</strong> |
---|
209 | <ul> |
---|
210 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added, or the last one if multiple items were added</div></li> |
---|
211 | </ul> |
---|
212 | </div> |
---|
213 | </div> |
---|
214 | </div> |
---|
215 | </td> |
---|
216 | <td class="msource">Menu</td> |
---|
217 | </tr> |
---|
218 | <tr class="method-row expandable"> |
---|
219 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
220 | <td class="sig"> |
---|
221 | <a id="Ext.menu.Menu-addElement"></a> |
---|
222 | <b>addElement</b>( <code>Mixed el</code> ) : Ext.menu.Item <div class="mdesc"> |
---|
223 | <div class="short">Adds an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object to the menu</div> |
---|
224 | <div class="long"> |
---|
225 | Adds an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object to the menu <div class="mdetail-params"> |
---|
226 | <strong>Parameters:</strong> |
---|
227 | <ul><li><code>el</code> : Mixed<div class="sub-desc">The element or DOM node to add, or its id</div></li> </ul> |
---|
228 | <strong>Returns:</strong> |
---|
229 | <ul> |
---|
230 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added</div></li> |
---|
231 | </ul> |
---|
232 | </div> |
---|
233 | </div> |
---|
234 | </div> |
---|
235 | </td> |
---|
236 | <td class="msource">Menu</td> |
---|
237 | </tr> |
---|
238 | <tr class="method-row inherited alt expandable"> |
---|
239 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
240 | <td class="sig"> |
---|
241 | <a id="Ext.menu.Menu-addEvents"></a> |
---|
242 | <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc"> |
---|
243 | <div class="short">Used to define events on this Observable</div> |
---|
244 | <div class="long"> |
---|
245 | Used to define events on this Observable <div class="mdetail-params"> |
---|
246 | <strong>Parameters:</strong> |
---|
247 | <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul> |
---|
248 | <strong>Returns:</strong> |
---|
249 | <ul> |
---|
250 | <li><code>void</code></li> |
---|
251 | </ul> |
---|
252 | </div> |
---|
253 | </div> |
---|
254 | </div> |
---|
255 | </td> |
---|
256 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td> |
---|
257 | </tr> |
---|
258 | <tr class="method-row expandable"> |
---|
259 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
260 | <td class="sig"> |
---|
261 | <a id="Ext.menu.Menu-addItem"></a> |
---|
262 | <b>addItem</b>( <code>Ext.menu.Item item</code> ) : Ext.menu.Item <div class="mdesc"> |
---|
263 | <div class="short">Adds an existing object based on <a ext:cls="Ext.menu.BaseItem" href="output/Ext.menu.BaseItem.html">Ext.menu.BaseItem</a> to the menu</div> |
---|
264 | <div class="long"> |
---|
265 | Adds an existing object based on <a ext:cls="Ext.menu.BaseItem" href="output/Ext.menu.BaseItem.html">Ext.menu.BaseItem</a> to the menu <div class="mdetail-params"> |
---|
266 | <strong>Parameters:</strong> |
---|
267 | <ul><li><code>item</code> : Ext.menu.Item<div class="sub-desc">The menu item to add</div></li> </ul> |
---|
268 | <strong>Returns:</strong> |
---|
269 | <ul> |
---|
270 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added</div></li> |
---|
271 | </ul> |
---|
272 | </div> |
---|
273 | </div> |
---|
274 | </div> |
---|
275 | </td> |
---|
276 | <td class="msource">Menu</td> |
---|
277 | </tr> |
---|
278 | <tr class="method-row inherited alt expandable"> |
---|
279 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
280 | <td class="sig"> |
---|
281 | <a id="Ext.menu.Menu-addListener"></a> |
---|
282 | <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
283 | <div class="short">Appends an event handler to this component</div> |
---|
284 | <div class="long"> |
---|
285 | Appends an event handler to this component <div class="mdetail-params"> |
---|
286 | <strong>Parameters:</strong> |
---|
287 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler |
---|
288 | function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration |
---|
289 | properties. This may contain any of the following properties:<ul> |
---|
290 | <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li> |
---|
291 | <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li> |
---|
292 | <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li> |
---|
293 | <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed |
---|
294 | by the specified number of milliseconds. If the event fires again within that time, the original |
---|
295 | handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li> |
---|
296 | </ul><br> |
---|
297 | <p> |
---|
298 | <b>Combining Options</b><br> |
---|
299 | Using the options argument, it is possible to combine different types of listeners:<br> |
---|
300 | <br> |
---|
301 | A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) |
---|
302 | <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, { |
---|
303 | single: true, |
---|
304 | delay: 100, |
---|
305 | forumId: 4 |
---|
306 | });</code></pre> |
---|
307 | <p> |
---|
308 | <b>Attaching multiple handlers in 1 call</b><br> |
---|
309 | The method also allows for a single argument to be passed which is a config object containing properties |
---|
310 | which specify multiple handlers. |
---|
311 | <p> |
---|
312 | <pre><code>foo.on({ |
---|
313 | <em>'click'</em> : { |
---|
314 | fn: <b>this</b>.onClick, |
---|
315 | scope: <b>this</b>, |
---|
316 | delay: 100 |
---|
317 | }, |
---|
318 | <em>'mouseover'</em> : { |
---|
319 | fn: <b>this</b>.onMouseOver, |
---|
320 | scope: <b>this</b> |
---|
321 | }, |
---|
322 | <em>'mouseout'</em> : { |
---|
323 | fn: <b>this</b>.onMouseOut, |
---|
324 | scope: <b>this</b> |
---|
325 | } |
---|
326 | });</code></pre> |
---|
327 | <p> |
---|
328 | Or a shorthand syntax:<br> |
---|
329 | <pre><code>foo.on({ |
---|
330 | <em>'click'</em> : <b>this</b>.onClick, |
---|
331 | <em>'mouseover'</em> : <b>this</b>.onMouseOver, |
---|
332 | <em>'mouseout'</em> : <b>this</b>.onMouseOut, |
---|
333 | scope: <b>this</b> |
---|
334 | });</code></pre></div></li> </ul> |
---|
335 | <strong>Returns:</strong> |
---|
336 | <ul> |
---|
337 | <li><code>void</code></li> |
---|
338 | </ul> |
---|
339 | </div> |
---|
340 | </div> |
---|
341 | </div> |
---|
342 | </td> |
---|
343 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td> |
---|
344 | </tr> |
---|
345 | <tr class="method-row expandable"> |
---|
346 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
347 | <td class="sig"> |
---|
348 | <a id="Ext.menu.Menu-addMenuItem"></a> |
---|
349 | <b>addMenuItem</b>( <code>Object config</code> ) : Ext.menu.Item <div class="mdesc"> |
---|
350 | <div class="short">Creates a new <a ext:cls="Ext.menu.Item" href="output/Ext.menu.Item.html">Ext.menu.Item</a> based an the supplied config object and adds it to the menu</div> |
---|
351 | <div class="long"> |
---|
352 | Creates a new <a ext:cls="Ext.menu.Item" href="output/Ext.menu.Item.html">Ext.menu.Item</a> based an the supplied config object and adds it to the menu <div class="mdetail-params"> |
---|
353 | <strong>Parameters:</strong> |
---|
354 | <ul><li><code>config</code> : Object<div class="sub-desc">A MenuItem config object</div></li> </ul> |
---|
355 | <strong>Returns:</strong> |
---|
356 | <ul> |
---|
357 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added</div></li> |
---|
358 | </ul> |
---|
359 | </div> |
---|
360 | </div> |
---|
361 | </div> |
---|
362 | </td> |
---|
363 | <td class="msource">Menu</td> |
---|
364 | </tr> |
---|
365 | <tr class="method-row alt expandable"> |
---|
366 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
367 | <td class="sig"> |
---|
368 | <a id="Ext.menu.Menu-addSeparator"></a> |
---|
369 | <b>addSeparator</b>() : Ext.menu.Item <div class="mdesc"> |
---|
370 | <div class="short">Adds a separator bar to the menu</div> |
---|
371 | <div class="long"> |
---|
372 | Adds a separator bar to the menu <div class="mdetail-params"> |
---|
373 | <strong>Parameters:</strong> |
---|
374 | <ul><li>None.</li> </ul> |
---|
375 | <strong>Returns:</strong> |
---|
376 | <ul> |
---|
377 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added</div></li> |
---|
378 | </ul> |
---|
379 | </div> |
---|
380 | </div> |
---|
381 | </div> |
---|
382 | </td> |
---|
383 | <td class="msource">Menu</td> |
---|
384 | </tr> |
---|
385 | <tr class="method-row expandable"> |
---|
386 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
387 | <td class="sig"> |
---|
388 | <a id="Ext.menu.Menu-addText"></a> |
---|
389 | <b>addText</b>( <code>String text</code> ) : Ext.menu.Item <div class="mdesc"> |
---|
390 | <div class="short">Creates a new <a ext:cls="Ext.menu.TextItem" href="output/Ext.menu.TextItem.html">Ext.menu.TextItem</a> with the supplied text and adds it to the menu</div> |
---|
391 | <div class="long"> |
---|
392 | Creates a new <a ext:cls="Ext.menu.TextItem" href="output/Ext.menu.TextItem.html">Ext.menu.TextItem</a> with the supplied text and adds it to the menu <div class="mdetail-params"> |
---|
393 | <strong>Parameters:</strong> |
---|
394 | <ul><li><code>text</code> : String<div class="sub-desc">The text to display in the menu item</div></li> </ul> |
---|
395 | <strong>Returns:</strong> |
---|
396 | <ul> |
---|
397 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added</div></li> |
---|
398 | </ul> |
---|
399 | </div> |
---|
400 | </div> |
---|
401 | </div> |
---|
402 | </td> |
---|
403 | <td class="msource">Menu</td> |
---|
404 | </tr> |
---|
405 | <tr class="method-row alt expandable"> |
---|
406 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
407 | <td class="sig"> |
---|
408 | <a id="Ext.menu.Menu-destroy"></a> |
---|
409 | <b>destroy</b>() : void <div class="mdesc"> |
---|
410 | <div class="short">Destroys the menu by unregistering it from Ext.menu.MenuMgr, purging event listeners, |
---|
411 | removing all of the menus item...</div> |
---|
412 | <div class="long"> |
---|
413 | Destroys the menu by unregistering it from <a ext:cls="Ext.menu.MenuMgr" href="output/Ext.menu.MenuMgr.html">Ext.menu.MenuMgr</a>, purging event listeners, |
---|
414 | removing all of the menus items, then destroying the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> <div class="mdetail-params"> |
---|
415 | <strong>Parameters:</strong> |
---|
416 | <ul><li>None.</li> </ul> |
---|
417 | <strong>Returns:</strong> |
---|
418 | <ul> |
---|
419 | <li><code>void</code></li> |
---|
420 | </ul> |
---|
421 | </div> |
---|
422 | </div> |
---|
423 | </div> |
---|
424 | </td> |
---|
425 | <td class="msource">Menu</td> |
---|
426 | </tr> |
---|
427 | <tr class="method-row inherited expandable"> |
---|
428 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
429 | <td class="sig"> |
---|
430 | <a id="Ext.menu.Menu-fireEvent"></a> |
---|
431 | <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc"> |
---|
432 | <div class="short">Fires the specified event with the passed parameters (minus the event name).</div> |
---|
433 | <div class="long"> |
---|
434 | Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params"> |
---|
435 | <strong>Parameters:</strong> |
---|
436 | <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul> |
---|
437 | <strong>Returns:</strong> |
---|
438 | <ul> |
---|
439 | <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li> |
---|
440 | </ul> |
---|
441 | </div> |
---|
442 | </div> |
---|
443 | </div> |
---|
444 | </td> |
---|
445 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td> |
---|
446 | </tr> |
---|
447 | <tr class="method-row alt expandable"> |
---|
448 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
449 | <td class="sig"> |
---|
450 | <a id="Ext.menu.Menu-getEl"></a> |
---|
451 | <b>getEl</b>() : Ext.Element <div class="mdesc"> |
---|
452 | <div class="short">Returns this menu's underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object</div> |
---|
453 | <div class="long"> |
---|
454 | Returns this menu's underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a> object <div class="mdetail-params"> |
---|
455 | <strong>Parameters:</strong> |
---|
456 | <ul><li>None.</li> </ul> |
---|
457 | <strong>Returns:</strong> |
---|
458 | <ul> |
---|
459 | <li><code>Ext.Element</code><div class="sub-desc">The element</div></li> |
---|
460 | </ul> |
---|
461 | </div> |
---|
462 | </div> |
---|
463 | </div> |
---|
464 | </td> |
---|
465 | <td class="msource">Menu</td> |
---|
466 | </tr> |
---|
467 | <tr class="method-row inherited expandable"> |
---|
468 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
469 | <td class="sig"> |
---|
470 | <a id="Ext.menu.Menu-hasListener"></a> |
---|
471 | <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc"> |
---|
472 | <div class="short">Checks to see if this object has any listeners for a specified event</div> |
---|
473 | <div class="long"> |
---|
474 | Checks to see if this object has any listeners for a specified event <div class="mdetail-params"> |
---|
475 | <strong>Parameters:</strong> |
---|
476 | <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul> |
---|
477 | <strong>Returns:</strong> |
---|
478 | <ul> |
---|
479 | <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li> |
---|
480 | </ul> |
---|
481 | </div> |
---|
482 | </div> |
---|
483 | </div> |
---|
484 | </td> |
---|
485 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td> |
---|
486 | </tr> |
---|
487 | <tr class="method-row alt expandable"> |
---|
488 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
489 | <td class="sig"> |
---|
490 | <a id="Ext.menu.Menu-hide"></a> |
---|
491 | <b>hide</b>( <span class="optional" title="Optional">[<code>Boolean deep</code>]</span> ) : void <div class="mdesc"> |
---|
492 | <div class="short">Hides this menu and optionally all parent menus</div> |
---|
493 | <div class="long"> |
---|
494 | Hides this menu and optionally all parent menus <div class="mdetail-params"> |
---|
495 | <strong>Parameters:</strong> |
---|
496 | <ul><li><code>deep</code> : Boolean<div class="sub-desc">(optional) True to hide all parent menus recursively, if any (defaults to false)</div></li> </ul> |
---|
497 | <strong>Returns:</strong> |
---|
498 | <ul> |
---|
499 | <li><code>void</code></li> |
---|
500 | </ul> |
---|
501 | </div> |
---|
502 | </div> |
---|
503 | </div> |
---|
504 | </td> |
---|
505 | <td class="msource">Menu</td> |
---|
506 | </tr> |
---|
507 | <tr class="method-row expandable"> |
---|
508 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
509 | <td class="sig"> |
---|
510 | <a id="Ext.menu.Menu-insert"></a> |
---|
511 | <b>insert</b>( <code>Number index</code>, <code>Ext.menu.Item item</code> ) : Ext.menu.Item <div class="mdesc"> |
---|
512 | <div class="short">Inserts an existing object based on <a ext:cls="Ext.menu.BaseItem" href="output/Ext.menu.BaseItem.html">Ext.menu.BaseItem</a> to the menu at a specified index</div> |
---|
513 | <div class="long"> |
---|
514 | Inserts an existing object based on <a ext:cls="Ext.menu.BaseItem" href="output/Ext.menu.BaseItem.html">Ext.menu.BaseItem</a> to the menu at a specified index <div class="mdetail-params"> |
---|
515 | <strong>Parameters:</strong> |
---|
516 | <ul><li><code>index</code> : Number<div class="sub-desc">The index in the menu's list of current items where the new item should be inserted</div></li><li><code>item</code> : Ext.menu.Item<div class="sub-desc">The menu item to add</div></li> </ul> |
---|
517 | <strong>Returns:</strong> |
---|
518 | <ul> |
---|
519 | <li><code>Ext.menu.Item</code><div class="sub-desc">The menu item that was added</div></li> |
---|
520 | </ul> |
---|
521 | </div> |
---|
522 | </div> |
---|
523 | </div> |
---|
524 | </td> |
---|
525 | <td class="msource">Menu</td> |
---|
526 | </tr> |
---|
527 | <tr class="method-row alt expandable"> |
---|
528 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
529 | <td class="sig"> |
---|
530 | <a id="Ext.menu.Menu-isVisible"></a> |
---|
531 | <b>isVisible</b>() : void <div class="mdesc"> |
---|
532 | <div class="short">Read-only. Returns true if the menu is currently displayed, else false.</div> |
---|
533 | <div class="long"> |
---|
534 | Read-only. Returns true if the menu is currently displayed, else false. <div class="mdetail-params"> |
---|
535 | <strong>Parameters:</strong> |
---|
536 | <ul><li>None.</li> </ul> |
---|
537 | <strong>Returns:</strong> |
---|
538 | <ul> |
---|
539 | <li><code>void</code></li> |
---|
540 | </ul> |
---|
541 | </div> |
---|
542 | </div> |
---|
543 | </div> |
---|
544 | </td> |
---|
545 | <td class="msource">Menu</td> |
---|
546 | </tr> |
---|
547 | <tr class="method-row inherited expandable"> |
---|
548 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
549 | <td class="sig"> |
---|
550 | <a id="Ext.menu.Menu-on"></a> |
---|
551 | <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
552 | <div class="short">Appends an event handler to this element (shorthand for addListener)</div> |
---|
553 | <div class="long"> |
---|
554 | Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params"> |
---|
555 | <strong>Parameters:</strong> |
---|
556 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler |
---|
557 | function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul> |
---|
558 | <strong>Returns:</strong> |
---|
559 | <ul> |
---|
560 | <li><code>void</code></li> |
---|
561 | </ul> |
---|
562 | </div> |
---|
563 | </div> |
---|
564 | </div> |
---|
565 | </td> |
---|
566 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td> |
---|
567 | </tr> |
---|
568 | <tr class="method-row inherited alt expandable"> |
---|
569 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
570 | <td class="sig"> |
---|
571 | <a id="Ext.menu.Menu-purgeListeners"></a> |
---|
572 | <b>purgeListeners</b>() : void <div class="mdesc"> |
---|
573 | <div class="short">Removes all listeners for this object</div> |
---|
574 | <div class="long"> |
---|
575 | Removes all listeners for this object <div class="mdetail-params"> |
---|
576 | <strong>Parameters:</strong> |
---|
577 | <ul><li>None.</li> </ul> |
---|
578 | <strong>Returns:</strong> |
---|
579 | <ul> |
---|
580 | <li><code>void</code></li> |
---|
581 | </ul> |
---|
582 | </div> |
---|
583 | </div> |
---|
584 | </div> |
---|
585 | </td> |
---|
586 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td> |
---|
587 | </tr> |
---|
588 | <tr class="method-row inherited expandable"> |
---|
589 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
590 | <td class="sig"> |
---|
591 | <a id="Ext.menu.Menu-relayEvents"></a> |
---|
592 | <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc"> |
---|
593 | <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div> |
---|
594 | <div class="long"> |
---|
595 | Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params"> |
---|
596 | <strong>Parameters:</strong> |
---|
597 | <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul> |
---|
598 | <strong>Returns:</strong> |
---|
599 | <ul> |
---|
600 | <li><code>void</code></li> |
---|
601 | </ul> |
---|
602 | </div> |
---|
603 | </div> |
---|
604 | </div> |
---|
605 | </td> |
---|
606 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td> |
---|
607 | </tr> |
---|
608 | <tr class="method-row alt expandable"> |
---|
609 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
610 | <td class="sig"> |
---|
611 | <a id="Ext.menu.Menu-remove"></a> |
---|
612 | <b>remove</b>( <code>Ext.menu.Item item</code> ) : void <div class="mdesc"> |
---|
613 | <div class="short">Removes an <a ext:cls="Ext.menu.Item" href="output/Ext.menu.Item.html">Ext.menu.Item</a> from the menu and destroys the object</div> |
---|
614 | <div class="long"> |
---|
615 | Removes an <a ext:cls="Ext.menu.Item" href="output/Ext.menu.Item.html">Ext.menu.Item</a> from the menu and destroys the object <div class="mdetail-params"> |
---|
616 | <strong>Parameters:</strong> |
---|
617 | <ul><li><code>item</code> : Ext.menu.Item<div class="sub-desc">The menu item to remove</div></li> </ul> |
---|
618 | <strong>Returns:</strong> |
---|
619 | <ul> |
---|
620 | <li><code>void</code></li> |
---|
621 | </ul> |
---|
622 | </div> |
---|
623 | </div> |
---|
624 | </div> |
---|
625 | </td> |
---|
626 | <td class="msource">Menu</td> |
---|
627 | </tr> |
---|
628 | <tr class="method-row expandable"> |
---|
629 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
630 | <td class="sig"> |
---|
631 | <a id="Ext.menu.Menu-removeAll"></a> |
---|
632 | <b>removeAll</b>() : void <div class="mdesc"> |
---|
633 | <div class="short">Removes and destroys all items in the menu</div> |
---|
634 | <div class="long"> |
---|
635 | Removes and destroys all items in the menu <div class="mdetail-params"> |
---|
636 | <strong>Parameters:</strong> |
---|
637 | <ul><li>None.</li> </ul> |
---|
638 | <strong>Returns:</strong> |
---|
639 | <ul> |
---|
640 | <li><code>void</code></li> |
---|
641 | </ul> |
---|
642 | </div> |
---|
643 | </div> |
---|
644 | </div> |
---|
645 | </td> |
---|
646 | <td class="msource">Menu</td> |
---|
647 | </tr> |
---|
648 | <tr class="method-row inherited alt expandable"> |
---|
649 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
650 | <td class="sig"> |
---|
651 | <a id="Ext.menu.Menu-removeListener"></a> |
---|
652 | <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
653 | <div class="short">Removes a listener</div> |
---|
654 | <div class="long"> |
---|
655 | Removes a listener <div class="mdetail-params"> |
---|
656 | <strong>Parameters:</strong> |
---|
657 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul> |
---|
658 | <strong>Returns:</strong> |
---|
659 | <ul> |
---|
660 | <li><code>void</code></li> |
---|
661 | </ul> |
---|
662 | </div> |
---|
663 | </div> |
---|
664 | </div> |
---|
665 | </td> |
---|
666 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td> |
---|
667 | </tr> |
---|
668 | <tr class="method-row inherited expandable"> |
---|
669 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
670 | <td class="sig"> |
---|
671 | <a id="Ext.menu.Menu-resumeEvents"></a> |
---|
672 | <b>resumeEvents</b>() : void <div class="mdesc"> |
---|
673 | <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div> |
---|
674 | <div class="long"> |
---|
675 | Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params"> |
---|
676 | <strong>Parameters:</strong> |
---|
677 | <ul><li>None.</li> </ul> |
---|
678 | <strong>Returns:</strong> |
---|
679 | <ul> |
---|
680 | <li><code>void</code></li> |
---|
681 | </ul> |
---|
682 | </div> |
---|
683 | </div> |
---|
684 | </div> |
---|
685 | </td> |
---|
686 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td> |
---|
687 | </tr> |
---|
688 | <tr class="method-row alt expandable"> |
---|
689 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
690 | <td class="sig"> |
---|
691 | <a id="Ext.menu.Menu-show"></a> |
---|
692 | <b>show</b>( <code>Mixed element</code>, <span class="optional" title="Optional">[<code>String position</code>]</span>, <span class="optional" title="Optional">[<code>Ext.menu.Menu parentMenu</code>]</span> ) : void <div class="mdesc"> |
---|
693 | <div class="short">Displays this menu relative to another element</div> |
---|
694 | <div class="long"> |
---|
695 | Displays this menu relative to another element <div class="mdetail-params"> |
---|
696 | <strong>Parameters:</strong> |
---|
697 | <ul><li><code>element</code> : Mixed<div class="sub-desc">The element to align to</div></li><li><code>position</code> : String<div class="sub-desc">(optional) The <a ext:cls="Ext.Element" ext:member="alignTo" href="output/Ext.Element.html#alignTo">Ext.Element.alignTo</a> anchor position to use in aligning to |
---|
698 | the element (defaults to this.defaultAlign)</div></li><li><code>parentMenu</code> : Ext.menu.Menu<div class="sub-desc">(optional) This menu's parent menu, if applicable (defaults to undefined)</div></li> </ul> |
---|
699 | <strong>Returns:</strong> |
---|
700 | <ul> |
---|
701 | <li><code>void</code></li> |
---|
702 | </ul> |
---|
703 | </div> |
---|
704 | </div> |
---|
705 | </div> |
---|
706 | </td> |
---|
707 | <td class="msource">Menu</td> |
---|
708 | </tr> |
---|
709 | <tr class="method-row expandable"> |
---|
710 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
711 | <td class="sig"> |
---|
712 | <a id="Ext.menu.Menu-showAt"></a> |
---|
713 | <b>showAt</b>( <code>Array xyPosition</code>, <span class="optional" title="Optional">[<code>Ext.menu.Menu parentMenu</code>]</span> ) : void <div class="mdesc"> |
---|
714 | <div class="short">Displays this menu at a specific xy position</div> |
---|
715 | <div class="long"> |
---|
716 | Displays this menu at a specific xy position <div class="mdetail-params"> |
---|
717 | <strong>Parameters:</strong> |
---|
718 | <ul><li><code>xyPosition</code> : Array<div class="sub-desc">Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)</div></li><li><code>parentMenu</code> : Ext.menu.Menu<div class="sub-desc">(optional) This menu's parent menu, if applicable (defaults to undefined)</div></li> </ul> |
---|
719 | <strong>Returns:</strong> |
---|
720 | <ul> |
---|
721 | <li><code>void</code></li> |
---|
722 | </ul> |
---|
723 | </div> |
---|
724 | </div> |
---|
725 | </div> |
---|
726 | </td> |
---|
727 | <td class="msource">Menu</td> |
---|
728 | </tr> |
---|
729 | <tr class="method-row inherited alt expandable"> |
---|
730 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
731 | <td class="sig"> |
---|
732 | <a id="Ext.menu.Menu-suspendEvents"></a> |
---|
733 | <b>suspendEvents</b>() : void <div class="mdesc"> |
---|
734 | <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div> |
---|
735 | <div class="long"> |
---|
736 | Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params"> |
---|
737 | <strong>Parameters:</strong> |
---|
738 | <ul><li>None.</li> </ul> |
---|
739 | <strong>Returns:</strong> |
---|
740 | <ul> |
---|
741 | <li><code>void</code></li> |
---|
742 | </ul> |
---|
743 | </div> |
---|
744 | </div> |
---|
745 | </div> |
---|
746 | </td> |
---|
747 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td> |
---|
748 | </tr> |
---|
749 | <tr class="method-row inherited expandable"> |
---|
750 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
751 | <td class="sig"> |
---|
752 | <a id="Ext.menu.Menu-un"></a> |
---|
753 | <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
754 | <div class="short">Removes a listener (shorthand for removeListener)</div> |
---|
755 | <div class="long"> |
---|
756 | Removes a listener (shorthand for removeListener) <div class="mdetail-params"> |
---|
757 | <strong>Parameters:</strong> |
---|
758 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul> |
---|
759 | <strong>Returns:</strong> |
---|
760 | <ul> |
---|
761 | <li><code>void</code></li> |
---|
762 | </ul> |
---|
763 | </div> |
---|
764 | </div> |
---|
765 | </div> |
---|
766 | </td> |
---|
767 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td> |
---|
768 | </tr> |
---|
769 | </table> |
---|
770 | <a id="Ext.menu.Menu-events"></a> |
---|
771 | <h2>Public Events</h2> |
---|
772 | <table cellspacing="0" class="member-table"> |
---|
773 | <tr> |
---|
774 | <th class="sig-header" colspan="2">Event</th> |
---|
775 | <th class="msource-header">Defined By</th> |
---|
776 | </tr> |
---|
777 | <tr class="event-row expandable"> |
---|
778 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
779 | <td class="sig"> |
---|
780 | <a id="Ext.menu.Menu-beforehide"></a> |
---|
781 | <b>beforehide</b> : ( <code>Ext.menu.Menu this</code> ) <div class="mdesc"> |
---|
782 | <div class="short">Fires before this menu is hidden</div> |
---|
783 | <div class="long"> |
---|
784 | Fires before this menu is hidden <div class="mdetail-params"> |
---|
785 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
786 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li> </ul> |
---|
787 | </div> |
---|
788 | </div> |
---|
789 | </div> |
---|
790 | </td> |
---|
791 | <td class="msource">Menu</td> |
---|
792 | </tr> |
---|
793 | <tr class="event-row alt expandable"> |
---|
794 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
795 | <td class="sig"> |
---|
796 | <a id="Ext.menu.Menu-beforeshow"></a> |
---|
797 | <b>beforeshow</b> : ( <code>Ext.menu.Menu this</code> ) <div class="mdesc"> |
---|
798 | <div class="short">Fires before this menu is displayed</div> |
---|
799 | <div class="long"> |
---|
800 | Fires before this menu is displayed <div class="mdetail-params"> |
---|
801 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
802 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li> </ul> |
---|
803 | </div> |
---|
804 | </div> |
---|
805 | </div> |
---|
806 | </td> |
---|
807 | <td class="msource">Menu</td> |
---|
808 | </tr> |
---|
809 | <tr class="event-row expandable"> |
---|
810 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
811 | <td class="sig"> |
---|
812 | <a id="Ext.menu.Menu-click"></a> |
---|
813 | <b>click</b> : ( <code>Ext.menu.Menu this</code>, <code>Ext.menu.Item menuItem</code>, <code>Ext.EventObject e</code> ) <div class="mdesc"> |
---|
814 | <div class="short">Fires when this menu is clicked (or when the enter key is pressed while it is active)</div> |
---|
815 | <div class="long"> |
---|
816 | Fires when this menu is clicked (or when the enter key is pressed while it is active) <div class="mdetail-params"> |
---|
817 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
818 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li><li><code>menuItem</code> : Ext.menu.Item<div class="sub-desc">The menu item that was clicked</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li> </ul> |
---|
819 | </div> |
---|
820 | </div> |
---|
821 | </div> |
---|
822 | </td> |
---|
823 | <td class="msource">Menu</td> |
---|
824 | </tr> |
---|
825 | <tr class="event-row alt expandable"> |
---|
826 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
827 | <td class="sig"> |
---|
828 | <a id="Ext.menu.Menu-hide"></a> |
---|
829 | <b>hide</b> : ( <code>Ext.menu.Menu this</code> ) <div class="mdesc"> |
---|
830 | <div class="short">Fires after this menu is hidden</div> |
---|
831 | <div class="long"> |
---|
832 | Fires after this menu is hidden <div class="mdetail-params"> |
---|
833 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
834 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li> </ul> |
---|
835 | </div> |
---|
836 | </div> |
---|
837 | </div> |
---|
838 | </td> |
---|
839 | <td class="msource">Menu</td> |
---|
840 | </tr> |
---|
841 | <tr class="event-row expandable"> |
---|
842 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
843 | <td class="sig"> |
---|
844 | <a id="Ext.menu.Menu-itemclick"></a> |
---|
845 | <b>itemclick</b> : ( <code>Ext.menu.BaseItem baseItem</code>, <code>Ext.EventObject e</code> ) <div class="mdesc"> |
---|
846 | <div class="short">Fires when a menu item contained in this menu is clicked</div> |
---|
847 | <div class="long"> |
---|
848 | Fires when a menu item contained in this menu is clicked <div class="mdetail-params"> |
---|
849 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
850 | <ul><li><code>baseItem</code> : Ext.menu.BaseItem<div class="sub-desc">The BaseItem that was clicked</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li> </ul> |
---|
851 | </div> |
---|
852 | </div> |
---|
853 | </div> |
---|
854 | </td> |
---|
855 | <td class="msource">Menu</td> |
---|
856 | </tr> |
---|
857 | <tr class="event-row alt expandable"> |
---|
858 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
859 | <td class="sig"> |
---|
860 | <a id="Ext.menu.Menu-mouseout"></a> |
---|
861 | <b>mouseout</b> : ( <code>Ext.menu.Menu this</code>, <code>Ext.EventObject e</code>, <code>Ext.menu.Item menuItem</code> ) <div class="mdesc"> |
---|
862 | <div class="short">Fires when the mouse exits this menu</div> |
---|
863 | <div class="long"> |
---|
864 | Fires when the mouse exits this menu <div class="mdetail-params"> |
---|
865 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
866 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li><li><code>menuItem</code> : Ext.menu.Item<div class="sub-desc">The menu item that was clicked</div></li> </ul> |
---|
867 | </div> |
---|
868 | </div> |
---|
869 | </div> |
---|
870 | </td> |
---|
871 | <td class="msource">Menu</td> |
---|
872 | </tr> |
---|
873 | <tr class="event-row expandable"> |
---|
874 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
875 | <td class="sig"> |
---|
876 | <a id="Ext.menu.Menu-mouseover"></a> |
---|
877 | <b>mouseover</b> : ( <code>Ext.menu.Menu this</code>, <code>Ext.EventObject e</code>, <code>Ext.menu.Item menuItem</code> ) <div class="mdesc"> |
---|
878 | <div class="short">Fires when the mouse is hovering over this menu</div> |
---|
879 | <div class="long"> |
---|
880 | Fires when the mouse is hovering over this menu <div class="mdetail-params"> |
---|
881 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
882 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li><li><code>menuItem</code> : Ext.menu.Item<div class="sub-desc">The menu item that was clicked</div></li> </ul> |
---|
883 | </div> |
---|
884 | </div> |
---|
885 | </div> |
---|
886 | </td> |
---|
887 | <td class="msource">Menu</td> |
---|
888 | </tr> |
---|
889 | <tr class="event-row alt expandable"> |
---|
890 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
891 | <td class="sig"> |
---|
892 | <a id="Ext.menu.Menu-show"></a> |
---|
893 | <b>show</b> : ( <code>Ext.menu.Menu this</code> ) <div class="mdesc"> |
---|
894 | <div class="short">Fires after this menu is displayed</div> |
---|
895 | <div class="long"> |
---|
896 | Fires after this menu is displayed <div class="mdetail-params"> |
---|
897 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
898 | <ul><li><code>this</code> : Ext.menu.Menu<div class="sub-desc"></div></li> </ul> |
---|
899 | </div> |
---|
900 | </div> |
---|
901 | </div> |
---|
902 | </td> |
---|
903 | <td class="msource">Menu</td> |
---|
904 | </tr> |
---|
905 | </table> |
---|
906 | |
---|
907 | </div> |
---|