git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.tree.MultiSelectionModel.json

   1 {
   2   "name" : "Roo.tree.MultiSelectionModel",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "Multi selection for a TreePanel.",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11     {
  12       "name" : "listeners",
  13       "type" : "Object",
  14       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  15       "memberOf" : "Roo.util.Observable",
  16       "values" : [
  17       ]
  18     }
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "getSelectedNodes",
  23       "desc" : "Returns an array of the selected nodes",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.tree.MultiSelectionModel",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33       ],
  34       "returns" : [
  35         {
  36           "name" : "",
  37           "type" : "Array",
  38           "desc" : ""
  39         }
  40       ]
  41     },
  42     {
  43       "name" : "clearSelections",
  44       "desc" : "Clear all selections",
  45       "isStatic" : false,
  46       "isConstructor" : false,
  47       "isPrivate" : false,
  48       "memberOf" : "Roo.tree.MultiSelectionModel",
  49       "example" : "",
  50       "deprecated" : "",
  51       "since" : "",
  52       "see" : "",
  53       "params" : [
  54       ],
  55       "returns" : [
  56       ]
  57     },
  58     {
  59       "name" : "isSelected",
  60       "desc" : "Returns true if the node is selected",
  61       "isStatic" : false,
  62       "isConstructor" : false,
  63       "isPrivate" : false,
  64       "memberOf" : "Roo.tree.MultiSelectionModel",
  65       "example" : "",
  66       "deprecated" : "",
  67       "since" : "",
  68       "see" : "",
  69       "params" : [
  70         {
  71           "name" : "node",
  72           "type" : "TreeNode",
  73           "desc" : "The node to check",
  74           "isOptional" : false
  75         }
  76       ],
  77       "returns" : [
  78         {
  79           "name" : "",
  80           "type" : "Boolean",
  81           "desc" : ""
  82         }
  83       ]
  84     },
  85     {
  86       "name" : "unselect",
  87       "desc" : "Deselect a node.",
  88       "isStatic" : false,
  89       "isConstructor" : false,
  90       "isPrivate" : false,
  91       "memberOf" : "Roo.tree.MultiSelectionModel",
  92       "example" : "",
  93       "deprecated" : "",
  94       "since" : "",
  95       "see" : "",
  96       "params" : [
  97         {
  98           "name" : "node",
  99           "type" : "TreeNode",
 100           "desc" : "The node to unselect",
 101           "isOptional" : false
 102         }
 103       ],
 104       "returns" : [
 105       ]
 106     },
 107     {
 108       "name" : "select",
 109       "desc" : "Select a node.",
 110       "isStatic" : false,
 111       "isConstructor" : false,
 112       "isPrivate" : false,
 113       "memberOf" : "Roo.tree.MultiSelectionModel",
 114       "example" : "",
 115       "deprecated" : "",
 116       "since" : "",
 117       "see" : "",
 118       "params" : [
 119         {
 120           "name" : "node",
 121           "type" : "TreeNode",
 122           "desc" : "The node to select",
 123           "isOptional" : false
 124         },
 125         {
 126           "name" : "e",
 127           "type" : "EventObject",
 128           "desc" : "(optional) An event associated with the selection",
 129           "isOptional" : false
 130         },
 131         {
 132           "name" : "keepExisting",
 133           "type" : "Boolean",
 134           "desc" : "True to retain existing selections",
 135           "isOptional" : false
 136         }
 137       ],
 138       "returns" : [
 139         {
 140           "name" : "",
 141           "type" : "TreeNode",
 142           "desc" : "The selected node"
 143         }
 144       ]
 145     },
 146     {
 147       "name" : "purgeListeners",
 148       "desc" : "Removes all listeners for this object",
 149       "isStatic" : false,
 150       "isConstructor" : false,
 151       "isPrivate" : false,
 152       "memberOf" : "Roo.util.Observable",
 153       "example" : "",
 154       "deprecated" : "",
 155       "since" : "",
 156       "see" : "",
 157       "params" : [
 158       ],
 159       "returns" : [
 160       ]
 161     },
 162     {
 163       "name" : "on",
 164       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 165       "isStatic" : false,
 166       "isConstructor" : false,
 167       "isPrivate" : false,
 168       "memberOf" : "Roo.util.Observable",
 169       "example" : "",
 170       "deprecated" : "",
 171       "since" : "",
 172       "see" : "",
 173       "params" : [
 174         {
 175           "name" : "eventName",
 176           "type" : "String",
 177           "desc" : "The type of event to listen for",
 178           "isOptional" : false
 179         },
 180         {
 181           "name" : "handler",
 182           "type" : "Function",
 183           "desc" : "The method the event invokes",
 184           "isOptional" : false
 185         },
 186         {
 187           "name" : "scope",
 188           "type" : "Object",
 189           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 190           "isOptional" : false
 191         },
 192         {
 193           "name" : "options",
 194           "type" : "Object",
 195           "desc" : "(optional)",
 196           "isOptional" : false
 197         }
 198       ],
 199       "returns" : [
 200       ]
 201     },
 202     {
 203       "name" : "un",
 204       "desc" : "Removes a listener (shorthand for removeListener)",
 205       "isStatic" : false,
 206       "isConstructor" : false,
 207       "isPrivate" : false,
 208       "memberOf" : "Roo.util.Observable",
 209       "example" : "",
 210       "deprecated" : "",
 211       "since" : "",
 212       "see" : "",
 213       "params" : [
 214         {
 215           "name" : "eventName",
 216           "type" : "String",
 217           "desc" : "The type of event to listen for",
 218           "isOptional" : false
 219         },
 220         {
 221           "name" : "handler",
 222           "type" : "Function",
 223           "desc" : "The handler to remove",
 224           "isOptional" : false
 225         },
 226         {
 227           "name" : "scope",
 228           "type" : "Object",
 229           "desc" : "(optional) The scope (this object) for the handler",
 230           "isOptional" : false
 231         }
 232       ],
 233       "returns" : [
 234       ]
 235     },
 236     {
 237       "name" : "addEvents",
 238       "desc" : "Used to define events on this Observable",
 239       "isStatic" : false,
 240       "isConstructor" : false,
 241       "isPrivate" : false,
 242       "memberOf" : "Roo.util.Observable",
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "params" : [
 248         {
 249           "name" : "object",
 250           "type" : "Object",
 251           "desc" : "The object with the events defined",
 252           "isOptional" : false
 253         }
 254       ],
 255       "returns" : [
 256       ]
 257     },
 258     {
 259       "name" : "releaseCapture",
 260       "desc" : "Removes <b>all</b> added captures from the Observable.",
 261       "isStatic" : true,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "memberOf" : "Roo.util.Observable",
 265       "example" : "",
 266       "deprecated" : "",
 267       "since" : "",
 268       "see" : "",
 269       "params" : [
 270         {
 271           "name" : "o",
 272           "type" : "Observable",
 273           "desc" : "The Observable to release",
 274           "isOptional" : false
 275         }
 276       ],
 277       "returns" : [
 278       ]
 279     },
 280     {
 281       "name" : "removeListener",
 282       "desc" : "Removes a listener",
 283       "isStatic" : false,
 284       "isConstructor" : false,
 285       "isPrivate" : false,
 286       "memberOf" : "Roo.util.Observable",
 287       "example" : "",
 288       "deprecated" : "",
 289       "since" : "",
 290       "see" : "",
 291       "params" : [
 292         {
 293           "name" : "eventName",
 294           "type" : "String",
 295           "desc" : "The type of event to listen for",
 296           "isOptional" : false
 297         },
 298         {
 299           "name" : "handler",
 300           "type" : "Function",
 301           "desc" : "The handler to remove",
 302           "isOptional" : false
 303         },
 304         {
 305           "name" : "scope",
 306           "type" : "Object",
 307           "desc" : "(optional) The scope (this object) for the handler",
 308           "isOptional" : false
 309         }
 310       ],
 311       "returns" : [
 312       ]
 313     },
 314     {
 315       "name" : "fireEvent",
 316       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 317       "isStatic" : false,
 318       "isConstructor" : false,
 319       "isPrivate" : false,
 320       "memberOf" : "Roo.util.Observable",
 321       "example" : "",
 322       "deprecated" : "",
 323       "since" : "",
 324       "see" : "",
 325       "params" : [
 326         {
 327           "name" : "eventName",
 328           "type" : "String",
 329           "desc" : "",
 330           "isOptional" : false
 331         },
 332         {
 333           "name" : "args",
 334           "type" : "Object...",
 335           "desc" : "Variable number of parameters are passed to handlers",
 336           "isOptional" : false
 337         }
 338       ],
 339       "returns" : [
 340         {
 341           "name" : "",
 342           "type" : "Boolean",
 343           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 344         }
 345       ]
 346     },
 347     {
 348       "name" : "hasListener",
 349       "desc" : "Checks to see if this object has any listeners for a specified event",
 350       "isStatic" : false,
 351       "isConstructor" : false,
 352       "isPrivate" : false,
 353       "memberOf" : "Roo.util.Observable",
 354       "example" : "",
 355       "deprecated" : "",
 356       "since" : "",
 357       "see" : "",
 358       "params" : [
 359         {
 360           "name" : "eventName",
 361           "type" : "String",
 362           "desc" : "The name of the event to check for",
 363           "isOptional" : false
 364         }
 365       ],
 366       "returns" : [
 367         {
 368           "name" : "",
 369           "type" : "Boolean",
 370           "desc" : "True if the event is being listened for, else false"
 371         }
 372       ]
 373     },
 374     {
 375       "name" : "capture",
 376       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
 377       "isStatic" : true,
 378       "isConstructor" : false,
 379       "isPrivate" : false,
 380       "memberOf" : "Roo.util.Observable",
 381       "example" : "",
 382       "deprecated" : "",
 383       "since" : "",
 384       "see" : "",
 385       "params" : [
 386         {
 387           "name" : "o",
 388           "type" : "Observable",
 389           "desc" : "The Observable to capture",
 390           "isOptional" : false
 391         },
 392         {
 393           "name" : "fn",
 394           "type" : "Function",
 395           "desc" : "The function to call",
 396           "isOptional" : false
 397         },
 398         {
 399           "name" : "scope",
 400           "type" : "Object",
 401           "desc" : "(optional) The scope (this object) for the fn",
 402           "isOptional" : false
 403         }
 404       ],
 405       "returns" : [
 406       ]
 407     },
 408     {
 409       "name" : "addListener",
 410       "desc" : "Appends an event handler to this component",
 411       "isStatic" : false,
 412       "isConstructor" : false,
 413       "isPrivate" : false,
 414       "memberOf" : "Roo.util.Observable",
 415       "example" : "",
 416       "deprecated" : "",
 417       "since" : "",
 418       "see" : "",
 419       "params" : [
 420         {
 421           "name" : "eventName",
 422           "type" : "String",
 423           "desc" : "The type of event to listen for",
 424           "isOptional" : false
 425         },
 426         {
 427           "name" : "handler",
 428           "type" : "Function",
 429           "desc" : "The method the event invokes",
 430           "isOptional" : false
 431         },
 432         {
 433           "name" : "scope",
 434           "type" : "Object",
 435           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 436           "isOptional" : false
 437         },
 438         {
 439           "name" : "options",
 440           "type" : "Object",
 441           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 442           "isOptional" : false
 443         }
 444       ],
 445       "returns" : [
 446       ]
 447     }
 448   ],
 449   "events" : [
 450     {
 451       "name" : "selectionchange",
 452       "desc" : "Fires when the selected nodes change",
 453       "memberOf" : "",
 454       "example" : "",
 455       "deprecated" : "",
 456       "since" : "",
 457       "see" : "",
 458       "params" : [
 459         {
 460           "name" : "this",
 461           "type" : "MultiSelectionModel",
 462           "desc" : "",
 463           "isOptional" : false
 464         },
 465         {
 466           "name" : "nodes",
 467           "type" : "Array",
 468           "desc" : "Array of the selected nodes",
 469           "isOptional" : false
 470         }
 471       ],
 472       "returns" : [
 473       ]
 474     }
 475   ]
 476 }