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