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