docs/output/Ext.WindowMgr.html

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