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