[619] | 1 | <div class="body-wrap"> |
---|
| 2 | <div class="top-tools"> |
---|
| 3 | <a class="inner-link" href="#Ext.tree.MultiSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
| 4 | <a class="inner-link" href="#Ext.tree.MultiSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
| 5 | <a class="inner-link" href="#Ext.tree.MultiSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
| 6 | <a class="inner-link" href="#Ext.tree.MultiSelectionModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
---|
| 7 | <a class="bookmark" href="../docs/?class=Ext.tree.MultiSelectionModel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
| 8 | </div> |
---|
| 9 | <div class="inheritance res-block"> |
---|
| 10 | <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a> |
---|
| 11 | <img src="resources/elbow-end.gif"/>MultiSelectionModel</pre></div> |
---|
| 12 | <h1>Class Ext.tree.MultiSelectionModel</h1> |
---|
| 13 | <table cellspacing="0"> |
---|
| 14 | <tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr> |
---|
| 15 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/TreeSelectionModel.js" target="_blank">TreeSelectionModel.js</a></td></tr> |
---|
| 16 | <tr><td class="label">Class:</td><td class="hd-info">MultiSelectionModel</td></tr> |
---|
| 17 | <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr> |
---|
| 18 | </table> |
---|
| 19 | <div class="description"> |
---|
| 20 | Multi selection for a TreePanel. </div> |
---|
| 21 | |
---|
| 22 | <div class="hr"></div> |
---|
| 23 | <a id="Ext.tree.MultiSelectionModel-configs"></a> |
---|
| 24 | <h2>Config Options</h2> |
---|
| 25 | <table cellspacing="0" class="member-table"> |
---|
| 26 | <tr> |
---|
| 27 | <th class="sig-header" colspan="2">Config Options</th> |
---|
| 28 | <th class="msource-header">Defined By</th> |
---|
| 29 | </tr> |
---|
| 30 | <tr class="config-row inherited expandable"> |
---|
| 31 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 32 | <td class="sig"> |
---|
| 33 | <a id="Ext.tree.MultiSelectionModel-listeners"></a> |
---|
| 34 | <b>listeners</b> : Object <div class="mdesc"> |
---|
| 35 | <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div> |
---|
| 36 | <div class="long"> |
---|
| 37 | (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div> |
---|
| 38 | </div> |
---|
| 39 | </td> |
---|
| 40 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td> |
---|
| 41 | </tr> |
---|
| 42 | </table> |
---|
| 43 | <a id="Ext.tree.MultiSelectionModel-props"></a> |
---|
| 44 | <h2>Public Properties</h2> |
---|
| 45 | <div class="no-members">This class has no public properties.</div> <a id="Ext.tree.MultiSelectionModel-methods"></a> |
---|
| 46 | <h2>Public Methods</h2> |
---|
| 47 | <table cellspacing="0" class="member-table"> |
---|
| 48 | <tr> |
---|
| 49 | <th class="sig-header" colspan="2">Method</th> |
---|
| 50 | <th class="msource-header">Defined By</th> |
---|
| 51 | </tr> |
---|
| 52 | <tr class="method-row inherited expandable"> |
---|
| 53 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 54 | <td class="sig"> |
---|
| 55 | <a id="Ext.tree.MultiSelectionModel-addEvents"></a> |
---|
| 56 | <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc"> |
---|
| 57 | <div class="short">Used to define events on this Observable</div> |
---|
| 58 | <div class="long"> |
---|
| 59 | Used to define events on this Observable <div class="mdetail-params"> |
---|
| 60 | <strong>Parameters:</strong> |
---|
| 61 | <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul> |
---|
| 62 | <strong>Returns:</strong> |
---|
| 63 | <ul> |
---|
| 64 | <li><code>void</code></li> |
---|
| 65 | </ul> |
---|
| 66 | </div> |
---|
| 67 | </div> |
---|
| 68 | </div> |
---|
| 69 | </td> |
---|
| 70 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td> |
---|
| 71 | </tr> |
---|
| 72 | <tr class="method-row inherited alt expandable"> |
---|
| 73 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 74 | <td class="sig"> |
---|
| 75 | <a id="Ext.tree.MultiSelectionModel-addListener"></a> |
---|
| 76 | <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
| 77 | <div class="short">Appends an event handler to this component</div> |
---|
| 78 | <div class="long"> |
---|
| 79 | Appends an event handler to this component <div class="mdetail-params"> |
---|
| 80 | <strong>Parameters:</strong> |
---|
| 81 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler |
---|
| 82 | function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration |
---|
| 83 | properties. This may contain any of the following properties:<ul> |
---|
| 84 | <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li> |
---|
| 85 | <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li> |
---|
| 86 | <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li> |
---|
| 87 | <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed |
---|
| 88 | by the specified number of milliseconds. If the event fires again within that time, the original |
---|
| 89 | handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li> |
---|
| 90 | </ul><br> |
---|
| 91 | <p> |
---|
| 92 | <b>Combining Options</b><br> |
---|
| 93 | Using the options argument, it is possible to combine different types of listeners:<br> |
---|
| 94 | <br> |
---|
| 95 | A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) |
---|
| 96 | <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, { |
---|
| 97 | single: true, |
---|
| 98 | delay: 100, |
---|
| 99 | forumId: 4 |
---|
| 100 | });</code></pre> |
---|
| 101 | <p> |
---|
| 102 | <b>Attaching multiple handlers in 1 call</b><br> |
---|
| 103 | The method also allows for a single argument to be passed which is a config object containing properties |
---|
| 104 | which specify multiple handlers. |
---|
| 105 | <p> |
---|
| 106 | <pre><code>foo.on({ |
---|
| 107 | <em>'click'</em> : { |
---|
| 108 | fn: <b>this</b>.onClick, |
---|
| 109 | scope: <b>this</b>, |
---|
| 110 | delay: 100 |
---|
| 111 | }, |
---|
| 112 | <em>'mouseover'</em> : { |
---|
| 113 | fn: <b>this</b>.onMouseOver, |
---|
| 114 | scope: <b>this</b> |
---|
| 115 | }, |
---|
| 116 | <em>'mouseout'</em> : { |
---|
| 117 | fn: <b>this</b>.onMouseOut, |
---|
| 118 | scope: <b>this</b> |
---|
| 119 | } |
---|
| 120 | });</code></pre> |
---|
| 121 | <p> |
---|
| 122 | Or a shorthand syntax:<br> |
---|
| 123 | <pre><code>foo.on({ |
---|
| 124 | <em>'click'</em> : <b>this</b>.onClick, |
---|
| 125 | <em>'mouseover'</em> : <b>this</b>.onMouseOver, |
---|
| 126 | <em>'mouseout'</em> : <b>this</b>.onMouseOut, |
---|
| 127 | scope: <b>this</b> |
---|
| 128 | });</code></pre></div></li> </ul> |
---|
| 129 | <strong>Returns:</strong> |
---|
| 130 | <ul> |
---|
| 131 | <li><code>void</code></li> |
---|
| 132 | </ul> |
---|
| 133 | </div> |
---|
| 134 | </div> |
---|
| 135 | </div> |
---|
| 136 | </td> |
---|
| 137 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td> |
---|
| 138 | </tr> |
---|
| 139 | <tr class="method-row expandable"> |
---|
| 140 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 141 | <td class="sig"> |
---|
| 142 | <a id="Ext.tree.MultiSelectionModel-clearSelections"></a> |
---|
| 143 | <b>clearSelections</b>() : void <div class="mdesc"> |
---|
| 144 | <div class="short">Clear all selections</div> |
---|
| 145 | <div class="long"> |
---|
| 146 | Clear all selections <div class="mdetail-params"> |
---|
| 147 | <strong>Parameters:</strong> |
---|
| 148 | <ul><li>None.</li> </ul> |
---|
| 149 | <strong>Returns:</strong> |
---|
| 150 | <ul> |
---|
| 151 | <li><code>void</code></li> |
---|
| 152 | </ul> |
---|
| 153 | </div> |
---|
| 154 | </div> |
---|
| 155 | </div> |
---|
| 156 | </td> |
---|
| 157 | <td class="msource">MultiSelectionModel</td> |
---|
| 158 | </tr> |
---|
| 159 | <tr class="method-row inherited alt expandable"> |
---|
| 160 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 161 | <td class="sig"> |
---|
| 162 | <a id="Ext.tree.MultiSelectionModel-fireEvent"></a> |
---|
| 163 | <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc"> |
---|
| 164 | <div class="short">Fires the specified event with the passed parameters (minus the event name).</div> |
---|
| 165 | <div class="long"> |
---|
| 166 | Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params"> |
---|
| 167 | <strong>Parameters:</strong> |
---|
| 168 | <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul> |
---|
| 169 | <strong>Returns:</strong> |
---|
| 170 | <ul> |
---|
| 171 | <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li> |
---|
| 172 | </ul> |
---|
| 173 | </div> |
---|
| 174 | </div> |
---|
| 175 | </div> |
---|
| 176 | </td> |
---|
| 177 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td> |
---|
| 178 | </tr> |
---|
| 179 | <tr class="method-row expandable"> |
---|
| 180 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 181 | <td class="sig"> |
---|
| 182 | <a id="Ext.tree.MultiSelectionModel-getSelectedNodes"></a> |
---|
| 183 | <b>getSelectedNodes</b>() : Array <div class="mdesc"> |
---|
| 184 | <div class="short">Returns an array of the selected nodes</div> |
---|
| 185 | <div class="long"> |
---|
| 186 | Returns an array of the selected nodes <div class="mdetail-params"> |
---|
| 187 | <strong>Parameters:</strong> |
---|
| 188 | <ul><li>None.</li> </ul> |
---|
| 189 | <strong>Returns:</strong> |
---|
| 190 | <ul> |
---|
| 191 | <li><code>Array</code></li> |
---|
| 192 | </ul> |
---|
| 193 | </div> |
---|
| 194 | </div> |
---|
| 195 | </div> |
---|
| 196 | </td> |
---|
| 197 | <td class="msource">MultiSelectionModel</td> |
---|
| 198 | </tr> |
---|
| 199 | <tr class="method-row inherited alt expandable"> |
---|
| 200 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 201 | <td class="sig"> |
---|
| 202 | <a id="Ext.tree.MultiSelectionModel-hasListener"></a> |
---|
| 203 | <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc"> |
---|
| 204 | <div class="short">Checks to see if this object has any listeners for a specified event</div> |
---|
| 205 | <div class="long"> |
---|
| 206 | Checks to see if this object has any listeners for a specified event <div class="mdetail-params"> |
---|
| 207 | <strong>Parameters:</strong> |
---|
| 208 | <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul> |
---|
| 209 | <strong>Returns:</strong> |
---|
| 210 | <ul> |
---|
| 211 | <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li> |
---|
| 212 | </ul> |
---|
| 213 | </div> |
---|
| 214 | </div> |
---|
| 215 | </div> |
---|
| 216 | </td> |
---|
| 217 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td> |
---|
| 218 | </tr> |
---|
| 219 | <tr class="method-row expandable"> |
---|
| 220 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 221 | <td class="sig"> |
---|
| 222 | <a id="Ext.tree.MultiSelectionModel-isSelected"></a> |
---|
| 223 | <b>isSelected</b>( <code>TreeNode node</code> ) : Boolean <div class="mdesc"> |
---|
| 224 | <div class="short">Returns true if the node is selected</div> |
---|
| 225 | <div class="long"> |
---|
| 226 | Returns true if the node is selected <div class="mdetail-params"> |
---|
| 227 | <strong>Parameters:</strong> |
---|
| 228 | <ul><li><code>node</code> : TreeNode<div class="sub-desc">The node to check</div></li> </ul> |
---|
| 229 | <strong>Returns:</strong> |
---|
| 230 | <ul> |
---|
| 231 | <li><code>Boolean</code></li> |
---|
| 232 | </ul> |
---|
| 233 | </div> |
---|
| 234 | </div> |
---|
| 235 | </div> |
---|
| 236 | </td> |
---|
| 237 | <td class="msource">MultiSelectionModel</td> |
---|
| 238 | </tr> |
---|
| 239 | <tr class="method-row inherited alt expandable"> |
---|
| 240 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 241 | <td class="sig"> |
---|
| 242 | <a id="Ext.tree.MultiSelectionModel-on"></a> |
---|
| 243 | <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
| 244 | <div class="short">Appends an event handler to this element (shorthand for addListener)</div> |
---|
| 245 | <div class="long"> |
---|
| 246 | Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params"> |
---|
| 247 | <strong>Parameters:</strong> |
---|
| 248 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler |
---|
| 249 | function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul> |
---|
| 250 | <strong>Returns:</strong> |
---|
| 251 | <ul> |
---|
| 252 | <li><code>void</code></li> |
---|
| 253 | </ul> |
---|
| 254 | </div> |
---|
| 255 | </div> |
---|
| 256 | </div> |
---|
| 257 | </td> |
---|
| 258 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td> |
---|
| 259 | </tr> |
---|
| 260 | <tr class="method-row inherited expandable"> |
---|
| 261 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 262 | <td class="sig"> |
---|
| 263 | <a id="Ext.tree.MultiSelectionModel-purgeListeners"></a> |
---|
| 264 | <b>purgeListeners</b>() : void <div class="mdesc"> |
---|
| 265 | <div class="short">Removes all listeners for this object</div> |
---|
| 266 | <div class="long"> |
---|
| 267 | Removes all listeners for this object <div class="mdetail-params"> |
---|
| 268 | <strong>Parameters:</strong> |
---|
| 269 | <ul><li>None.</li> </ul> |
---|
| 270 | <strong>Returns:</strong> |
---|
| 271 | <ul> |
---|
| 272 | <li><code>void</code></li> |
---|
| 273 | </ul> |
---|
| 274 | </div> |
---|
| 275 | </div> |
---|
| 276 | </div> |
---|
| 277 | </td> |
---|
| 278 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td> |
---|
| 279 | </tr> |
---|
| 280 | <tr class="method-row inherited alt expandable"> |
---|
| 281 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 282 | <td class="sig"> |
---|
| 283 | <a id="Ext.tree.MultiSelectionModel-relayEvents"></a> |
---|
| 284 | <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc"> |
---|
| 285 | <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div> |
---|
| 286 | <div class="long"> |
---|
| 287 | Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params"> |
---|
| 288 | <strong>Parameters:</strong> |
---|
| 289 | <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul> |
---|
| 290 | <strong>Returns:</strong> |
---|
| 291 | <ul> |
---|
| 292 | <li><code>void</code></li> |
---|
| 293 | </ul> |
---|
| 294 | </div> |
---|
| 295 | </div> |
---|
| 296 | </div> |
---|
| 297 | </td> |
---|
| 298 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td> |
---|
| 299 | </tr> |
---|
| 300 | <tr class="method-row inherited expandable"> |
---|
| 301 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 302 | <td class="sig"> |
---|
| 303 | <a id="Ext.tree.MultiSelectionModel-removeListener"></a> |
---|
| 304 | <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
| 305 | <div class="short">Removes a listener</div> |
---|
| 306 | <div class="long"> |
---|
| 307 | Removes a listener <div class="mdetail-params"> |
---|
| 308 | <strong>Parameters:</strong> |
---|
| 309 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul> |
---|
| 310 | <strong>Returns:</strong> |
---|
| 311 | <ul> |
---|
| 312 | <li><code>void</code></li> |
---|
| 313 | </ul> |
---|
| 314 | </div> |
---|
| 315 | </div> |
---|
| 316 | </div> |
---|
| 317 | </td> |
---|
| 318 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td> |
---|
| 319 | </tr> |
---|
| 320 | <tr class="method-row inherited alt expandable"> |
---|
| 321 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 322 | <td class="sig"> |
---|
| 323 | <a id="Ext.tree.MultiSelectionModel-resumeEvents"></a> |
---|
| 324 | <b>resumeEvents</b>() : void <div class="mdesc"> |
---|
| 325 | <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div> |
---|
| 326 | <div class="long"> |
---|
| 327 | Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params"> |
---|
| 328 | <strong>Parameters:</strong> |
---|
| 329 | <ul><li>None.</li> </ul> |
---|
| 330 | <strong>Returns:</strong> |
---|
| 331 | <ul> |
---|
| 332 | <li><code>void</code></li> |
---|
| 333 | </ul> |
---|
| 334 | </div> |
---|
| 335 | </div> |
---|
| 336 | </div> |
---|
| 337 | </td> |
---|
| 338 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td> |
---|
| 339 | </tr> |
---|
| 340 | <tr class="method-row expandable"> |
---|
| 341 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 342 | <td class="sig"> |
---|
| 343 | <a id="Ext.tree.MultiSelectionModel-select"></a> |
---|
| 344 | <b>select</b>( <code>TreeNode node</code>, <span class="optional" title="Optional">[<code>EventObject e</code>]</span>, <code>Boolean keepExisting</code> ) : TreeNode <div class="mdesc"> |
---|
| 345 | <div class="short">Select a node.</div> |
---|
| 346 | <div class="long"> |
---|
| 347 | Select a node. <div class="mdetail-params"> |
---|
| 348 | <strong>Parameters:</strong> |
---|
| 349 | <ul><li><code>node</code> : TreeNode<div class="sub-desc">The node to select</div></li><li><code>e</code> : EventObject<div class="sub-desc">(optional) An event associated with the selection</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">True to retain existing selections</div></li> </ul> |
---|
| 350 | <strong>Returns:</strong> |
---|
| 351 | <ul> |
---|
| 352 | <li><code>TreeNode</code><div class="sub-desc">The selected node</div></li> |
---|
| 353 | </ul> |
---|
| 354 | </div> |
---|
| 355 | </div> |
---|
| 356 | </div> |
---|
| 357 | </td> |
---|
| 358 | <td class="msource">MultiSelectionModel</td> |
---|
| 359 | </tr> |
---|
| 360 | <tr class="method-row inherited alt expandable"> |
---|
| 361 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 362 | <td class="sig"> |
---|
| 363 | <a id="Ext.tree.MultiSelectionModel-suspendEvents"></a> |
---|
| 364 | <b>suspendEvents</b>() : void <div class="mdesc"> |
---|
| 365 | <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div> |
---|
| 366 | <div class="long"> |
---|
| 367 | Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params"> |
---|
| 368 | <strong>Parameters:</strong> |
---|
| 369 | <ul><li>None.</li> </ul> |
---|
| 370 | <strong>Returns:</strong> |
---|
| 371 | <ul> |
---|
| 372 | <li><code>void</code></li> |
---|
| 373 | </ul> |
---|
| 374 | </div> |
---|
| 375 | </div> |
---|
| 376 | </div> |
---|
| 377 | </td> |
---|
| 378 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td> |
---|
| 379 | </tr> |
---|
| 380 | <tr class="method-row inherited expandable"> |
---|
| 381 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 382 | <td class="sig"> |
---|
| 383 | <a id="Ext.tree.MultiSelectionModel-un"></a> |
---|
| 384 | <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
| 385 | <div class="short">Removes a listener (shorthand for removeListener)</div> |
---|
| 386 | <div class="long"> |
---|
| 387 | Removes a listener (shorthand for removeListener) <div class="mdetail-params"> |
---|
| 388 | <strong>Parameters:</strong> |
---|
| 389 | <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul> |
---|
| 390 | <strong>Returns:</strong> |
---|
| 391 | <ul> |
---|
| 392 | <li><code>void</code></li> |
---|
| 393 | </ul> |
---|
| 394 | </div> |
---|
| 395 | </div> |
---|
| 396 | </div> |
---|
| 397 | </td> |
---|
| 398 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td> |
---|
| 399 | </tr> |
---|
| 400 | <tr class="method-row alt expandable"> |
---|
| 401 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 402 | <td class="sig"> |
---|
| 403 | <a id="Ext.tree.MultiSelectionModel-unselect"></a> |
---|
| 404 | <b>unselect</b>( <code>TreeNode node</code> ) : void <div class="mdesc"> |
---|
| 405 | <div class="short">Deselect a node.</div> |
---|
| 406 | <div class="long"> |
---|
| 407 | Deselect a node. <div class="mdetail-params"> |
---|
| 408 | <strong>Parameters:</strong> |
---|
| 409 | <ul><li><code>node</code> : TreeNode<div class="sub-desc">The node to unselect</div></li> </ul> |
---|
| 410 | <strong>Returns:</strong> |
---|
| 411 | <ul> |
---|
| 412 | <li><code>void</code></li> |
---|
| 413 | </ul> |
---|
| 414 | </div> |
---|
| 415 | </div> |
---|
| 416 | </div> |
---|
| 417 | </td> |
---|
| 418 | <td class="msource">MultiSelectionModel</td> |
---|
| 419 | </tr> |
---|
| 420 | </table> |
---|
| 421 | <a id="Ext.tree.MultiSelectionModel-events"></a> |
---|
| 422 | <h2>Public Events</h2> |
---|
| 423 | <table cellspacing="0" class="member-table"> |
---|
| 424 | <tr> |
---|
| 425 | <th class="sig-header" colspan="2">Event</th> |
---|
| 426 | <th class="msource-header">Defined By</th> |
---|
| 427 | </tr> |
---|
| 428 | <tr class="event-row expandable"> |
---|
| 429 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 430 | <td class="sig"> |
---|
| 431 | <a id="Ext.tree.MultiSelectionModel-selectionchange"></a> |
---|
| 432 | <b>selectionchange</b> : ( <code>MultiSelectionModel this</code>, <code>Array nodes</code> ) <div class="mdesc"> |
---|
| 433 | <div class="short">Fires when the selected nodes change</div> |
---|
| 434 | <div class="long"> |
---|
| 435 | Fires when the selected nodes change <div class="mdetail-params"> |
---|
| 436 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 437 | <ul><li><code>this</code> : MultiSelectionModel<div class="sub-desc"></div></li><li><code>nodes</code> : Array<div class="sub-desc">Array of the selected nodes</div></li> </ul> |
---|
| 438 | </div> |
---|
| 439 | </div> |
---|
| 440 | </div> |
---|
| 441 | </td> |
---|
| 442 | <td class="msource">MultiSelectionModel</td> |
---|
| 443 | </tr> |
---|
| 444 | </table> |
---|
| 445 | |
---|
| 446 | </div> |
---|