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