git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.DefaultSelectionModel.json

   1 {
   2   "name" : "Roo.tree.DefaultSelectionModel",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [],
   8   "tree_parent" : [],
   9   "desc" : "The default single selection for a TreePanel.",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "isAbstract" : false,
  14   "isBuilderTop" : false,
  15   "memberOf" : "DefaultSelectionModel",
  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" : "getSelectedNode",
  44       "type" : "function",
  45       "desc" : "Get the selected node",
  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" : "TreeNode",
  63           "desc" : "The selected node"
  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" : "selectPrevious",
 120       "type" : "function",
 121       "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes",
 122       "sig" : "()\n{\n\n}",
 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       "returns" : [
 136         {
 137           "name" : "",
 138           "type" : "",
 139           "desc" : "TreeNode The new selection"
 140         }
 141       ]
 142     },
 143     {
 144       "name" : "unselect",
 145       "type" : "function",
 146       "desc" : "Deselect a node.",
 147       "sig" : "(node)",
 148       "static" : false,
 149       "memberOf" : "",
 150       "isStatic" : false,
 151       "isConstructor" : false,
 152       "isPrivate" : false,
 153       "example" : "",
 154       "deprecated" : "",
 155       "since" : "",
 156       "see" : "",
 157       "exceptions" : "",
 158       "requires" : "",
 159       "params" : [
 160         {
 161           "name" : "node",
 162           "type" : "TreeNode",
 163           "desc" : "The node to unselect",
 164           "isOptional" : false
 165         }
 166       ],
 167       "returns" : []
 168     },
 169     {
 170       "name" : "select",
 171       "type" : "function",
 172       "desc" : "Select a node.",
 173       "sig" : "(node)",
 174       "static" : false,
 175       "memberOf" : "",
 176       "isStatic" : false,
 177       "isConstructor" : false,
 178       "isPrivate" : false,
 179       "example" : "",
 180       "deprecated" : "",
 181       "since" : "",
 182       "see" : "",
 183       "exceptions" : "",
 184       "requires" : "",
 185       "params" : [
 186         {
 187           "name" : "node",
 188           "type" : "TreeNode",
 189           "desc" : "The node to select",
 190           "isOptional" : false
 191         }
 192       ],
 193       "returns" : [
 194         {
 195           "name" : "",
 196           "type" : "TreeNode",
 197           "desc" : "The selected node"
 198         }
 199       ]
 200     },
 201     {
 202       "name" : "selectNext",
 203       "type" : "function",
 204       "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes",
 205       "sig" : "()\n{\n\n}",
 206       "static" : false,
 207       "memberOf" : "",
 208       "isStatic" : false,
 209       "isConstructor" : false,
 210       "isPrivate" : false,
 211       "example" : "",
 212       "deprecated" : "",
 213       "since" : "",
 214       "see" : "",
 215       "exceptions" : "",
 216       "requires" : "",
 217       "params" : [],
 218       "returns" : [
 219         {
 220           "name" : "",
 221           "type" : "",
 222           "desc" : "TreeNode The new selection"
 223         }
 224       ]
 225     },
 226     {
 227       "name" : "purgeListeners",
 228       "type" : "function",
 229       "desc" : "Removes all listeners for this object",
 230       "sig" : "()\n{\n\n}",
 231       "static" : false,
 232       "memberOf" : "Roo.util.Observable",
 233       "isStatic" : false,
 234       "isConstructor" : false,
 235       "isPrivate" : false,
 236       "example" : "",
 237       "deprecated" : "",
 238       "since" : "",
 239       "see" : "",
 240       "exceptions" : "",
 241       "requires" : "",
 242       "params" : [],
 243       "returns" : []
 244     },
 245     {
 246       "name" : "on",
 247       "type" : "function",
 248       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 249       "sig" : "(eventName, handler, scope, options)",
 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 method the event invokes",
 272           "isOptional" : false
 273         },
 274         {
 275           "name" : "scope",
 276           "type" : "Object",
 277           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 278           "isOptional" : false
 279         },
 280         {
 281           "name" : "options",
 282           "type" : "Object",
 283           "desc" : "(optional)",
 284           "isOptional" : false
 285         }
 286       ],
 287       "returns" : []
 288     },
 289     {
 290       "name" : "un",
 291       "type" : "function",
 292       "desc" : "Removes a listener (shorthand for removeListener)",
 293       "sig" : "(eventName, handler, scope)",
 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" : "eventName",
 308           "type" : "String",
 309           "desc" : "The type of event to listen for",
 310           "isOptional" : false
 311         },
 312         {
 313           "name" : "handler",
 314           "type" : "Function",
 315           "desc" : "The handler to remove",
 316           "isOptional" : false
 317         },
 318         {
 319           "name" : "scope",
 320           "type" : "Object",
 321           "desc" : "(optional) The scope (this object) for the handler",
 322           "isOptional" : false
 323         }
 324       ],
 325       "returns" : []
 326     },
 327     {
 328       "name" : "addEvents",
 329       "type" : "function",
 330       "desc" : "Used to define events on this Observable",
 331       "sig" : "(object)",
 332       "static" : false,
 333       "memberOf" : "Roo.util.Observable",
 334       "isStatic" : false,
 335       "isConstructor" : false,
 336       "isPrivate" : false,
 337       "example" : "",
 338       "deprecated" : "",
 339       "since" : "",
 340       "see" : "",
 341       "exceptions" : "",
 342       "requires" : "",
 343       "params" : [
 344         {
 345           "name" : "object",
 346           "type" : "Object",
 347           "desc" : "The object with the events defined",
 348           "isOptional" : false
 349         }
 350       ],
 351       "returns" : []
 352     },
 353     {
 354       "name" : "releaseCapture",
 355       "type" : "function",
 356       "desc" : "Removes <b>all</b> added captures from the Observable.",
 357       "sig" : "(o)",
 358       "static" : true,
 359       "memberOf" : "Roo.util.Observable",
 360       "isStatic" : true,
 361       "isConstructor" : false,
 362       "isPrivate" : false,
 363       "example" : "",
 364       "deprecated" : "",
 365       "since" : "",
 366       "see" : "",
 367       "exceptions" : "",
 368       "requires" : "",
 369       "params" : [
 370         {
 371           "name" : "o",
 372           "type" : "Observable",
 373           "desc" : "The Observable to release",
 374           "isOptional" : false
 375         }
 376       ],
 377       "returns" : []
 378     },
 379     {
 380       "name" : "removeListener",
 381       "type" : "function",
 382       "desc" : "Removes a listener",
 383       "sig" : "(eventName, handler, scope)",
 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" : "The type of event to listen for",
 400           "isOptional" : false
 401         },
 402         {
 403           "name" : "handler",
 404           "type" : "Function",
 405           "desc" : "The handler to remove",
 406           "isOptional" : false
 407         },
 408         {
 409           "name" : "scope",
 410           "type" : "Object",
 411           "desc" : "(optional) The scope (this object) for the handler",
 412           "isOptional" : false
 413         }
 414       ],
 415       "returns" : []
 416     },
 417     {
 418       "name" : "fireEvent",
 419       "type" : "function",
 420       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 421       "sig" : "(eventName, args)",
 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" : "",
 438           "isOptional" : false
 439         },
 440         {
 441           "name" : "args",
 442           "type" : "Object...",
 443           "desc" : "Variable number of parameters are passed to handlers",
 444           "isOptional" : false
 445         }
 446       ],
 447       "returns" : [
 448         {
 449           "name" : "",
 450           "type" : "Boolean",
 451           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 452         }
 453       ]
 454     },
 455     {
 456       "name" : "hasListener",
 457       "type" : "function",
 458       "desc" : "Checks to see if this object has any listeners for a specified event",
 459       "sig" : "(eventName)",
 460       "static" : false,
 461       "memberOf" : "Roo.util.Observable",
 462       "isStatic" : false,
 463       "isConstructor" : false,
 464       "isPrivate" : false,
 465       "example" : "",
 466       "deprecated" : "",
 467       "since" : "",
 468       "see" : "",
 469       "exceptions" : "",
 470       "requires" : "",
 471       "params" : [
 472         {
 473           "name" : "eventName",
 474           "type" : "String",
 475           "desc" : "The name of the event to check for",
 476           "isOptional" : false
 477         }
 478       ],
 479       "returns" : [
 480         {
 481           "name" : "",
 482           "type" : "Boolean",
 483           "desc" : "True if the event is being listened for, else false"
 484         }
 485       ]
 486     },
 487     {
 488       "name" : "capture",
 489       "type" : "function",
 490       "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.",
 491       "sig" : "(o, fn, scope)",
 492       "static" : true,
 493       "memberOf" : "Roo.util.Observable",
 494       "isStatic" : true,
 495       "isConstructor" : false,
 496       "isPrivate" : false,
 497       "example" : "",
 498       "deprecated" : "",
 499       "since" : "",
 500       "see" : "",
 501       "exceptions" : "",
 502       "requires" : "",
 503       "params" : [
 504         {
 505           "name" : "o",
 506           "type" : "Observable",
 507           "desc" : "The Observable to capture",
 508           "isOptional" : false
 509         },
 510         {
 511           "name" : "fn",
 512           "type" : "Function",
 513           "desc" : "The function to call",
 514           "isOptional" : false
 515         },
 516         {
 517           "name" : "scope",
 518           "type" : "Object",
 519           "desc" : "(optional) The scope (this object) for the fn",
 520           "isOptional" : false
 521         }
 522       ],
 523       "returns" : []
 524     },
 525     {
 526       "name" : "addListener",
 527       "type" : "function",
 528       "desc" : "Appends an event handler to this component",
 529       "sig" : "(eventName, handler, scope, options)",
 530       "static" : false,
 531       "memberOf" : "Roo.util.Observable",
 532       "isStatic" : false,
 533       "isConstructor" : false,
 534       "isPrivate" : false,
 535       "example" : "",
 536       "deprecated" : "",
 537       "since" : "",
 538       "see" : "",
 539       "exceptions" : "",
 540       "requires" : "",
 541       "params" : [
 542         {
 543           "name" : "eventName",
 544           "type" : "String",
 545           "desc" : "The type of event to listen for",
 546           "isOptional" : false
 547         },
 548         {
 549           "name" : "handler",
 550           "type" : "Function",
 551           "desc" : "The method the event invokes",
 552           "isOptional" : false
 553         },
 554         {
 555           "name" : "scope",
 556           "type" : "Object",
 557           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 558           "isOptional" : false
 559         },
 560         {
 561           "name" : "options",
 562           "type" : "Object",
 563           "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>",
 564           "isOptional" : false
 565         }
 566       ],
 567       "returns" : []
 568     }
 569   ],
 570   "events" : [
 571     {
 572       "name" : "selectionchange",
 573       "type" : "function",
 574       "desc" : "Fires when the selected node changes",
 575       "sig" : "function (_self, node)\n{\n\n}",
 576       "memberOf" : "",
 577       "example" : "",
 578       "deprecated" : "",
 579       "since" : "",
 580       "see" : "",
 581       "params" : [
 582         {
 583           "name" : "this",
 584           "type" : "DefaultSelectionModel",
 585           "desc" : "",
 586           "isOptional" : false
 587         },
 588         {
 589           "name" : "node",
 590           "type" : "TreeNode",
 591           "desc" : "the new selection",
 592           "isOptional" : false
 593         }
 594       ],
 595       "returns" : []
 596     },
 597     {
 598       "name" : "beforeselect",
 599       "type" : "function",
 600       "desc" : "Fires before the selected node changes, return false to cancel the change",
 601       "sig" : "function (_self, node, node)\n{\n\n}",
 602       "memberOf" : "",
 603       "example" : "",
 604       "deprecated" : "",
 605       "since" : "",
 606       "see" : "",
 607       "params" : [
 608         {
 609           "name" : "this",
 610           "type" : "DefaultSelectionModel",
 611           "desc" : "",
 612           "isOptional" : false
 613         },
 614         {
 615           "name" : "node",
 616           "type" : "TreeNode",
 617           "desc" : "the new selection",
 618           "isOptional" : false
 619         },
 620         {
 621           "name" : "node",
 622           "type" : "TreeNode",
 623           "desc" : "the old selection",
 624           "isOptional" : false
 625         }
 626       ],
 627       "returns" : []
 628     }
 629   ]
 630 }