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