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