6e1d0002c0dc69746363ebbcdf3f79f4d84f9063.svn-base 11 KB

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