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