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