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