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