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