git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.AbstractGridView.json

   1 {
   2   "name" : "Roo.grid.AbstractGridView",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "Abstract base class for grid Views",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "AbstractGridView",
  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" : "setCSSStyle",
  30       "type" : "function",
  31       "desc" : "Set a css style for a column dynamically.",
  32       "sig" : "(colIndex, name, value)",
  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         {
  46           "name" : "colIndex",
  47           "type" : "Number",
  48           "desc" : "The index of the column",
  49           "isOptional" : false
  50         },
  51         {
  52           "name" : "name",
  53           "type" : "String",
  54           "desc" : "The css property name",
  55           "isOptional" : false
  56         },
  57         {
  58           "name" : "value",
  59           "type" : "String",
  60           "desc" : "The css value",
  61           "isOptional" : false
  62         }
  63       ],
  64       "returns" : []
  65     },
  66     {
  67       "name" : "purgeListeners",
  68       "type" : "function",
  69       "desc" : "Removes all listeners for this object",
  70       "sig" : "()\n{\n\n}",
  71       "static" : false,
  72       "memberOf" : "Roo.util.Observable",
  73       "isStatic" : false,
  74       "isConstructor" : false,
  75       "isPrivate" : false,
  76       "example" : "",
  77       "deprecated" : "",
  78       "since" : "",
  79       "see" : "",
  80       "exceptions" : "",
  81       "requires" : "",
  82       "params" : [],
  83       "returns" : []
  84     },
  85     {
  86       "name" : "on",
  87       "type" : "function",
  88       "desc" : "Appends an event handler to this element (shorthand for addListener)",
  89       "sig" : "(eventName, handler, scope, options)",
  90       "static" : false,
  91       "memberOf" : "Roo.util.Observable",
  92       "isStatic" : false,
  93       "isConstructor" : false,
  94       "isPrivate" : false,
  95       "example" : "",
  96       "deprecated" : "",
  97       "since" : "",
  98       "see" : "",
  99       "exceptions" : "",
 100       "requires" : "",
 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       "name" : "un",
 131       "type" : "function",
 132       "desc" : "Removes a listener (shorthand for removeListener)",
 133       "sig" : "(eventName, handler, scope)",
 134       "static" : false,
 135       "memberOf" : "Roo.util.Observable",
 136       "isStatic" : false,
 137       "isConstructor" : false,
 138       "isPrivate" : false,
 139       "example" : "",
 140       "deprecated" : "",
 141       "since" : "",
 142       "see" : "",
 143       "exceptions" : "",
 144       "requires" : "",
 145       "params" : [
 146         {
 147           "name" : "eventName",
 148           "type" : "String",
 149           "desc" : "The type of event to listen for",
 150           "isOptional" : false
 151         },
 152         {
 153           "name" : "handler",
 154           "type" : "Function",
 155           "desc" : "The handler to remove",
 156           "isOptional" : false
 157         },
 158         {
 159           "name" : "scope",
 160           "type" : "Object",
 161           "desc" : "(optional) The scope (this object) for the handler",
 162           "isOptional" : false
 163         }
 164       ],
 165       "returns" : []
 166     },
 167     {
 168       "name" : "addEvents",
 169       "type" : "function",
 170       "desc" : "Used to define events on this Observable",
 171       "sig" : "(object)",
 172       "static" : false,
 173       "memberOf" : "Roo.util.Observable",
 174       "isStatic" : false,
 175       "isConstructor" : false,
 176       "isPrivate" : false,
 177       "example" : "",
 178       "deprecated" : "",
 179       "since" : "",
 180       "see" : "",
 181       "exceptions" : "",
 182       "requires" : "",
 183       "params" : [
 184         {
 185           "name" : "object",
 186           "type" : "Object",
 187           "desc" : "The object with the events defined",
 188           "isOptional" : false
 189         }
 190       ],
 191       "returns" : []
 192     },
 193     {
 194       "name" : "releaseCapture",
 195       "type" : "function",
 196       "desc" : "Removes <b>all</b> added captures from the Observable.",
 197       "sig" : "(o)",
 198       "static" : true,
 199       "memberOf" : "Roo.util.Observable",
 200       "isStatic" : true,
 201       "isConstructor" : false,
 202       "isPrivate" : false,
 203       "example" : "",
 204       "deprecated" : "",
 205       "since" : "",
 206       "see" : "",
 207       "exceptions" : "",
 208       "requires" : "",
 209       "params" : [
 210         {
 211           "name" : "o",
 212           "type" : "Observable",
 213           "desc" : "The Observable to release",
 214           "isOptional" : false
 215         }
 216       ],
 217       "returns" : []
 218     },
 219     {
 220       "name" : "removeListener",
 221       "type" : "function",
 222       "desc" : "Removes a listener",
 223       "sig" : "(eventName, handler, scope)",
 224       "static" : false,
 225       "memberOf" : "Roo.util.Observable",
 226       "isStatic" : false,
 227       "isConstructor" : false,
 228       "isPrivate" : false,
 229       "example" : "",
 230       "deprecated" : "",
 231       "since" : "",
 232       "see" : "",
 233       "exceptions" : "",
 234       "requires" : "",
 235       "params" : [
 236         {
 237           "name" : "eventName",
 238           "type" : "String",
 239           "desc" : "The type of event to listen for",
 240           "isOptional" : false
 241         },
 242         {
 243           "name" : "handler",
 244           "type" : "Function",
 245           "desc" : "The handler to remove",
 246           "isOptional" : false
 247         },
 248         {
 249           "name" : "scope",
 250           "type" : "Object",
 251           "desc" : "(optional) The scope (this object) for the handler",
 252           "isOptional" : false
 253         }
 254       ],
 255       "returns" : []
 256     },
 257     {
 258       "name" : "fireEvent",
 259       "type" : "function",
 260       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 261       "sig" : "(eventName, args)",
 262       "static" : false,
 263       "memberOf" : "Roo.util.Observable",
 264       "isStatic" : false,
 265       "isConstructor" : false,
 266       "isPrivate" : false,
 267       "example" : "",
 268       "deprecated" : "",
 269       "since" : "",
 270       "see" : "",
 271       "exceptions" : "",
 272       "requires" : "",
 273       "params" : [
 274         {
 275           "name" : "eventName",
 276           "type" : "String",
 277           "desc" : "",
 278           "isOptional" : false
 279         },
 280         {
 281           "name" : "args",
 282           "type" : "Object...",
 283           "desc" : "Variable number of parameters are passed to handlers",
 284           "isOptional" : false
 285         }
 286       ],
 287       "returns" : [
 288         {
 289           "name" : "",
 290           "type" : "Boolean",
 291           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 292         }
 293       ]
 294     },
 295     {
 296       "name" : "hasListener",
 297       "type" : "function",
 298       "desc" : "Checks to see if this object has any listeners for a specified event",
 299       "sig" : "(eventName)",
 300       "static" : false,
 301       "memberOf" : "Roo.util.Observable",
 302       "isStatic" : false,
 303       "isConstructor" : false,
 304       "isPrivate" : false,
 305       "example" : "",
 306       "deprecated" : "",
 307       "since" : "",
 308       "see" : "",
 309       "exceptions" : "",
 310       "requires" : "",
 311       "params" : [
 312         {
 313           "name" : "eventName",
 314           "type" : "String",
 315           "desc" : "The name of the event to check for",
 316           "isOptional" : false
 317         }
 318       ],
 319       "returns" : [
 320         {
 321           "name" : "",
 322           "type" : "Boolean",
 323           "desc" : "True if the event is being listened for, else false"
 324         }
 325       ]
 326     },
 327     {
 328       "name" : "capture",
 329       "type" : "function",
 330       "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.",
 331       "sig" : "(o, fn, scope)",
 332       "static" : true,
 333       "memberOf" : "Roo.util.Observable",
 334       "isStatic" : true,
 335       "isConstructor" : false,
 336       "isPrivate" : false,
 337       "example" : "",
 338       "deprecated" : "",
 339       "since" : "",
 340       "see" : "",
 341       "exceptions" : "",
 342       "requires" : "",
 343       "params" : [
 344         {
 345           "name" : "o",
 346           "type" : "Observable",
 347           "desc" : "The Observable to capture",
 348           "isOptional" : false
 349         },
 350         {
 351           "name" : "fn",
 352           "type" : "Function",
 353           "desc" : "The function to call",
 354           "isOptional" : false
 355         },
 356         {
 357           "name" : "scope",
 358           "type" : "Object",
 359           "desc" : "(optional) The scope (this object) for the fn",
 360           "isOptional" : false
 361         }
 362       ],
 363       "returns" : []
 364     },
 365     {
 366       "name" : "addListener",
 367       "type" : "function",
 368       "desc" : "Appends an event handler to this component",
 369       "sig" : "(eventName, handler, scope, options)",
 370       "static" : false,
 371       "memberOf" : "Roo.util.Observable",
 372       "isStatic" : false,
 373       "isConstructor" : false,
 374       "isPrivate" : false,
 375       "example" : "",
 376       "deprecated" : "",
 377       "since" : "",
 378       "see" : "",
 379       "exceptions" : "",
 380       "requires" : "",
 381       "params" : [
 382         {
 383           "name" : "eventName",
 384           "type" : "String",
 385           "desc" : "The type of event to listen for",
 386           "isOptional" : false
 387         },
 388         {
 389           "name" : "handler",
 390           "type" : "Function",
 391           "desc" : "The method the event invokes",
 392           "isOptional" : false
 393         },
 394         {
 395           "name" : "scope",
 396           "type" : "Object",
 397           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 398           "isOptional" : false
 399         },
 400         {
 401           "name" : "options",
 402           "type" : "Object",
 403           "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>",
 404           "isOptional" : false
 405         }
 406       ],
 407       "returns" : []
 408     }
 409   ],
 410   "events" : []
 411 }