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   "config" : [
  25     {
  26       "name" : "listeners",
  27       "type" : "Object",
  28       "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>",
  29       "memberOf" : "Roo.util.Observable",
  30       "optvals" : []
  31     }
  32   ],
  33   "methods" : [
  34     {
  35       "name" : "getSelectedNode",
  36       "desc" : "Get the selected node",
  37       "isStatic" : false,
  38       "isConstructor" : false,
  39       "isPrivate" : false,
  40       "memberOf" : "Roo.tree.DefaultSelectionModel",
  41       "example" : "",
  42       "deprecated" : "",
  43       "since" : "",
  44       "see" : "",
  45       "params" : [],
  46       "returns" : [
  47         {
  48           "name" : "",
  49           "type" : "TreeNode",
  50           "desc" : "The selected node"
  51         }
  52       ]
  53     },
  54     {
  55       "name" : "clearSelections",
  56       "desc" : "Clear all selections",
  57       "isStatic" : false,
  58       "isConstructor" : false,
  59       "isPrivate" : false,
  60       "memberOf" : "Roo.tree.DefaultSelectionModel",
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "params" : [],
  66       "returns" : []
  67     },
  68     {
  69       "name" : "isSelected",
  70       "desc" : "Returns true if the node is selected",
  71       "isStatic" : false,
  72       "isConstructor" : false,
  73       "isPrivate" : false,
  74       "memberOf" : "Roo.tree.DefaultSelectionModel",
  75       "example" : "",
  76       "deprecated" : "",
  77       "since" : "",
  78       "see" : "",
  79       "params" : [
  80         {
  81           "name" : "node",
  82           "type" : "TreeNode",
  83           "desc" : "The node to check",
  84           "isOptional" : false
  85         }
  86       ],
  87       "returns" : [
  88         {
  89           "name" : "",
  90           "type" : "Boolean",
  91           "desc" : ""
  92         }
  93       ]
  94     },
  95     {
  96       "name" : "selectPrevious",
  97       "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes",
  98       "isStatic" : false,
  99       "isConstructor" : false,
 100       "isPrivate" : false,
 101       "memberOf" : "Roo.tree.DefaultSelectionModel",
 102       "example" : "",
 103       "deprecated" : "",
 104       "since" : "",
 105       "see" : "",
 106       "params" : [],
 107       "returns" : [
 108         {
 109           "name" : "",
 110           "type" : "",
 111           "desc" : "TreeNode The new selection"
 112         }
 113       ]
 114     },
 115     {
 116       "name" : "unselect",
 117       "desc" : "Deselect a node.",
 118       "isStatic" : false,
 119       "isConstructor" : false,
 120       "isPrivate" : false,
 121       "memberOf" : "Roo.tree.DefaultSelectionModel",
 122       "example" : "",
 123       "deprecated" : "",
 124       "since" : "",
 125       "see" : "",
 126       "params" : [
 127         {
 128           "name" : "node",
 129           "type" : "TreeNode",
 130           "desc" : "The node to unselect",
 131           "isOptional" : false
 132         }
 133       ],
 134       "returns" : []
 135     },
 136     {
 137       "name" : "select",
 138       "desc" : "Select a node.",
 139       "isStatic" : false,
 140       "isConstructor" : false,
 141       "isPrivate" : false,
 142       "memberOf" : "Roo.tree.DefaultSelectionModel",
 143       "example" : "",
 144       "deprecated" : "",
 145       "since" : "",
 146       "see" : "",
 147       "params" : [
 148         {
 149           "name" : "node",
 150           "type" : "TreeNode",
 151           "desc" : "The node to select",
 152           "isOptional" : false
 153         }
 154       ],
 155       "returns" : [
 156         {
 157           "name" : "",
 158           "type" : "TreeNode",
 159           "desc" : "The selected node"
 160         }
 161       ]
 162     },
 163     {
 164       "name" : "selectNext",
 165       "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes",
 166       "isStatic" : false,
 167       "isConstructor" : false,
 168       "isPrivate" : false,
 169       "memberOf" : "Roo.tree.DefaultSelectionModel",
 170       "example" : "",
 171       "deprecated" : "",
 172       "since" : "",
 173       "see" : "",
 174       "params" : [],
 175       "returns" : [
 176         {
 177           "name" : "",
 178           "type" : "",
 179           "desc" : "TreeNode The new selection"
 180         }
 181       ]
 182     },
 183     {
 184       "name" : "purgeListeners",
 185       "desc" : "Removes all listeners for this object",
 186       "isStatic" : false,
 187       "isConstructor" : false,
 188       "isPrivate" : false,
 189       "memberOf" : "Roo.util.Observable",
 190       "example" : "",
 191       "deprecated" : "",
 192       "since" : "",
 193       "see" : "",
 194       "params" : [],
 195       "returns" : []
 196     },
 197     {
 198       "name" : "on",
 199       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 200       "isStatic" : false,
 201       "isConstructor" : false,
 202       "isPrivate" : false,
 203       "memberOf" : "Roo.util.Observable",
 204       "example" : "",
 205       "deprecated" : "",
 206       "since" : "",
 207       "see" : "",
 208       "params" : [
 209         {
 210           "name" : "eventName",
 211           "type" : "String",
 212           "desc" : "The type of event to listen for",
 213           "isOptional" : false
 214         },
 215         {
 216           "name" : "handler",
 217           "type" : "Function",
 218           "desc" : "The method the event invokes",
 219           "isOptional" : false
 220         },
 221         {
 222           "name" : "scope",
 223           "type" : "Object",
 224           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 225           "isOptional" : false
 226         },
 227         {
 228           "name" : "options",
 229           "type" : "Object",
 230           "desc" : "(optional)",
 231           "isOptional" : false
 232         }
 233       ],
 234       "returns" : []
 235     },
 236     {
 237       "name" : "un",
 238       "desc" : "Removes a listener (shorthand for removeListener)",
 239       "isStatic" : false,
 240       "isConstructor" : false,
 241       "isPrivate" : false,
 242       "memberOf" : "Roo.util.Observable",
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "params" : [
 248         {
 249           "name" : "eventName",
 250           "type" : "String",
 251           "desc" : "The type of event to listen for",
 252           "isOptional" : false
 253         },
 254         {
 255           "name" : "handler",
 256           "type" : "Function",
 257           "desc" : "The handler to remove",
 258           "isOptional" : false
 259         },
 260         {
 261           "name" : "scope",
 262           "type" : "Object",
 263           "desc" : "(optional) The scope (this object) for the handler",
 264           "isOptional" : false
 265         }
 266       ],
 267       "returns" : []
 268     },
 269     {
 270       "name" : "addEvents",
 271       "desc" : "Used to define events on this Observable",
 272       "isStatic" : false,
 273       "isConstructor" : false,
 274       "isPrivate" : false,
 275       "memberOf" : "Roo.util.Observable",
 276       "example" : "",
 277       "deprecated" : "",
 278       "since" : "",
 279       "see" : "",
 280       "params" : [
 281         {
 282           "name" : "object",
 283           "type" : "Object",
 284           "desc" : "The object with the events defined",
 285           "isOptional" : false
 286         }
 287       ],
 288       "returns" : []
 289     },
 290     {
 291       "name" : "releaseCapture",
 292       "desc" : "Removes <b>all</b> added captures from the Observable.",
 293       "isStatic" : true,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "memberOf" : "Roo.util.Observable",
 297       "example" : "",
 298       "deprecated" : "",
 299       "since" : "",
 300       "see" : "",
 301       "params" : [
 302         {
 303           "name" : "o",
 304           "type" : "Observable",
 305           "desc" : "The Observable to release",
 306           "isOptional" : false
 307         }
 308       ],
 309       "returns" : []
 310     },
 311     {
 312       "name" : "removeListener",
 313       "desc" : "Removes a listener",
 314       "isStatic" : false,
 315       "isConstructor" : false,
 316       "isPrivate" : false,
 317       "memberOf" : "Roo.util.Observable",
 318       "example" : "",
 319       "deprecated" : "",
 320       "since" : "",
 321       "see" : "",
 322       "params" : [
 323         {
 324           "name" : "eventName",
 325           "type" : "String",
 326           "desc" : "The type of event to listen for",
 327           "isOptional" : false
 328         },
 329         {
 330           "name" : "handler",
 331           "type" : "Function",
 332           "desc" : "The handler to remove",
 333           "isOptional" : false
 334         },
 335         {
 336           "name" : "scope",
 337           "type" : "Object",
 338           "desc" : "(optional) The scope (this object) for the handler",
 339           "isOptional" : false
 340         }
 341       ],
 342       "returns" : []
 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       "name" : "addListener",
 439       "desc" : "Appends an event handler to this component",
 440       "isStatic" : false,
 441       "isConstructor" : false,
 442       "isPrivate" : false,
 443       "memberOf" : "Roo.util.Observable",
 444       "example" : "",
 445       "deprecated" : "",
 446       "since" : "",
 447       "see" : "",
 448       "params" : [
 449         {
 450           "name" : "eventName",
 451           "type" : "String",
 452           "desc" : "The type of event to listen for",
 453           "isOptional" : false
 454         },
 455         {
 456           "name" : "handler",
 457           "type" : "Function",
 458           "desc" : "The method the event invokes",
 459           "isOptional" : false
 460         },
 461         {
 462           "name" : "scope",
 463           "type" : "Object",
 464           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 465           "isOptional" : false
 466         },
 467         {
 468           "name" : "options",
 469           "type" : "Object",
 470           "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>",
 471           "isOptional" : false
 472         }
 473       ],
 474       "returns" : []
 475     }
 476   ],
 477   "events" : [
 478     {
 479       "name" : "selectionchange",
 480       "desc" : "Fires when the selected node changes",
 481       "memberOf" : "Roo.tree.DefaultSelectionModel",
 482       "example" : "",
 483       "deprecated" : "",
 484       "since" : "",
 485       "see" : "",
 486       "params" : [
 487         {
 488           "name" : "this",
 489           "type" : "DefaultSelectionModel",
 490           "desc" : "",
 491           "isOptional" : false
 492         },
 493         {
 494           "name" : "node",
 495           "type" : "TreeNode",
 496           "desc" : "the new selection",
 497           "isOptional" : false
 498         }
 499       ],
 500       "returns" : []
 501     },
 502     {
 503       "name" : "beforeselect",
 504       "desc" : "Fires before the selected node changes, return false to cancel the change",
 505       "memberOf" : "Roo.tree.DefaultSelectionModel",
 506       "example" : "",
 507       "deprecated" : "",
 508       "since" : "",
 509       "see" : "",
 510       "params" : [
 511         {
 512           "name" : "this",
 513           "type" : "DefaultSelectionModel",
 514           "desc" : "",
 515           "isOptional" : false
 516         },
 517         {
 518           "name" : "node",
 519           "type" : "TreeNode",
 520           "desc" : "the new selection",
 521           "isOptional" : false
 522         },
 523         {
 524           "name" : "node",
 525           "type" : "TreeNode",
 526           "desc" : "the old selection",
 527           "isOptional" : false
 528         }
 529       ],
 530       "returns" : []
 531     }
 532   ]
 533 }