- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.WindowGroup-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.WindowGroup-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.WindowGroup-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.WindowGroup"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.WindowGroup</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/WindowManager.js" target="_blank">WindowManager.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">WindowGroup</td></tr>
- <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.WindowMgr" href="output/Ext.WindowMgr.html">WindowMgr</a></td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- *
-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
-and window activation behavior. </div>
-
- <div class="hr"></div>
- <a id="Ext.WindowGroup-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-zseed"></a>\r
- <b>zseed</b> : Number <div class="mdesc">\r
- The starting z-index for windows (defaults to 9000) </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- </table>
- <a id="Ext.WindowGroup-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-WindowGroup"></a>\r
- <b>WindowGroup</b>() <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-bringToFront"></a>\r
- <b>bringToFront</b>( <code>String/Object win</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Brings the specified window to the front of any other active windows.</div>\r
- <div class="long">\r
- Brings the specified window to the front of any other active windows. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <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>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-each"></a>\r
- <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Executes the specified function once for every window in the group, passing each
-window as the only parameter. Return...</div>\r
- <div class="long">\r
- Executes the specified function once for every window in the group, passing each
-window as the only parameter. Returning false from the function will stop the iteration. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-get"></a>\r
- <b>get</b>( <code>String/Object id</code> ) : Ext.Window <div class="mdesc">\r
- <div class="short">Gets a registered window by id.</div>\r
- <div class="long">\r
- Gets a registered window by id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Window</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-getActive"></a>\r
- <b>getActive</b>() : Ext.Window <div class="mdesc">\r
- <div class="short">Gets the currently-active window in the group.</div>\r
- <div class="long">\r
- Gets the currently-active window in the group. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Window</code><div class="sub-desc">The active window</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-getBy"></a>\r
- <b>getBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Returns zero or more windows in the group using the custom search function passed to this method.
-The function should...</div>\r
- <div class="long">\r
- Returns zero or more windows in the group using the custom search function passed to this method.
-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
-return true if the window matches the search criteria, otherwise it should return false. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
-that gets passed to the function if not specified)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">An array of zero or more matching windows</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-hideAll"></a>\r
- <b>hideAll</b>() : void <div class="mdesc">\r
- <div class="short">Hides all windows in the group.</div>\r
- <div class="long">\r
- Hides all windows in the group. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.WindowGroup-sendToBack"></a>\r
- <b>sendToBack</b>( <code>String/Object win</code> ) : Ext.Window <div class="mdesc">\r
- <div class="short">Sends the specified window to the back of other active windows.</div>\r
- <div class="long">\r
- Sends the specified window to the back of other active windows. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Window</code><div class="sub-desc">The window</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">WindowGroup</td>\r
- </tr>\r
- </table>
- <a id="Ext.WindowGroup-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.WindowGroup-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.WindowGroup-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.WindowGroup-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="bookmark" href="../docs/?class=Ext.WindowGroup"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><h1>Class <a href="source/WindowManager.html#cls-Ext.WindowGroup">Ext.WindowGroup</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/WindowManager.html#cls-Ext.WindowGroup">WindowManager.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/WindowManager.html#cls-Ext.WindowGroup">WindowGroup</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.WindowMgr.html" ext:cls="Ext.WindowMgr">WindowMgr</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">An object that manages a group of <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> instances and provides z-order management
+and window activation behavior.</div><div class="hr"></div><a id="Ext.WindowGroup-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-zseed"></a><b><a href="source/WindowManager.html#prop-Ext.WindowGroup-zseed">zseed</a></b> : Number The z-index value<div class="mdesc">The starting z-index for windows in this WindowGroup (defaults to 9000)</div></td><td class="msource">WindowGroup</td></tr></tbody></table><a id="Ext.WindowGroup-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-WindowGroup"></a><b><a href="source/WindowManager.html#cls-Ext.WindowGroup">WindowGroup</a></b>()
+ <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-bringToFront"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-bringToFront">bringToFront</a></b>( <code>String/Object win</code> )
+ :
+ Boolean<div class="mdesc"><div class="short">Brings the specified window to the front of any other active windows in this WindowGroup.</div><div class="long">Brings the specified window to the front of any other active windows in this WindowGroup.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>win</code> : String/Object<div class="sub-desc">The id of the window or a <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> instance</div></li></ul><strong>Returns:</strong><ul><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></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-each"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-each">each</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Executes the specified function once for every window in this WindowGroup, passing each
+window as the only parameter....</div><div class="long">Executes the specified function once for every window in this WindowGroup, passing each
+window as the only parameter. Returning false from the function will stop the iteration.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to the current Window in the iteration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-get"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-get">get</a></b>( <code>String/Object id</code> )
+ :
+ Ext.Window<div class="mdesc"><div class="short">Gets a registered window by id.</div><div class="long">Gets a registered window by id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String/Object<div class="sub-desc">The id of the window or a <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> instance</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Window</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-getActive"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-getActive">getActive</a></b>()
+ :
+ Ext.Window<div class="mdesc"><div class="short">Gets the currently-active window in this WindowGroup.</div><div class="long">Gets the currently-active window in this WindowGroup.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Window</code><div class="sub-desc">The active window</div></li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-getBy"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-getBy">getBy</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
+ :
+ Array<div class="mdesc"><div class="short">Returns zero or more windows in this WindowGroup using the custom search function passed to this method.
+The function...</div><div class="long">Returns zero or more windows in this WindowGroup using the custom search function passed to this method.
+The function should accept a single <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> reference as its only argument and should
+return true if the window matches the search criteria, otherwise it should return false.<div class="mdetail-params"><strong>Parameters:</strong><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 (<code>this</code> reference) in which the function is executed. Defaults to the Window being tested.
+that gets passed to the function if not specified)</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">An array of zero or more matching windows</div></li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-hideAll"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-hideAll">hideAll</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Hides all windows in this WindowGroup.</div><div class="long">Hides all windows in this WindowGroup.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-register"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-register">register</a></b>( <code>Window win</code> )
+ :
+ void<div class="mdesc"><div class="short">Registers a Window with this WindowManager. This should not
+need to be called under normal circumstances. Windows are...</div><div class="long"><p>Registers a <a href="output/Ext.Window.html" ext:cls="Ext.Window">Window</a> with this WindowManager. This should not
+need to be called under normal circumstances. Windows are automatically registered
+with a <a href="output/Ext.Window.html#Ext.Window-manager" ext:member="manager" ext:cls="Ext.Window">manager</a> at construction time.</p>
+<p>Where this may be useful is moving Windows between two WindowManagers. For example,
+to bring the Ext.MessageBox dialog under the same manager as the Desktop's
+WindowManager in the desktop sample app:</p><code><pre>
+<b>var</b> msgWin = Ext.MessageBox.getDialog();
+MyDesktop.getDesktop().getManager().register(msgWin);
+</pre></code><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>win</code> : Window<div class="sub-desc">The Window to register.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-sendToBack"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-sendToBack">sendToBack</a></b>( <code>String/Object win</code> )
+ :
+ Ext.Window<div class="mdesc"><div class="short">Sends the specified window to the back of other active windows in this WindowGroup.</div><div class="long">Sends the specified window to the back of other active windows in this WindowGroup.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>win</code> : String/Object<div class="sub-desc">The id of the window or a <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> instance</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Window</code><div class="sub-desc">The window</div></li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.WindowGroup-unregister"></a><b><a href="source/WindowManager.html#method-Ext.WindowGroup-unregister">unregister</a></b>( <code>Window win</code> )
+ :
+ void<div class="mdesc"><div class="short">Unregisters a Window from this WindowManager. This should not
+need to be called. Windows are automatically unregister...</div><div class="long"><p>Unregisters a <a href="output/Ext.Window.html" ext:cls="Ext.Window">Window</a> from this WindowManager. This should not
+need to be called. Windows are automatically unregistered upon destruction.
+See <a href="output/Ext.WindowGroup.html#Ext.WindowGroup-register" ext:member="register" ext:cls="Ext.WindowGroup">register</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>win</code> : Window<div class="sub-desc">The Window to unregister.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">WindowGroup</td></tr></tbody></table><a id="Ext.WindowGroup-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff