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