git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.AbstractSelectionModel.json

   1 {
   2   "name" : "Roo.grid.AbstractSelectionModel",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : [
   7     "Roo.grid.CellSelectionModel",
   8     "Roo.grid.RowSelectionModel"
   9   ],
  10   "desc" : "Abstract base class for grid SelectionModels.  It provides the interface that should be\nimplemented by descendant classes.  This class should not be directly instantiated.",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "memberOf" : "AbstractSelectionModel",
  15   "example" : "",
  16   "deprecated" : "",
  17   "since" : "",
  18   "see" : "",
  19   "params" : [],
  20   "returns" : [],
  21   "throws" : "",
  22   "requires" : "",
  23   "config" : [
  24     {
  25       "name" : "listeners",
  26       "type" : "Object",
  27       "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>",
  28       "memberOf" : "Roo.util.Observable"
  29     }
  30   ],
  31   "methods" : [
  32     {
  33       "name" : "lock",
  34       "type" : "function",
  35       "desc" : "Locks the selections.",
  36       "sig" : "()\n{\n\n}",
  37       "static" : false,
  38       "memberOf" : "",
  39       "isStatic" : false,
  40       "isConstructor" : false,
  41       "isPrivate" : false,
  42       "example" : "",
  43       "deprecated" : "",
  44       "since" : "",
  45       "see" : "",
  46       "exceptions" : "",
  47       "requires" : "",
  48       "params" : [],
  49       "returns" : []
  50     },
  51     {
  52       "name" : "isLocked",
  53       "type" : "function",
  54       "desc" : "Returns true if the selections are locked.",
  55       "sig" : "()\n{\n\n}",
  56       "static" : false,
  57       "memberOf" : "",
  58       "isStatic" : false,
  59       "isConstructor" : false,
  60       "isPrivate" : false,
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "exceptions" : "",
  66       "requires" : "",
  67       "params" : [],
  68       "returns" : [
  69         {
  70           "name" : "",
  71           "type" : "Boolean",
  72           "desc" : ""
  73         }
  74       ]
  75     },
  76     {
  77       "name" : "unlock",
  78       "type" : "function",
  79       "desc" : "Unlocks the selections.",
  80       "sig" : "()\n{\n\n}",
  81       "static" : false,
  82       "memberOf" : "",
  83       "isStatic" : false,
  84       "isConstructor" : false,
  85       "isPrivate" : false,
  86       "example" : "",
  87       "deprecated" : "",
  88       "since" : "",
  89       "see" : "",
  90       "exceptions" : "",
  91       "requires" : "",
  92       "params" : [],
  93       "returns" : []
  94     },
  95     {
  96       "name" : "purgeListeners",
  97       "type" : "function",
  98       "desc" : "Removes all listeners for this object",
  99       "sig" : "()\n{\n\n}",
 100       "static" : false,
 101       "memberOf" : "Roo.util.Observable",
 102       "isStatic" : false,
 103       "isConstructor" : false,
 104       "isPrivate" : false,
 105       "example" : "",
 106       "deprecated" : "",
 107       "since" : "",
 108       "see" : "",
 109       "exceptions" : "",
 110       "requires" : "",
 111       "params" : [],
 112       "returns" : []
 113     },
 114     {
 115       "name" : "on",
 116       "type" : "function",
 117       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 118       "sig" : "(eventName, handler, scope, options)",
 119       "static" : false,
 120       "memberOf" : "Roo.util.Observable",
 121       "isStatic" : false,
 122       "isConstructor" : false,
 123       "isPrivate" : false,
 124       "example" : "",
 125       "deprecated" : "",
 126       "since" : "",
 127       "see" : "",
 128       "exceptions" : "",
 129       "requires" : "",
 130       "params" : [
 131         {
 132           "name" : "eventName",
 133           "type" : "String",
 134           "desc" : "The type of event to listen for",
 135           "isOptional" : false
 136         },
 137         {
 138           "name" : "handler",
 139           "type" : "Function",
 140           "desc" : "The method the event invokes",
 141           "isOptional" : false
 142         },
 143         {
 144           "name" : "scope",
 145           "type" : "Object",
 146           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 147           "isOptional" : false
 148         },
 149         {
 150           "name" : "options",
 151           "type" : "Object",
 152           "desc" : "(optional)",
 153           "isOptional" : false
 154         }
 155       ],
 156       "returns" : []
 157     },
 158     {
 159       "name" : "un",
 160       "type" : "function",
 161       "desc" : "Removes a listener (shorthand for removeListener)",
 162       "sig" : "(eventName, handler, scope)",
 163       "static" : false,
 164       "memberOf" : "Roo.util.Observable",
 165       "isStatic" : false,
 166       "isConstructor" : false,
 167       "isPrivate" : false,
 168       "example" : "",
 169       "deprecated" : "",
 170       "since" : "",
 171       "see" : "",
 172       "exceptions" : "",
 173       "requires" : "",
 174       "params" : [
 175         {
 176           "name" : "eventName",
 177           "type" : "String",
 178           "desc" : "The type of event to listen for",
 179           "isOptional" : false
 180         },
 181         {
 182           "name" : "handler",
 183           "type" : "Function",
 184           "desc" : "The handler to remove",
 185           "isOptional" : false
 186         },
 187         {
 188           "name" : "scope",
 189           "type" : "Object",
 190           "desc" : "(optional) The scope (this object) for the handler",
 191           "isOptional" : false
 192         }
 193       ],
 194       "returns" : []
 195     },
 196     {
 197       "name" : "addEvents",
 198       "type" : "function",
 199       "desc" : "Used to define events on this Observable",
 200       "sig" : "(object)",
 201       "static" : false,
 202       "memberOf" : "Roo.util.Observable",
 203       "isStatic" : false,
 204       "isConstructor" : false,
 205       "isPrivate" : false,
 206       "example" : "",
 207       "deprecated" : "",
 208       "since" : "",
 209       "see" : "",
 210       "exceptions" : "",
 211       "requires" : "",
 212       "params" : [
 213         {
 214           "name" : "object",
 215           "type" : "Object",
 216           "desc" : "The object with the events defined",
 217           "isOptional" : false
 218         }
 219       ],
 220       "returns" : []
 221     },
 222     {
 223       "name" : "releaseCapture",
 224       "type" : "function",
 225       "desc" : "Removes <b>all</b> added captures from the Observable.",
 226       "sig" : "(o)",
 227       "static" : true,
 228       "memberOf" : "Roo.util.Observable",
 229       "isStatic" : true,
 230       "isConstructor" : false,
 231       "isPrivate" : false,
 232       "example" : "",
 233       "deprecated" : "",
 234       "since" : "",
 235       "see" : "",
 236       "exceptions" : "",
 237       "requires" : "",
 238       "params" : [
 239         {
 240           "name" : "o",
 241           "type" : "Observable",
 242           "desc" : "The Observable to release",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : []
 247     },
 248     {
 249       "name" : "removeListener",
 250       "type" : "function",
 251       "desc" : "Removes a listener",
 252       "sig" : "(eventName, handler, scope)",
 253       "static" : false,
 254       "memberOf" : "Roo.util.Observable",
 255       "isStatic" : false,
 256       "isConstructor" : false,
 257       "isPrivate" : false,
 258       "example" : "",
 259       "deprecated" : "",
 260       "since" : "",
 261       "see" : "",
 262       "exceptions" : "",
 263       "requires" : "",
 264       "params" : [
 265         {
 266           "name" : "eventName",
 267           "type" : "String",
 268           "desc" : "The type of event to listen for",
 269           "isOptional" : false
 270         },
 271         {
 272           "name" : "handler",
 273           "type" : "Function",
 274           "desc" : "The handler to remove",
 275           "isOptional" : false
 276         },
 277         {
 278           "name" : "scope",
 279           "type" : "Object",
 280           "desc" : "(optional) The scope (this object) for the handler",
 281           "isOptional" : false
 282         }
 283       ],
 284       "returns" : []
 285     },
 286     {
 287       "name" : "fireEvent",
 288       "type" : "function",
 289       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 290       "sig" : "(eventName, args)",
 291       "static" : false,
 292       "memberOf" : "Roo.util.Observable",
 293       "isStatic" : false,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "example" : "",
 297       "deprecated" : "",
 298       "since" : "",
 299       "see" : "",
 300       "exceptions" : "",
 301       "requires" : "",
 302       "params" : [
 303         {
 304           "name" : "eventName",
 305           "type" : "String",
 306           "desc" : "",
 307           "isOptional" : false
 308         },
 309         {
 310           "name" : "args",
 311           "type" : "Object...",
 312           "desc" : "Variable number of parameters are passed to handlers",
 313           "isOptional" : false
 314         }
 315       ],
 316       "returns" : [
 317         {
 318           "name" : "",
 319           "type" : "Boolean",
 320           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 321         }
 322       ]
 323     },
 324     {
 325       "name" : "hasListener",
 326       "type" : "function",
 327       "desc" : "Checks to see if this object has any listeners for a specified event",
 328       "sig" : "(eventName)",
 329       "static" : false,
 330       "memberOf" : "Roo.util.Observable",
 331       "isStatic" : false,
 332       "isConstructor" : false,
 333       "isPrivate" : false,
 334       "example" : "",
 335       "deprecated" : "",
 336       "since" : "",
 337       "see" : "",
 338       "exceptions" : "",
 339       "requires" : "",
 340       "params" : [
 341         {
 342           "name" : "eventName",
 343           "type" : "String",
 344           "desc" : "The name of the event to check for",
 345           "isOptional" : false
 346         }
 347       ],
 348       "returns" : [
 349         {
 350           "name" : "",
 351           "type" : "Boolean",
 352           "desc" : "True if the event is being listened for, else false"
 353         }
 354       ]
 355     },
 356     {
 357       "name" : "capture",
 358       "type" : "function",
 359       "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.",
 360       "sig" : "(o, fn, scope)",
 361       "static" : true,
 362       "memberOf" : "Roo.util.Observable",
 363       "isStatic" : true,
 364       "isConstructor" : false,
 365       "isPrivate" : false,
 366       "example" : "",
 367       "deprecated" : "",
 368       "since" : "",
 369       "see" : "",
 370       "exceptions" : "",
 371       "requires" : "",
 372       "params" : [
 373         {
 374           "name" : "o",
 375           "type" : "Observable",
 376           "desc" : "The Observable to capture",
 377           "isOptional" : false
 378         },
 379         {
 380           "name" : "fn",
 381           "type" : "Function",
 382           "desc" : "The function to call",
 383           "isOptional" : false
 384         },
 385         {
 386           "name" : "scope",
 387           "type" : "Object",
 388           "desc" : "(optional) The scope (this object) for the fn",
 389           "isOptional" : false
 390         }
 391       ],
 392       "returns" : []
 393     },
 394     {
 395       "name" : "addListener",
 396       "type" : "function",
 397       "desc" : "Appends an event handler to this component",
 398       "sig" : "(eventName, handler, scope, options)",
 399       "static" : false,
 400       "memberOf" : "Roo.util.Observable",
 401       "isStatic" : false,
 402       "isConstructor" : false,
 403       "isPrivate" : false,
 404       "example" : "",
 405       "deprecated" : "",
 406       "since" : "",
 407       "see" : "",
 408       "exceptions" : "",
 409       "requires" : "",
 410       "params" : [
 411         {
 412           "name" : "eventName",
 413           "type" : "String",
 414           "desc" : "The type of event to listen for",
 415           "isOptional" : false
 416         },
 417         {
 418           "name" : "handler",
 419           "type" : "Function",
 420           "desc" : "The method the event invokes",
 421           "isOptional" : false
 422         },
 423         {
 424           "name" : "scope",
 425           "type" : "Object",
 426           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 427           "isOptional" : false
 428         },
 429         {
 430           "name" : "options",
 431           "type" : "Object",
 432           "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>",
 433           "isOptional" : false
 434         }
 435       ],
 436       "returns" : []
 437     }
 438   ],
 439   "events" : []
 440 }