docs/output/Ext.WindowGroup.html

   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">\r
  30         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  31         <td class="sig">\r
  32         <a id="Ext.WindowGroup-zseed"></a>\r
  33             <b>zseed</b> : Number            <div class="mdesc">\r
  34                             The starting z-index for windows (defaults to 9000)                        </div>\r
  35         </td>\r
  36         <td class="msource">WindowGroup</td>\r
  37     </tr>\r
  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">\r
  47         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  48         <td class="sig">\r
  49         <a id="Ext.WindowGroup-WindowGroup"></a>\r
  50             <b>WindowGroup</b>()            <div class="mdesc">\r
  51                         <div class="short"></div>\r
  52             <div class="long">\r
  53                     <div class="mdetail-params">\r
  54         <strong>Parameters:</strong>\r
  55         <ul><li>None.</li>        </ul>\r
  56         <strong>Returns:</strong>\r
  57         <ul>\r
  58             <li><code></code></li>\r
  59         </ul>\r
  60     </div>\r
  61                 </div>\r
  62                         </div>\r
  63         </td>\r
  64         <td class="msource">WindowGroup</td>\r
  65     </tr>\r
  66         <tr class="method-row alt expandable">\r
  67         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  68         <td class="sig">\r
  69         <a id="Ext.WindowGroup-bringToFront"></a>\r
  70             <b>bringToFront</b>(&nbsp;<code>String/Object win</code>&nbsp;) : Boolean            <div class="mdesc">\r
  71                         <div class="short">Brings the specified window to the front of any other active windows.</div>\r
  72             <div class="long">\r
  73                 Brings the specified window to the front of any other active windows.    <div class="mdetail-params">\r
  74         <strong>Parameters:</strong>\r
  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>\r
  76         <strong>Returns:</strong>\r
  77         <ul>\r
  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>\r
  79         </ul>\r
  80     </div>\r
  81                 </div>\r
  82                         </div>\r
  83         </td>\r
  84         <td class="msource">WindowGroup</td>\r
  85     </tr>\r
  86         <tr class="method-row expandable">\r
  87         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  88         <td class="sig">\r
  89         <a id="Ext.WindowGroup-each"></a>\r
  90             <b>each</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
  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>\r
  93             <div class="long">\r
  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">\r
  96         <strong>Parameters:</strong>\r
  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>\r
  98         <strong>Returns:</strong>\r
  99         <ul>\r
 100             <li><code>void</code></li>\r
 101         </ul>\r
 102     </div>\r
 103                 </div>\r
 104                         </div>\r
 105         </td>\r
 106         <td class="msource">WindowGroup</td>\r
 107     </tr>\r
 108         <tr class="method-row alt expandable">\r
 109         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 110         <td class="sig">\r
 111         <a id="Ext.WindowGroup-get"></a>\r
 112             <b>get</b>(&nbsp;<code>String/Object id</code>&nbsp;) : Ext.Window            <div class="mdesc">\r
 113                         <div class="short">Gets a registered window by id.</div>\r
 114             <div class="long">\r
 115                 Gets a registered window by id.    <div class="mdetail-params">\r
 116         <strong>Parameters:</strong>\r
 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>\r
 118         <strong>Returns:</strong>\r
 119         <ul>\r
 120             <li><code>Ext.Window</code></li>\r
 121         </ul>\r
 122     </div>\r
 123                 </div>\r
 124                         </div>\r
 125         </td>\r
 126         <td class="msource">WindowGroup</td>\r
 127     </tr>\r
 128         <tr class="method-row expandable">\r
 129         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 130         <td class="sig">\r
 131         <a id="Ext.WindowGroup-getActive"></a>\r
 132             <b>getActive</b>() : Ext.Window            <div class="mdesc">\r
 133                         <div class="short">Gets the currently-active window in the group.</div>\r
 134             <div class="long">\r
 135                 Gets the currently-active window in the group.    <div class="mdetail-params">\r
 136         <strong>Parameters:</strong>\r
 137         <ul><li>None.</li>        </ul>\r
 138         <strong>Returns:</strong>\r
 139         <ul>\r
 140             <li><code>Ext.Window</code><div class="sub-desc">The active window</div></li>\r
 141         </ul>\r
 142     </div>\r
 143                 </div>\r
 144                         </div>\r
 145         </td>\r
 146         <td class="msource">WindowGroup</td>\r
 147     </tr>\r
 148         <tr class="method-row alt expandable">\r
 149         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 150         <td class="sig">\r
 151         <a id="Ext.WindowGroup-getBy"></a>\r
 152             <b>getBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : Array            <div class="mdesc">\r
 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>\r
 155             <div class="long">\r
 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">\r
 159         <strong>Parameters:</strong>\r
 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>\r
 162         <strong>Returns:</strong>\r
 163         <ul>\r
 164             <li><code>Array</code><div class="sub-desc">An array of zero or more matching windows</div></li>\r
 165         </ul>\r
 166     </div>\r
 167                 </div>\r
 168                         </div>\r
 169         </td>\r
 170         <td class="msource">WindowGroup</td>\r
 171     </tr>\r
 172         <tr class="method-row expandable">\r
 173         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 174         <td class="sig">\r
 175         <a id="Ext.WindowGroup-hideAll"></a>\r
 176             <b>hideAll</b>() : void            <div class="mdesc">\r
 177                         <div class="short">Hides all windows in the group.</div>\r
 178             <div class="long">\r
 179                 Hides all windows in the group.    <div class="mdetail-params">\r
 180         <strong>Parameters:</strong>\r
 181         <ul><li>None.</li>        </ul>\r
 182         <strong>Returns:</strong>\r
 183         <ul>\r
 184             <li><code>void</code></li>\r
 185         </ul>\r
 186     </div>\r
 187                 </div>\r
 188                         </div>\r
 189         </td>\r
 190         <td class="msource">WindowGroup</td>\r
 191     </tr>\r
 192         <tr class="method-row alt expandable">\r
 193         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 194         <td class="sig">\r
 195         <a id="Ext.WindowGroup-sendToBack"></a>\r
 196             <b>sendToBack</b>(&nbsp;<code>String/Object win</code>&nbsp;) : Ext.Window            <div class="mdesc">\r
 197                         <div class="short">Sends the specified window to the back of other active windows.</div>\r
 198             <div class="long">\r
 199                 Sends the specified window to the back of other active windows.    <div class="mdetail-params">\r
 200         <strong>Parameters:</strong>\r
 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>\r
 202         <strong>Returns:</strong>\r
 203         <ul>\r
 204             <li><code>Ext.Window</code><div class="sub-desc">The window</div></li>\r
 205         </ul>\r
 206     </div>\r
 207                 </div>\r
 208                         </div>\r
 209         </td>\r
 210         <td class="msource">WindowGroup</td>\r
 211     </tr>\r
 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>