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