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