git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.bootstrap.Table.AbstractSelectionModel.json

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