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