1 | <div class="body-wrap"> |
---|
2 | <div class="top-tools"> |
---|
3 | <a class="inner-link" href="#Ext.WindowGroup-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
4 | <a class="inner-link" href="#Ext.WindowGroup-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
5 | <a class="inner-link" href="#Ext.WindowGroup-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
6 | <a class="bookmark" href="../docs/?class=Ext.WindowGroup"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
7 | </div> |
---|
8 | <h1>Class Ext.WindowGroup</h1> |
---|
9 | <table cellspacing="0"> |
---|
10 | <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr> |
---|
11 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/WindowManager.js" target="_blank">WindowManager.js</a></td></tr> |
---|
12 | <tr><td class="label">Class:</td><td class="hd-info">WindowGroup</td></tr> |
---|
13 | <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.WindowMgr" href="output/Ext.WindowMgr.html">WindowMgr</a></td></tr> |
---|
14 | <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr> |
---|
15 | </table> |
---|
16 | <div class="description"> |
---|
17 | * |
---|
18 | An object that represents a group of <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> instances and provides z-order management |
---|
19 | and window activation behavior. </div> |
---|
20 | |
---|
21 | <div class="hr"></div> |
---|
22 | <a id="Ext.WindowGroup-props"></a> |
---|
23 | <h2>Public Properties</h2> |
---|
24 | <table cellspacing="0" class="member-table"> |
---|
25 | <tr> |
---|
26 | <th class="sig-header" colspan="2">Property</th> |
---|
27 | <th class="msource-header">Defined By</th> |
---|
28 | </tr> |
---|
29 | <tr class="property-row"> |
---|
30 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
31 | <td class="sig"> |
---|
32 | <a id="Ext.WindowGroup-zseed"></a> |
---|
33 | <b>zseed</b> : Number <div class="mdesc"> |
---|
34 | The starting z-index for windows (defaults to 9000) </div> |
---|
35 | </td> |
---|
36 | <td class="msource">WindowGroup</td> |
---|
37 | </tr> |
---|
38 | </table> |
---|
39 | <a id="Ext.WindowGroup-methods"></a> |
---|
40 | <h2>Public Methods</h2> |
---|
41 | <table cellspacing="0" class="member-table"> |
---|
42 | <tr> |
---|
43 | <th class="sig-header" colspan="2">Method</th> |
---|
44 | <th class="msource-header">Defined By</th> |
---|
45 | </tr> |
---|
46 | <tr class="method-row expandable"> |
---|
47 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
48 | <td class="sig"> |
---|
49 | <a id="Ext.WindowGroup-WindowGroup"></a> |
---|
50 | <b>WindowGroup</b>() <div class="mdesc"> |
---|
51 | <div class="short"></div> |
---|
52 | <div class="long"> |
---|
53 | <div class="mdetail-params"> |
---|
54 | <strong>Parameters:</strong> |
---|
55 | <ul><li>None.</li> </ul> |
---|
56 | <strong>Returns:</strong> |
---|
57 | <ul> |
---|
58 | <li><code></code></li> |
---|
59 | </ul> |
---|
60 | </div> |
---|
61 | </div> |
---|
62 | </div> |
---|
63 | </td> |
---|
64 | <td class="msource">WindowGroup</td> |
---|
65 | </tr> |
---|
66 | <tr class="method-row alt expandable"> |
---|
67 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
68 | <td class="sig"> |
---|
69 | <a id="Ext.WindowGroup-bringToFront"></a> |
---|
70 | <b>bringToFront</b>( <code>String/Object win</code> ) : Boolean <div class="mdesc"> |
---|
71 | <div class="short">Brings the specified window to the front of any other active windows.</div> |
---|
72 | <div class="long"> |
---|
73 | Brings the specified window to the front of any other active windows. <div class="mdetail-params"> |
---|
74 | <strong>Parameters:</strong> |
---|
75 | <ul><li><code>win</code> : String/Object<div class="sub-desc">The id of the window or a <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> instance</div></li> </ul> |
---|
76 | <strong>Returns:</strong> |
---|
77 | <ul> |
---|
78 | <li><code>Boolean</code><div class="sub-desc">True if the dialog was brought to the front, else false if it was already in front</div></li> |
---|
79 | </ul> |
---|
80 | </div> |
---|
81 | </div> |
---|
82 | </div> |
---|
83 | </td> |
---|
84 | <td class="msource">WindowGroup</td> |
---|
85 | </tr> |
---|
86 | <tr class="method-row expandable"> |
---|
87 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
88 | <td class="sig"> |
---|
89 | <a id="Ext.WindowGroup-each"></a> |
---|
90 | <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
91 | <div class="short">Executes the specified function once for every window in the group, passing each |
---|
92 | window as the only parameter. Return...</div> |
---|
93 | <div class="long"> |
---|
94 | Executes the specified function once for every window in the group, passing each |
---|
95 | window as the only parameter. Returning false from the function will stop the iteration. <div class="mdetail-params"> |
---|
96 | <strong>Parameters:</strong> |
---|
97 | <ul><li><code>fn</code> : Function<div class="sub-desc">The function to execute for each item</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the function</div></li> </ul> |
---|
98 | <strong>Returns:</strong> |
---|
99 | <ul> |
---|
100 | <li><code>void</code></li> |
---|
101 | </ul> |
---|
102 | </div> |
---|
103 | </div> |
---|
104 | </div> |
---|
105 | </td> |
---|
106 | <td class="msource">WindowGroup</td> |
---|
107 | </tr> |
---|
108 | <tr class="method-row alt expandable"> |
---|
109 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
110 | <td class="sig"> |
---|
111 | <a id="Ext.WindowGroup-get"></a> |
---|
112 | <b>get</b>( <code>String/Object id</code> ) : Ext.Window <div class="mdesc"> |
---|
113 | <div class="short">Gets a registered window by id.</div> |
---|
114 | <div class="long"> |
---|
115 | Gets a registered window by id. <div class="mdetail-params"> |
---|
116 | <strong>Parameters:</strong> |
---|
117 | <ul><li><code>id</code> : String/Object<div class="sub-desc">The id of the window or a <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> instance</div></li> </ul> |
---|
118 | <strong>Returns:</strong> |
---|
119 | <ul> |
---|
120 | <li><code>Ext.Window</code></li> |
---|
121 | </ul> |
---|
122 | </div> |
---|
123 | </div> |
---|
124 | </div> |
---|
125 | </td> |
---|
126 | <td class="msource">WindowGroup</td> |
---|
127 | </tr> |
---|
128 | <tr class="method-row expandable"> |
---|
129 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
130 | <td class="sig"> |
---|
131 | <a id="Ext.WindowGroup-getActive"></a> |
---|
132 | <b>getActive</b>() : Ext.Window <div class="mdesc"> |
---|
133 | <div class="short">Gets the currently-active window in the group.</div> |
---|
134 | <div class="long"> |
---|
135 | Gets the currently-active window in the group. <div class="mdetail-params"> |
---|
136 | <strong>Parameters:</strong> |
---|
137 | <ul><li>None.</li> </ul> |
---|
138 | <strong>Returns:</strong> |
---|
139 | <ul> |
---|
140 | <li><code>Ext.Window</code><div class="sub-desc">The active window</div></li> |
---|
141 | </ul> |
---|
142 | </div> |
---|
143 | </div> |
---|
144 | </div> |
---|
145 | </td> |
---|
146 | <td class="msource">WindowGroup</td> |
---|
147 | </tr> |
---|
148 | <tr class="method-row alt expandable"> |
---|
149 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
150 | <td class="sig"> |
---|
151 | <a id="Ext.WindowGroup-getBy"></a> |
---|
152 | <b>getBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Array <div class="mdesc"> |
---|
153 | <div class="short">Returns zero or more windows in the group using the custom search function passed to this method. |
---|
154 | The function should...</div> |
---|
155 | <div class="long"> |
---|
156 | Returns zero or more windows in the group using the custom search function passed to this method. |
---|
157 | The function should accept a single <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> reference as its only argument and should |
---|
158 | return true if the window matches the search criteria, otherwise it should return false. <div class="mdetail-params"> |
---|
159 | <strong>Parameters:</strong> |
---|
160 | <ul><li><code>fn</code> : Function<div class="sub-desc">The search function</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the function (defaults to the window |
---|
161 | that gets passed to the function if not specified)</div></li> </ul> |
---|
162 | <strong>Returns:</strong> |
---|
163 | <ul> |
---|
164 | <li><code>Array</code><div class="sub-desc">An array of zero or more matching windows</div></li> |
---|
165 | </ul> |
---|
166 | </div> |
---|
167 | </div> |
---|
168 | </div> |
---|
169 | </td> |
---|
170 | <td class="msource">WindowGroup</td> |
---|
171 | </tr> |
---|
172 | <tr class="method-row expandable"> |
---|
173 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
174 | <td class="sig"> |
---|
175 | <a id="Ext.WindowGroup-hideAll"></a> |
---|
176 | <b>hideAll</b>() : void <div class="mdesc"> |
---|
177 | <div class="short">Hides all windows in the group.</div> |
---|
178 | <div class="long"> |
---|
179 | Hides all windows in the group. <div class="mdetail-params"> |
---|
180 | <strong>Parameters:</strong> |
---|
181 | <ul><li>None.</li> </ul> |
---|
182 | <strong>Returns:</strong> |
---|
183 | <ul> |
---|
184 | <li><code>void</code></li> |
---|
185 | </ul> |
---|
186 | </div> |
---|
187 | </div> |
---|
188 | </div> |
---|
189 | </td> |
---|
190 | <td class="msource">WindowGroup</td> |
---|
191 | </tr> |
---|
192 | <tr class="method-row alt expandable"> |
---|
193 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
194 | <td class="sig"> |
---|
195 | <a id="Ext.WindowGroup-sendToBack"></a> |
---|
196 | <b>sendToBack</b>( <code>String/Object win</code> ) : Ext.Window <div class="mdesc"> |
---|
197 | <div class="short">Sends the specified window to the back of other active windows.</div> |
---|
198 | <div class="long"> |
---|
199 | Sends the specified window to the back of other active windows. <div class="mdetail-params"> |
---|
200 | <strong>Parameters:</strong> |
---|
201 | <ul><li><code>win</code> : String/Object<div class="sub-desc">The id of the window or a <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> instance</div></li> </ul> |
---|
202 | <strong>Returns:</strong> |
---|
203 | <ul> |
---|
204 | <li><code>Ext.Window</code><div class="sub-desc">The window</div></li> |
---|
205 | </ul> |
---|
206 | </div> |
---|
207 | </div> |
---|
208 | </div> |
---|
209 | </td> |
---|
210 | <td class="msource">WindowGroup</td> |
---|
211 | </tr> |
---|
212 | </table> |
---|
213 | <a id="Ext.WindowGroup-events"></a> |
---|
214 | <h2>Public Events</h2> |
---|
215 | <div class="no-members">This class has no public events.</div> |
---|
216 | </div> |
---|