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

   1 {
   2   "name" : "Roo.grid.GridView",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "GridView",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "config",
  18       "type" : "Object",
  19       "desc" : "",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [],
  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       "optvals" : []
  31     }
  32   ],
  33   "methods" : [
  34     {
  35       "name" : "getFooterPanel",
  36       "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
  37       "isStatic" : false,
  38       "isConstructor" : false,
  39       "isPrivate" : false,
  40       "memberOf" : "Roo.grid.GridView",
  41       "example" : "",
  42       "deprecated" : "",
  43       "since" : "",
  44       "see" : "",
  45       "params" : [
  46         {
  47           "name" : "doShow",
  48           "type" : "Boolean",
  49           "desc" : "By default the footer is hidden. Pass true to show the panel",
  50           "isOptional" : false
  51         }
  52       ],
  53       "returns" : [
  54         {
  55           "name" : "",
  56           "type" : "",
  57           "desc" : "Roo.Element"
  58         }
  59       ]
  60     },
  61     {
  62       "name" : "fitColumns",
  63       "desc" : "Autofits all columns to the grid's width proportionate with their current size",
  64       "isStatic" : false,
  65       "isConstructor" : false,
  66       "isPrivate" : false,
  67       "memberOf" : "Roo.grid.GridView",
  68       "example" : "",
  69       "deprecated" : "",
  70       "since" : "",
  71       "see" : "",
  72       "params" : [
  73         {
  74           "name" : "reserveScrollSpace",
  75           "type" : "Boolean",
  76           "desc" : "Reserve space for a scrollbar",
  77           "isOptional" : false
  78         }
  79       ],
  80       "returns" : []
  81     },
  82     {
  83       "name" : "focusRow",
  84       "desc" : "Focuses the specified row.",
  85       "isStatic" : false,
  86       "isConstructor" : false,
  87       "isPrivate" : false,
  88       "memberOf" : "Roo.grid.GridView",
  89       "example" : "",
  90       "deprecated" : "",
  91       "since" : "",
  92       "see" : "",
  93       "params" : [
  94         {
  95           "name" : "row",
  96           "type" : "Number",
  97           "desc" : "The row index",
  98           "isOptional" : false
  99         }
 100       ],
 101       "returns" : []
 102     },
 103     {
 104       "name" : "focusCell",
 105       "desc" : "Focuses the specified cell.",
 106       "isStatic" : false,
 107       "isConstructor" : false,
 108       "isPrivate" : false,
 109       "memberOf" : "Roo.grid.GridView",
 110       "example" : "",
 111       "deprecated" : "",
 112       "since" : "",
 113       "see" : "",
 114       "params" : [
 115         {
 116           "name" : "row",
 117           "type" : "Number",
 118           "desc" : "The row index",
 119           "isOptional" : false
 120         },
 121         {
 122           "name" : "col",
 123           "type" : "Number",
 124           "desc" : "The column index",
 125           "isOptional" : false
 126         },
 127         {
 128           "name" : "hscroll",
 129           "type" : "Boolean",
 130           "desc" : "false to disable horizontal scrolling",
 131           "isOptional" : false
 132         }
 133       ],
 134       "returns" : []
 135     },
 136     {
 137       "name" : "autoSizeColumn",
 138       "desc" : "Autofit a column to its content.",
 139       "isStatic" : false,
 140       "isConstructor" : false,
 141       "isPrivate" : false,
 142       "memberOf" : "Roo.grid.GridView",
 143       "example" : "",
 144       "deprecated" : "",
 145       "since" : "",
 146       "see" : "",
 147       "params" : [
 148         {
 149           "name" : "colIndex",
 150           "type" : "Number",
 151           "desc" : "",
 152           "isOptional" : false
 153         },
 154         {
 155           "name" : "forceMinSize",
 156           "type" : "Boolean",
 157           "desc" : "true to force the column to go smaller if possible",
 158           "isOptional" : false
 159         }
 160       ],
 161       "returns" : []
 162     },
 163     {
 164       "name" : "getHeaderPanel",
 165       "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
 166       "isStatic" : false,
 167       "isConstructor" : false,
 168       "isPrivate" : false,
 169       "memberOf" : "Roo.grid.GridView",
 170       "example" : "",
 171       "deprecated" : "",
 172       "since" : "",
 173       "see" : "",
 174       "params" : [
 175         {
 176           "name" : "doShow",
 177           "type" : "Boolean",
 178           "desc" : "By default the header is hidden. Pass true to show the panel",
 179           "isOptional" : false
 180         }
 181       ],
 182       "returns" : [
 183         {
 184           "name" : "",
 185           "type" : "",
 186           "desc" : "Roo.Element"
 187         }
 188       ]
 189     },
 190     {
 191       "name" : "scrollToTop",
 192       "desc" : "Scrolls the grid to the top",
 193       "isStatic" : false,
 194       "isConstructor" : false,
 195       "isPrivate" : false,
 196       "memberOf" : "Roo.grid.GridView",
 197       "example" : "",
 198       "deprecated" : "",
 199       "since" : "",
 200       "see" : "",
 201       "params" : [],
 202       "returns" : []
 203     },
 204     {
 205       "name" : "getCell",
 206       "desc" : "Gets the 'td' of the cell",
 207       "isStatic" : false,
 208       "isConstructor" : false,
 209       "isPrivate" : false,
 210       "memberOf" : "Roo.grid.GridView",
 211       "example" : "",
 212       "deprecated" : "",
 213       "since" : "",
 214       "see" : "",
 215       "params" : [
 216         {
 217           "name" : "rowIndex",
 218           "type" : "Integer",
 219           "desc" : "row to select",
 220           "isOptional" : false
 221         },
 222         {
 223           "name" : "colIndex",
 224           "type" : "Integer",
 225           "desc" : "column to select",
 226           "isOptional" : false
 227         }
 228       ],
 229       "returns" : [
 230         {
 231           "name" : "",
 232           "type" : "Object",
 233           "desc" : ""
 234         }
 235       ]
 236     },
 237     {
 238       "name" : "refresh",
 239       "desc" : "Refreshes the grid",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "memberOf" : "Roo.grid.GridView",
 244       "example" : "",
 245       "deprecated" : "",
 246       "since" : "",
 247       "see" : "",
 248       "params" : [
 249         {
 250           "name" : "headersToo",
 251           "type" : "Boolean",
 252           "desc" : "",
 253           "isOptional" : false
 254         }
 255       ],
 256       "returns" : []
 257     },
 258     {
 259       "name" : "autoSizeColumns",
 260       "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid",
 261       "isStatic" : false,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "memberOf" : "Roo.grid.GridView",
 265       "example" : "",
 266       "deprecated" : "",
 267       "since" : "",
 268       "see" : "",
 269       "params" : [],
 270       "returns" : []
 271     },
 272     {
 273       "name" : "ensureVisible",
 274       "desc" : "Scrolls the specified cell into view",
 275       "isStatic" : false,
 276       "isConstructor" : false,
 277       "isPrivate" : false,
 278       "memberOf" : "Roo.grid.GridView",
 279       "example" : "",
 280       "deprecated" : "",
 281       "since" : "",
 282       "see" : "",
 283       "params" : [
 284         {
 285           "name" : "row",
 286           "type" : "Number",
 287           "desc" : "The row index",
 288           "isOptional" : false
 289         },
 290         {
 291           "name" : "col",
 292           "type" : "Number",
 293           "desc" : "The column index",
 294           "isOptional" : false
 295         },
 296         {
 297           "name" : "hscroll",
 298           "type" : "Boolean",
 299           "desc" : "false to disable horizontal scrolling",
 300           "isOptional" : false
 301         }
 302       ],
 303       "returns" : []
 304     },
 305     {
 306       "name" : "purgeListeners",
 307       "desc" : "Removes all listeners for this object",
 308       "isStatic" : false,
 309       "isConstructor" : false,
 310       "isPrivate" : false,
 311       "memberOf" : "Roo.util.Observable",
 312       "example" : "",
 313       "deprecated" : "",
 314       "since" : "",
 315       "see" : "",
 316       "params" : [],
 317       "returns" : []
 318     },
 319     {
 320       "name" : "on",
 321       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 322       "isStatic" : false,
 323       "isConstructor" : false,
 324       "isPrivate" : false,
 325       "memberOf" : "Roo.util.Observable",
 326       "example" : "",
 327       "deprecated" : "",
 328       "since" : "",
 329       "see" : "",
 330       "params" : [
 331         {
 332           "name" : "eventName",
 333           "type" : "String",
 334           "desc" : "The type of event to listen for",
 335           "isOptional" : false
 336         },
 337         {
 338           "name" : "handler",
 339           "type" : "Function",
 340           "desc" : "The method the event invokes",
 341           "isOptional" : false
 342         },
 343         {
 344           "name" : "scope",
 345           "type" : "Object",
 346           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 347           "isOptional" : false
 348         },
 349         {
 350           "name" : "options",
 351           "type" : "Object",
 352           "desc" : "(optional)",
 353           "isOptional" : false
 354         }
 355       ],
 356       "returns" : []
 357     },
 358     {
 359       "name" : "un",
 360       "desc" : "Removes a listener (shorthand for removeListener)",
 361       "isStatic" : false,
 362       "isConstructor" : false,
 363       "isPrivate" : false,
 364       "memberOf" : "Roo.util.Observable",
 365       "example" : "",
 366       "deprecated" : "",
 367       "since" : "",
 368       "see" : "",
 369       "params" : [
 370         {
 371           "name" : "eventName",
 372           "type" : "String",
 373           "desc" : "The type of event to listen for",
 374           "isOptional" : false
 375         },
 376         {
 377           "name" : "handler",
 378           "type" : "Function",
 379           "desc" : "The handler to remove",
 380           "isOptional" : false
 381         },
 382         {
 383           "name" : "scope",
 384           "type" : "Object",
 385           "desc" : "(optional) The scope (this object) for the handler",
 386           "isOptional" : false
 387         }
 388       ],
 389       "returns" : []
 390     },
 391     {
 392       "name" : "addEvents",
 393       "desc" : "Used to define events on this Observable",
 394       "isStatic" : false,
 395       "isConstructor" : false,
 396       "isPrivate" : false,
 397       "memberOf" : "Roo.util.Observable",
 398       "example" : "",
 399       "deprecated" : "",
 400       "since" : "",
 401       "see" : "",
 402       "params" : [
 403         {
 404           "name" : "object",
 405           "type" : "Object",
 406           "desc" : "The object with the events defined",
 407           "isOptional" : false
 408         }
 409       ],
 410       "returns" : []
 411     },
 412     {
 413       "name" : "releaseCapture",
 414       "desc" : "Removes <b>all</b> added captures from the Observable.",
 415       "isStatic" : true,
 416       "isConstructor" : false,
 417       "isPrivate" : false,
 418       "memberOf" : "Roo.util.Observable",
 419       "example" : "",
 420       "deprecated" : "",
 421       "since" : "",
 422       "see" : "",
 423       "params" : [
 424         {
 425           "name" : "o",
 426           "type" : "Observable",
 427           "desc" : "The Observable to release",
 428           "isOptional" : false
 429         }
 430       ],
 431       "returns" : []
 432     },
 433     {
 434       "name" : "removeListener",
 435       "desc" : "Removes a listener",
 436       "isStatic" : false,
 437       "isConstructor" : false,
 438       "isPrivate" : false,
 439       "memberOf" : "Roo.util.Observable",
 440       "example" : "",
 441       "deprecated" : "",
 442       "since" : "",
 443       "see" : "",
 444       "params" : [
 445         {
 446           "name" : "eventName",
 447           "type" : "String",
 448           "desc" : "The type of event to listen for",
 449           "isOptional" : false
 450         },
 451         {
 452           "name" : "handler",
 453           "type" : "Function",
 454           "desc" : "The handler to remove",
 455           "isOptional" : false
 456         },
 457         {
 458           "name" : "scope",
 459           "type" : "Object",
 460           "desc" : "(optional) The scope (this object) for the handler",
 461           "isOptional" : false
 462         }
 463       ],
 464       "returns" : []
 465     },
 466     {
 467       "name" : "fireEvent",
 468       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 469       "isStatic" : false,
 470       "isConstructor" : false,
 471       "isPrivate" : false,
 472       "memberOf" : "Roo.util.Observable",
 473       "example" : "",
 474       "deprecated" : "",
 475       "since" : "",
 476       "see" : "",
 477       "params" : [
 478         {
 479           "name" : "eventName",
 480           "type" : "String",
 481           "desc" : "",
 482           "isOptional" : false
 483         },
 484         {
 485           "name" : "args",
 486           "type" : "Object...",
 487           "desc" : "Variable number of parameters are passed to handlers",
 488           "isOptional" : false
 489         }
 490       ],
 491       "returns" : [
 492         {
 493           "name" : "",
 494           "type" : "Boolean",
 495           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 496         }
 497       ]
 498     },
 499     {
 500       "name" : "hasListener",
 501       "desc" : "Checks to see if this object has any listeners for a specified event",
 502       "isStatic" : false,
 503       "isConstructor" : false,
 504       "isPrivate" : false,
 505       "memberOf" : "Roo.util.Observable",
 506       "example" : "",
 507       "deprecated" : "",
 508       "since" : "",
 509       "see" : "",
 510       "params" : [
 511         {
 512           "name" : "eventName",
 513           "type" : "String",
 514           "desc" : "The name of the event to check for",
 515           "isOptional" : false
 516         }
 517       ],
 518       "returns" : [
 519         {
 520           "name" : "",
 521           "type" : "Boolean",
 522           "desc" : "True if the event is being listened for, else false"
 523         }
 524       ]
 525     },
 526     {
 527       "name" : "capture",
 528       "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.",
 529       "isStatic" : true,
 530       "isConstructor" : false,
 531       "isPrivate" : false,
 532       "memberOf" : "Roo.util.Observable",
 533       "example" : "",
 534       "deprecated" : "",
 535       "since" : "",
 536       "see" : "",
 537       "params" : [
 538         {
 539           "name" : "o",
 540           "type" : "Observable",
 541           "desc" : "The Observable to capture",
 542           "isOptional" : false
 543         },
 544         {
 545           "name" : "fn",
 546           "type" : "Function",
 547           "desc" : "The function to call",
 548           "isOptional" : false
 549         },
 550         {
 551           "name" : "scope",
 552           "type" : "Object",
 553           "desc" : "(optional) The scope (this object) for the fn",
 554           "isOptional" : false
 555         }
 556       ],
 557       "returns" : []
 558     },
 559     {
 560       "name" : "addListener",
 561       "desc" : "Appends an event handler to this component",
 562       "isStatic" : false,
 563       "isConstructor" : false,
 564       "isPrivate" : false,
 565       "memberOf" : "Roo.util.Observable",
 566       "example" : "",
 567       "deprecated" : "",
 568       "since" : "",
 569       "see" : "",
 570       "params" : [
 571         {
 572           "name" : "eventName",
 573           "type" : "String",
 574           "desc" : "The type of event to listen for",
 575           "isOptional" : false
 576         },
 577         {
 578           "name" : "handler",
 579           "type" : "Function",
 580           "desc" : "The method the event invokes",
 581           "isOptional" : false
 582         },
 583         {
 584           "name" : "scope",
 585           "type" : "Object",
 586           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 587           "isOptional" : false
 588         },
 589         {
 590           "name" : "options",
 591           "type" : "Object",
 592           "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>",
 593           "isOptional" : false
 594         }
 595       ],
 596       "returns" : []
 597     }
 598   ],
 599   "events" : []
 600 }