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