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