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