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