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