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