git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.ColumnModel.json

   1 {
   2   "name" : "Roo.grid.ColumnModel",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "This is the default implementation of a ColumnModel used by the Grid. It defines\nthe columns in the grid.\n<br>Usage:<br>\n <pre><code>\n var colModel = new Roo.grid.ColumnModel([\n\t{header: \"Ticker\", width: 60, sortable: true, locked: true},\n\t{header: \"Company Name\", width: 150, sortable: true},\n\t{header: \"Market Cap.\", width: 100, sortable: true},\n\t{header: \"$ Sales\", width: 100, sortable: true, renderer: money},\n\t{header: \"Employees\", width: 100, sortable: true, resizable: false}\n ]);\n </code></pre>\n<p>\nThe config options listed for this class are options which may appear in each\nindividual column definition.\n<br/>RooJS Fix - column id's are not sequential but use Roo.id() - fixes bugs with layouts.",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "ColumnModel",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "config",
  18       "type" : "Object",
  19       "desc" : "An Array of column config objects. See this class's\nconfig objects for details.",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [],
  24   "throws" : "",
  25   "requires" : "",
  26   "config" : [
  27     {
  28       "name" : "mdHeader",
  29       "type" : "String",
  30       "desc" : "Header at Bootsrap Medium width",
  31       "memberOf" : ""
  32     },
  33     {
  34       "name" : "editor",
  35       "type" : "Roo.grid.GridEditor",
  36       "desc" : "(Optional) For grid editors - returns the grid editor",
  37       "memberOf" : ""
  38     },
  39     {
  40       "name" : "cursor",
  41       "type" : "String",
  42       "desc" : "(Optional)",
  43       "memberOf" : ""
  44     },
  45     {
  46       "name" : "listeners",
  47       "type" : "Object",
  48       "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>",
  49       "memberOf" : "Roo.util.Observable"
  50     },
  51     {
  52       "name" : "smHeader",
  53       "type" : "String",
  54       "desc" : "Header at Bootsrap Small width",
  55       "memberOf" : ""
  56     },
  57     {
  58       "name" : "tooltip",
  59       "type" : "String",
  60       "desc" : "(Optional)",
  61       "memberOf" : ""
  62     },
  63     {
  64       "name" : "md",
  65       "type" : "Number",
  66       "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
  67       "memberOf" : ""
  68     },
  69     {
  70       "name" : "align",
  71       "type" : "String",
  72       "desc" : "(Optional) Set the CSS text-align property of the column.  Defaults to undefined.",
  73       "memberOf" : ""
  74     },
  75     {
  76       "name" : "lgHeader",
  77       "type" : "String",
  78       "desc" : "Header at Bootsrap Large width",
  79       "memberOf" : ""
  80     },
  81     {
  82       "name" : "xlHeader",
  83       "type" : "String",
  84       "desc" : "Header at Bootsrap extra Large width",
  85       "memberOf" : ""
  86     },
  87     {
  88       "name" : "fixed",
  89       "type" : "Boolean",
  90       "desc" : "(Optional) True if the column width cannot be changed.  Defaults to false.",
  91       "memberOf" : ""
  92     },
  93     {
  94       "name" : "hidden",
  95       "type" : "Boolean",
  96       "desc" : "(Optional) True to hide the column. Defaults to false.",
  97       "memberOf" : ""
  98     },
  99     {
 100       "name" : "valign",
 101       "type" : "String",
 102       "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc).  Defaults to undefined.",
 103       "memberOf" : ""
 104     },
 105     {
 106       "name" : "locked",
 107       "type" : "Boolean",
 108       "desc" : "(Optional) True to lock the column in place while scrolling the Grid.  Defaults to false.",
 109       "memberOf" : ""
 110     },
 111     {
 112       "name" : "lg",
 113       "type" : "Number",
 114       "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
 115       "memberOf" : ""
 116     },
 117     {
 118       "name" : "renderer",
 119       "type" : "Function",
 120       "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
 121       "memberOf" : ""
 122     },
 123     {
 124       "name" : "xs",
 125       "type" : "Number",
 126       "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
 127       "memberOf" : ""
 128     },
 129     {
 130       "name" : "xsHeader",
 131       "type" : "String",
 132       "desc" : "Header at Bootsrap Extra Small width (default for all)",
 133       "memberOf" : ""
 134     },
 135     {
 136       "name" : "sortable",
 137       "type" : "Boolean",
 138       "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
 139       "memberOf" : ""
 140     },
 141     {
 142       "name" : "header",
 143       "type" : "String",
 144       "desc" : "The header text to display in the Grid view.",
 145       "memberOf" : ""
 146     },
 147     {
 148       "name" : "width",
 149       "type" : "Number",
 150       "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
 151       "memberOf" : ""
 152     },
 153     {
 154       "name" : "resizable",
 155       "type" : "Boolean",
 156       "desc" : "(Optional) False to disable column resizing. Defaults to true.",
 157       "memberOf" : ""
 158     },
 159     {
 160       "name" : "xl",
 161       "type" : "Number",
 162       "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
 163       "memberOf" : ""
 164     },
 165     {
 166       "name" : "dataIndex",
 167       "type" : "String",
 168       "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
 169       "memberOf" : ""
 170     },
 171     {
 172       "name" : "sm",
 173       "type" : "Number",
 174       "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
 175       "memberOf" : ""
 176     }
 177   ],
 178   "methods" : [
 179     {
 180       "name" : "setRenderer",
 181       "type" : "function",
 182       "desc" : "Sets the rendering (formatting) function for a column.",
 183       "sig" : "(col, fn)",
 184       "static" : false,
 185       "memberOf" : "",
 186       "isStatic" : false,
 187       "isConstructor" : false,
 188       "isPrivate" : false,
 189       "example" : "",
 190       "deprecated" : "",
 191       "since" : "",
 192       "see" : "",
 193       "exceptions" : "",
 194       "requires" : "",
 195       "params" : [
 196         {
 197           "name" : "col",
 198           "type" : "Number",
 199           "desc" : "The column index",
 200           "isOptional" : false
 201         },
 202         {
 203           "name" : "fn",
 204           "type" : "Function",
 205           "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
 206           "isOptional" : false
 207         }
 208       ],
 209       "returns" : []
 210     },
 211     {
 212       "name" : "isHidden",
 213       "type" : "function",
 214       "desc" : "Returns true if the column is hidden.",
 215       "sig" : "(colIndex)",
 216       "static" : false,
 217       "memberOf" : "",
 218       "isStatic" : false,
 219       "isConstructor" : false,
 220       "isPrivate" : false,
 221       "example" : "",
 222       "deprecated" : "",
 223       "since" : "",
 224       "see" : "",
 225       "exceptions" : "",
 226       "requires" : "",
 227       "params" : [
 228         {
 229           "name" : "colIndex",
 230           "type" : "Number",
 231           "desc" : "The column index",
 232           "isOptional" : false
 233         }
 234       ],
 235       "returns" : [
 236         {
 237           "name" : "",
 238           "type" : "Boolean",
 239           "desc" : ""
 240         }
 241       ]
 242     },
 243     {
 244       "name" : "setColumnHeader",
 245       "type" : "function",
 246       "desc" : "Sets the header for a column.",
 247       "sig" : "(col, header)",
 248       "static" : false,
 249       "memberOf" : "",
 250       "isStatic" : false,
 251       "isConstructor" : false,
 252       "isPrivate" : false,
 253       "example" : "",
 254       "deprecated" : "",
 255       "since" : "",
 256       "see" : "",
 257       "exceptions" : "",
 258       "requires" : "",
 259       "params" : [
 260         {
 261           "name" : "col",
 262           "type" : "Number",
 263           "desc" : "The column index",
 264           "isOptional" : false
 265         },
 266         {
 267           "name" : "header",
 268           "type" : "String",
 269           "desc" : "The new header",
 270           "isOptional" : false
 271         }
 272       ],
 273       "returns" : []
 274     },
 275     {
 276       "name" : "getColumnCount",
 277       "type" : "function",
 278       "desc" : "Returns the number of columns.",
 279       "sig" : "()\n{\n\n}",
 280       "static" : false,
 281       "memberOf" : "",
 282       "isStatic" : false,
 283       "isConstructor" : false,
 284       "isPrivate" : false,
 285       "example" : "",
 286       "deprecated" : "",
 287       "since" : "",
 288       "see" : "",
 289       "exceptions" : "",
 290       "requires" : "",
 291       "params" : [],
 292       "returns" : [
 293         {
 294           "name" : "",
 295           "type" : "Number",
 296           "desc" : ""
 297         }
 298       ]
 299     },
 300     {
 301       "name" : "addColumn",
 302       "type" : "function",
 303       "desc" : "Add a column (experimental...) - defaults to adding to the end..",
 304       "sig" : "(config)",
 305       "static" : false,
 306       "memberOf" : "",
 307       "isStatic" : false,
 308       "isConstructor" : false,
 309       "isPrivate" : false,
 310       "example" : "",
 311       "deprecated" : "",
 312       "since" : "",
 313       "see" : "",
 314       "exceptions" : "",
 315       "requires" : "",
 316       "params" : [
 317         {
 318           "name" : "config",
 319           "type" : "Object",
 320           "desc" : "",
 321           "isOptional" : false
 322         }
 323       ],
 324       "returns" : []
 325     },
 326     {
 327       "name" : "getColumnHeader",
 328       "type" : "function",
 329       "desc" : "Returns the header for the specified column.",
 330       "sig" : "(col)",
 331       "static" : false,
 332       "memberOf" : "",
 333       "isStatic" : false,
 334       "isConstructor" : false,
 335       "isPrivate" : false,
 336       "example" : "",
 337       "deprecated" : "",
 338       "since" : "",
 339       "see" : "",
 340       "exceptions" : "",
 341       "requires" : "",
 342       "params" : [
 343         {
 344           "name" : "col",
 345           "type" : "Number",
 346           "desc" : "The column index",
 347           "isOptional" : false
 348         }
 349       ],
 350       "returns" : [
 351         {
 352           "name" : "",
 353           "type" : "String",
 354           "desc" : ""
 355         }
 356       ]
 357     },
 358     {
 359       "name" : "getRenderer",
 360       "type" : "function",
 361       "desc" : "Returns the rendering (formatting) function defined for the column.",
 362       "sig" : "(col)",
 363       "static" : false,
 364       "memberOf" : "",
 365       "isStatic" : false,
 366       "isConstructor" : false,
 367       "isPrivate" : false,
 368       "example" : "",
 369       "deprecated" : "",
 370       "since" : "",
 371       "see" : "",
 372       "exceptions" : "",
 373       "requires" : "",
 374       "params" : [
 375         {
 376           "name" : "col",
 377           "type" : "Number",
 378           "desc" : "The column index.",
 379           "isOptional" : false
 380         }
 381       ],
 382       "returns" : [
 383         {
 384           "name" : "",
 385           "type" : "Function",
 386           "desc" : "The function used to render the cell. See {@link #setRenderer}."
 387         }
 388       ]
 389     },
 390     {
 391       "name" : "getColumnTooltip",
 392       "type" : "function",
 393       "desc" : "Returns the tooltip for the specified column.",
 394       "sig" : "(col)",
 395       "static" : false,
 396       "memberOf" : "",
 397       "isStatic" : false,
 398       "isConstructor" : false,
 399       "isPrivate" : false,
 400       "example" : "",
 401       "deprecated" : "",
 402       "since" : "",
 403       "see" : "",
 404       "exceptions" : "",
 405       "requires" : "",
 406       "params" : [
 407         {
 408           "name" : "col",
 409           "type" : "Number",
 410           "desc" : "The column index",
 411           "isOptional" : false
 412         }
 413       ],
 414       "returns" : [
 415         {
 416           "name" : "",
 417           "type" : "String",
 418           "desc" : ""
 419         }
 420       ]
 421     },
 422     {
 423       "name" : "setColumnWidth",
 424       "type" : "function",
 425       "desc" : "Sets the width for a column.",
 426       "sig" : "(col, width)",
 427       "static" : false,
 428       "memberOf" : "",
 429       "isStatic" : false,
 430       "isConstructor" : false,
 431       "isPrivate" : false,
 432       "example" : "",
 433       "deprecated" : "",
 434       "since" : "",
 435       "see" : "",
 436       "exceptions" : "",
 437       "requires" : "",
 438       "params" : [
 439         {
 440           "name" : "col",
 441           "type" : "Number",
 442           "desc" : "The column index",
 443           "isOptional" : false
 444         },
 445         {
 446           "name" : "width",
 447           "type" : "Number",
 448           "desc" : "The new width",
 449           "isOptional" : false
 450         }
 451       ],
 452       "returns" : []
 453     },
 454     {
 455       "name" : "setDataIndex",
 456       "type" : "function",
 457       "desc" : "Sets the dataIndex for a column.",
 458       "sig" : "(col, dataIndex)",
 459       "static" : false,
 460       "memberOf" : "",
 461       "isStatic" : false,
 462       "isConstructor" : false,
 463       "isPrivate" : false,
 464       "example" : "",
 465       "deprecated" : "",
 466       "since" : "",
 467       "see" : "",
 468       "exceptions" : "",
 469       "requires" : "",
 470       "params" : [
 471         {
 472           "name" : "col",
 473           "type" : "Number",
 474           "desc" : "The column index",
 475           "isOptional" : false
 476         },
 477         {
 478           "name" : "dataIndex",
 479           "type" : "Number",
 480           "desc" : "The new dataIndex",
 481           "isOptional" : false
 482         }
 483       ],
 484       "returns" : []
 485     },
 486     {
 487       "name" : "isCellEditable",
 488       "type" : "function",
 489       "desc" : "Returns true if the cell is editable.",
 490       "sig" : "(colIndex, rowIndex)",
 491       "static" : false,
 492       "memberOf" : "",
 493       "isStatic" : false,
 494       "isConstructor" : false,
 495       "isPrivate" : false,
 496       "example" : "",
 497       "deprecated" : "",
 498       "since" : "",
 499       "see" : "",
 500       "exceptions" : "",
 501       "requires" : "",
 502       "params" : [
 503         {
 504           "name" : "colIndex",
 505           "type" : "Number",
 506           "desc" : "The column index",
 507           "isOptional" : false
 508         },
 509         {
 510           "name" : "rowIndex",
 511           "type" : "Number",
 512           "desc" : "The row index - this is nto actually used..?",
 513           "isOptional" : false
 514         }
 515       ],
 516       "returns" : [
 517         {
 518           "name" : "",
 519           "type" : "Boolean",
 520           "desc" : ""
 521         }
 522       ]
 523     },
 524     {
 525       "name" : "getColumnsBy",
 526       "type" : "function",
 527       "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
 528       "sig" : "(fn, scope)",
 529       "static" : false,
 530       "memberOf" : "",
 531       "isStatic" : false,
 532       "isConstructor" : false,
 533       "isPrivate" : false,
 534       "example" : "",
 535       "deprecated" : "",
 536       "since" : "",
 537       "see" : "",
 538       "exceptions" : "",
 539       "requires" : "",
 540       "params" : [
 541         {
 542           "name" : "fn",
 543           "type" : "Function",
 544           "desc" : "",
 545           "isOptional" : false
 546         },
 547         {
 548           "name" : "scope",
 549           "type" : "Object",
 550           "desc" : "(optional)",
 551           "isOptional" : false
 552         }
 553       ],
 554       "returns" : [
 555         {
 556           "name" : "",
 557           "type" : "Array",
 558           "desc" : "result"
 559         }
 560       ]
 561     },
 562     {
 563       "name" : "getColumnWidth",
 564       "type" : "function",
 565       "desc" : "Returns the width for the specified column.",
 566       "sig" : "(col, (optional))",
 567       "static" : false,
 568       "memberOf" : "",
 569       "isStatic" : false,
 570       "isConstructor" : false,
 571       "isPrivate" : false,
 572       "example" : "",
 573       "deprecated" : "",
 574       "since" : "",
 575       "see" : "",
 576       "exceptions" : "",
 577       "requires" : "",
 578       "params" : [
 579         {
 580           "name" : "col",
 581           "type" : "Number",
 582           "desc" : "The column index",
 583           "isOptional" : false
 584         },
 585         {
 586           "name" : "(optional)",
 587           "type" : "",
 588           "desc" : "{String} gridSize bootstrap width size.",
 589           "isOptional" : false
 590         }
 591       ],
 592       "returns" : [
 593         {
 594           "name" : "",
 595           "type" : "Number",
 596           "desc" : ""
 597         }
 598       ]
 599     },
 600     {
 601       "name" : "isFixed",
 602       "type" : "function",
 603       "desc" : "Returns true if the column width cannot be changed",
 604       "sig" : "()\n{\n\n}",
 605       "static" : false,
 606       "memberOf" : "",
 607       "isStatic" : false,
 608       "isConstructor" : false,
 609       "isPrivate" : false,
 610       "example" : "",
 611       "deprecated" : "",
 612       "since" : "",
 613       "see" : "",
 614       "exceptions" : "",
 615       "requires" : "",
 616       "params" : [],
 617       "returns" : []
 618     },
 619     {
 620       "name" : "getCellEditor",
 621       "type" : "function",
 622       "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
 623       "sig" : "(colIndex, rowIndex)",
 624       "static" : false,
 625       "memberOf" : "",
 626       "isStatic" : false,
 627       "isConstructor" : false,
 628       "isPrivate" : false,
 629       "example" : "",
 630       "deprecated" : "",
 631       "since" : "",
 632       "see" : "",
 633       "exceptions" : "",
 634       "requires" : "",
 635       "params" : [
 636         {
 637           "name" : "colIndex",
 638           "type" : "Number",
 639           "desc" : "The column index",
 640           "isOptional" : false
 641         },
 642         {
 643           "name" : "rowIndex",
 644           "type" : "Number",
 645           "desc" : "The row index",
 646           "isOptional" : false
 647         }
 648       ],
 649       "returns" : [
 650         {
 651           "name" : "",
 652           "type" : "Object",
 653           "desc" : ""
 654         }
 655       ]
 656     },
 657     {
 658       "name" : "getColumnId",
 659       "type" : "function",
 660       "desc" : "Returns the id of the column at the specified index.",
 661       "sig" : "(index)",
 662       "static" : false,
 663       "memberOf" : "",
 664       "isStatic" : false,
 665       "isConstructor" : false,
 666       "isPrivate" : false,
 667       "example" : "",
 668       "deprecated" : "",
 669       "since" : "",
 670       "see" : "",
 671       "exceptions" : "",
 672       "requires" : "",
 673       "params" : [
 674         {
 675           "name" : "index",
 676           "type" : "Number",
 677           "desc" : "The column index",
 678           "isOptional" : false
 679         }
 680       ],
 681       "returns" : [
 682         {
 683           "name" : "",
 684           "type" : "String",
 685           "desc" : "the id"
 686         }
 687       ]
 688     },
 689     {
 690       "name" : "getDataIndex",
 691       "type" : "function",
 692       "desc" : "Returns the dataIndex for the specified column.",
 693       "sig" : "(col)",
 694       "static" : false,
 695       "memberOf" : "",
 696       "isStatic" : false,
 697       "isConstructor" : false,
 698       "isPrivate" : false,
 699       "example" : "",
 700       "deprecated" : "",
 701       "since" : "",
 702       "see" : "",
 703       "exceptions" : "",
 704       "requires" : "",
 705       "params" : [
 706         {
 707           "name" : "col",
 708           "type" : "Number",
 709           "desc" : "The column index",
 710           "isOptional" : false
 711         }
 712       ],
 713       "returns" : [
 714         {
 715           "name" : "",
 716           "type" : "Number",
 717           "desc" : ""
 718         }
 719       ]
 720     },
 721     {
 722       "name" : "isResizable",
 723       "type" : "function",
 724       "desc" : "Returns true if the column can be resized",
 725       "sig" : "()\n{\n\n}",
 726       "static" : false,
 727       "memberOf" : "",
 728       "isStatic" : false,
 729       "isConstructor" : false,
 730       "isPrivate" : false,
 731       "example" : "",
 732       "deprecated" : "",
 733       "since" : "",
 734       "see" : "",
 735       "exceptions" : "",
 736       "requires" : "",
 737       "params" : [],
 738       "returns" : [
 739         {
 740           "name" : "",
 741           "type" : "Boolean",
 742           "desc" : ""
 743         }
 744       ]
 745     },
 746     {
 747       "name" : "setColumnTooltip",
 748       "type" : "function",
 749       "desc" : "Sets the tooltip for a column.",
 750       "sig" : "(col, tooltip)",
 751       "static" : false,
 752       "memberOf" : "",
 753       "isStatic" : false,
 754       "isConstructor" : false,
 755       "isPrivate" : false,
 756       "example" : "",
 757       "deprecated" : "",
 758       "since" : "",
 759       "see" : "",
 760       "exceptions" : "",
 761       "requires" : "",
 762       "params" : [
 763         {
 764           "name" : "col",
 765           "type" : "Number",
 766           "desc" : "The column index",
 767           "isOptional" : false
 768         },
 769         {
 770           "name" : "tooltip",
 771           "type" : "String",
 772           "desc" : "The new tooltip",
 773           "isOptional" : false
 774         }
 775       ],
 776       "returns" : []
 777     },
 778     {
 779       "name" : "setHidden",
 780       "type" : "function",
 781       "desc" : "Sets if a column is hidden.",
 782       "sig" : "(colIndex, hidden)",
 783       "static" : false,
 784       "memberOf" : "",
 785       "isStatic" : false,
 786       "isConstructor" : false,
 787       "isPrivate" : false,
 788       "example" : "",
 789       "deprecated" : "",
 790       "since" : "",
 791       "see" : "",
 792       "exceptions" : "",
 793       "requires" : "",
 794       "params" : [
 795         {
 796           "name" : "colIndex",
 797           "type" : "Number",
 798           "desc" : "The column index",
 799           "isOptional" : false
 800         },
 801         {
 802           "name" : "hidden",
 803           "type" : "Boolean",
 804           "desc" : "True if the column is hidden",
 805           "isOptional" : false
 806         }
 807       ],
 808       "returns" : []
 809     },
 810     {
 811       "name" : "setEditable",
 812       "type" : "function",
 813       "desc" : "Sets if a column is editable.",
 814       "sig" : "(col, editable)",
 815       "static" : false,
 816       "memberOf" : "",
 817       "isStatic" : false,
 818       "isConstructor" : false,
 819       "isPrivate" : false,
 820       "example" : "",
 821       "deprecated" : "",
 822       "since" : "",
 823       "see" : "",
 824       "exceptions" : "",
 825       "requires" : "",
 826       "params" : [
 827         {
 828           "name" : "col",
 829           "type" : "Number",
 830           "desc" : "The column index",
 831           "isOptional" : false
 832         },
 833         {
 834           "name" : "editable",
 835           "type" : "Boolean",
 836           "desc" : "True if the column is editable",
 837           "isOptional" : false
 838         }
 839       ],
 840       "returns" : []
 841     },
 842     {
 843       "name" : "getColumnById",
 844       "type" : "function",
 845       "desc" : "Returns the column for a specified id.",
 846       "sig" : "(id)",
 847       "static" : false,
 848       "memberOf" : "",
 849       "isStatic" : false,
 850       "isConstructor" : false,
 851       "isPrivate" : false,
 852       "example" : "",
 853       "deprecated" : "",
 854       "since" : "",
 855       "see" : "",
 856       "exceptions" : "",
 857       "requires" : "",
 858       "params" : [
 859         {
 860           "name" : "id",
 861           "type" : "String",
 862           "desc" : "The column id",
 863           "isOptional" : false
 864         }
 865       ],
 866       "returns" : [
 867         {
 868           "name" : "",
 869           "type" : "Object",
 870           "desc" : "the column"
 871         }
 872       ]
 873     },
 874     {
 875       "name" : "getColumnByDataIndex",
 876       "type" : "function",
 877       "desc" : "Returns the column Object for a specified dataIndex.",
 878       "sig" : "(dataIndex)",
 879       "static" : false,
 880       "memberOf" : "",
 881       "isStatic" : false,
 882       "isConstructor" : false,
 883       "isPrivate" : false,
 884       "example" : "",
 885       "deprecated" : "",
 886       "since" : "",
 887       "see" : "",
 888       "exceptions" : "",
 889       "requires" : "",
 890       "params" : [
 891         {
 892           "name" : "dataIndex",
 893           "type" : "String",
 894           "desc" : "The column dataIndex",
 895           "isOptional" : false
 896         }
 897       ],
 898       "returns" : [
 899         {
 900           "name" : "",
 901           "type" : "Object|Boolean",
 902           "desc" : "the column or false if not found"
 903         }
 904       ]
 905     },
 906     {
 907       "name" : "setEditor",
 908       "type" : "function",
 909       "desc" : "Sets the editor for a column.",
 910       "sig" : "(col, editor)",
 911       "static" : false,
 912       "memberOf" : "",
 913       "isStatic" : false,
 914       "isConstructor" : false,
 915       "isPrivate" : false,
 916       "example" : "",
 917       "deprecated" : "",
 918       "since" : "",
 919       "see" : "",
 920       "exceptions" : "",
 921       "requires" : "",
 922       "params" : [
 923         {
 924           "name" : "col",
 925           "type" : "Number",
 926           "desc" : "The column index",
 927           "isOptional" : false
 928         },
 929         {
 930           "name" : "editor",
 931           "type" : "Object",
 932           "desc" : "The editor object",
 933           "isOptional" : false
 934         }
 935       ],
 936       "returns" : []
 937     },
 938     {
 939       "name" : "findColumnIndex",
 940       "type" : "function",
 941       "desc" : "Returns the index for a specified column dataIndex.",
 942       "sig" : "(dataIndex)",
 943       "static" : false,
 944       "memberOf" : "",
 945       "isStatic" : false,
 946       "isConstructor" : false,
 947       "isPrivate" : false,
 948       "example" : "",
 949       "deprecated" : "",
 950       "since" : "",
 951       "see" : "",
 952       "exceptions" : "",
 953       "requires" : "",
 954       "params" : [
 955         {
 956           "name" : "dataIndex",
 957           "type" : "String",
 958           "desc" : "The column dataIndex",
 959           "isOptional" : false
 960         }
 961       ],
 962       "returns" : [
 963         {
 964           "name" : "",
 965           "type" : "Number",
 966           "desc" : "the index, or -1 if not found"
 967         }
 968       ]
 969     },
 970     {
 971       "name" : "isSortable",
 972       "type" : "function",
 973       "desc" : "Returns true if the specified column is sortable.",
 974       "sig" : "(col)",
 975       "static" : false,
 976       "memberOf" : "",
 977       "isStatic" : false,
 978       "isConstructor" : false,
 979       "isPrivate" : false,
 980       "example" : "",
 981       "deprecated" : "",
 982       "since" : "",
 983       "see" : "",
 984       "exceptions" : "",
 985       "requires" : "",
 986       "params" : [
 987         {
 988           "name" : "col",
 989           "type" : "Number",
 990           "desc" : "The column index",
 991           "isOptional" : false
 992         }
 993       ],
 994       "returns" : [
 995         {
 996           "name" : "",
 997           "type" : "Boolean",
 998           "desc" : ""
 999         }
1000       ]
1001     },
1002     {
1003       "name" : "getIndexById",
1004       "type" : "function",
1005       "desc" : "Returns the index for a specified column id.",
1006       "sig" : "(id)",
1007       "static" : false,
1008       "memberOf" : "",
1009       "isStatic" : false,
1010       "isConstructor" : false,
1011       "isPrivate" : false,
1012       "example" : "",
1013       "deprecated" : "",
1014       "since" : "",
1015       "see" : "",
1016       "exceptions" : "",
1017       "requires" : "",
1018       "params" : [
1019         {
1020           "name" : "id",
1021           "type" : "String",
1022           "desc" : "The column id",
1023           "isOptional" : false
1024         }
1025       ],
1026       "returns" : [
1027         {
1028           "name" : "",
1029           "type" : "Number",
1030           "desc" : "the index, or -1 if not found"
1031         }
1032       ]
1033     },
1034     {
1035       "name" : "getTotalWidth",
1036       "type" : "function",
1037       "desc" : "Returns the total width of all columns.",
1038       "sig" : "(includeHidden)",
1039       "static" : false,
1040       "memberOf" : "",
1041       "isStatic" : false,
1042       "isConstructor" : false,
1043       "isPrivate" : false,
1044       "example" : "",
1045       "deprecated" : "",
1046       "since" : "",
1047       "see" : "",
1048       "exceptions" : "",
1049       "requires" : "",
1050       "params" : [
1051         {
1052           "name" : "includeHidden",
1053           "type" : "Boolean",
1054           "desc" : "True to include hidden column widths",
1055           "isOptional" : false
1056         }
1057       ],
1058       "returns" : [
1059         {
1060           "name" : "",
1061           "type" : "Number",
1062           "desc" : ""
1063         }
1064       ]
1065     },
1066     {
1067       "name" : "purgeListeners",
1068       "type" : "function",
1069       "desc" : "Removes all listeners for this object",
1070       "sig" : "()\n{\n\n}",
1071       "static" : false,
1072       "memberOf" : "Roo.util.Observable",
1073       "isStatic" : false,
1074       "isConstructor" : false,
1075       "isPrivate" : false,
1076       "example" : "",
1077       "deprecated" : "",
1078       "since" : "",
1079       "see" : "",
1080       "exceptions" : "",
1081       "requires" : "",
1082       "params" : [],
1083       "returns" : []
1084     },
1085     {
1086       "name" : "on",
1087       "type" : "function",
1088       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1089       "sig" : "(eventName, handler, scope, options)",
1090       "static" : false,
1091       "memberOf" : "Roo.util.Observable",
1092       "isStatic" : false,
1093       "isConstructor" : false,
1094       "isPrivate" : false,
1095       "example" : "",
1096       "deprecated" : "",
1097       "since" : "",
1098       "see" : "",
1099       "exceptions" : "",
1100       "requires" : "",
1101       "params" : [
1102         {
1103           "name" : "eventName",
1104           "type" : "String",
1105           "desc" : "The type of event to listen for",
1106           "isOptional" : false
1107         },
1108         {
1109           "name" : "handler",
1110           "type" : "Function",
1111           "desc" : "The method the event invokes",
1112           "isOptional" : false
1113         },
1114         {
1115           "name" : "scope",
1116           "type" : "Object",
1117           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1118           "isOptional" : false
1119         },
1120         {
1121           "name" : "options",
1122           "type" : "Object",
1123           "desc" : "(optional)",
1124           "isOptional" : false
1125         }
1126       ],
1127       "returns" : []
1128     },
1129     {
1130       "name" : "un",
1131       "type" : "function",
1132       "desc" : "Removes a listener (shorthand for removeListener)",
1133       "sig" : "(eventName, handler, scope)",
1134       "static" : false,
1135       "memberOf" : "Roo.util.Observable",
1136       "isStatic" : false,
1137       "isConstructor" : false,
1138       "isPrivate" : false,
1139       "example" : "",
1140       "deprecated" : "",
1141       "since" : "",
1142       "see" : "",
1143       "exceptions" : "",
1144       "requires" : "",
1145       "params" : [
1146         {
1147           "name" : "eventName",
1148           "type" : "String",
1149           "desc" : "The type of event to listen for",
1150           "isOptional" : false
1151         },
1152         {
1153           "name" : "handler",
1154           "type" : "Function",
1155           "desc" : "The handler to remove",
1156           "isOptional" : false
1157         },
1158         {
1159           "name" : "scope",
1160           "type" : "Object",
1161           "desc" : "(optional) The scope (this object) for the handler",
1162           "isOptional" : false
1163         }
1164       ],
1165       "returns" : []
1166     },
1167     {
1168       "name" : "addEvents",
1169       "type" : "function",
1170       "desc" : "Used to define events on this Observable",
1171       "sig" : "(object)",
1172       "static" : false,
1173       "memberOf" : "Roo.util.Observable",
1174       "isStatic" : false,
1175       "isConstructor" : false,
1176       "isPrivate" : false,
1177       "example" : "",
1178       "deprecated" : "",
1179       "since" : "",
1180       "see" : "",
1181       "exceptions" : "",
1182       "requires" : "",
1183       "params" : [
1184         {
1185           "name" : "object",
1186           "type" : "Object",
1187           "desc" : "The object with the events defined",
1188           "isOptional" : false
1189         }
1190       ],
1191       "returns" : []
1192     },
1193     {
1194       "name" : "releaseCapture",
1195       "type" : "function",
1196       "desc" : "Removes <b>all</b> added captures from the Observable.",
1197       "sig" : "(o)",
1198       "static" : true,
1199       "memberOf" : "Roo.util.Observable",
1200       "isStatic" : true,
1201       "isConstructor" : false,
1202       "isPrivate" : false,
1203       "example" : "",
1204       "deprecated" : "",
1205       "since" : "",
1206       "see" : "",
1207       "exceptions" : "",
1208       "requires" : "",
1209       "params" : [
1210         {
1211           "name" : "o",
1212           "type" : "Observable",
1213           "desc" : "The Observable to release",
1214           "isOptional" : false
1215         }
1216       ],
1217       "returns" : []
1218     },
1219     {
1220       "name" : "removeListener",
1221       "type" : "function",
1222       "desc" : "Removes a listener",
1223       "sig" : "(eventName, handler, scope)",
1224       "static" : false,
1225       "memberOf" : "Roo.util.Observable",
1226       "isStatic" : false,
1227       "isConstructor" : false,
1228       "isPrivate" : false,
1229       "example" : "",
1230       "deprecated" : "",
1231       "since" : "",
1232       "see" : "",
1233       "exceptions" : "",
1234       "requires" : "",
1235       "params" : [
1236         {
1237           "name" : "eventName",
1238           "type" : "String",
1239           "desc" : "The type of event to listen for",
1240           "isOptional" : false
1241         },
1242         {
1243           "name" : "handler",
1244           "type" : "Function",
1245           "desc" : "The handler to remove",
1246           "isOptional" : false
1247         },
1248         {
1249           "name" : "scope",
1250           "type" : "Object",
1251           "desc" : "(optional) The scope (this object) for the handler",
1252           "isOptional" : false
1253         }
1254       ],
1255       "returns" : []
1256     },
1257     {
1258       "name" : "fireEvent",
1259       "type" : "function",
1260       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1261       "sig" : "(eventName, args)",
1262       "static" : false,
1263       "memberOf" : "Roo.util.Observable",
1264       "isStatic" : false,
1265       "isConstructor" : false,
1266       "isPrivate" : false,
1267       "example" : "",
1268       "deprecated" : "",
1269       "since" : "",
1270       "see" : "",
1271       "exceptions" : "",
1272       "requires" : "",
1273       "params" : [
1274         {
1275           "name" : "eventName",
1276           "type" : "String",
1277           "desc" : "",
1278           "isOptional" : false
1279         },
1280         {
1281           "name" : "args",
1282           "type" : "Object...",
1283           "desc" : "Variable number of parameters are passed to handlers",
1284           "isOptional" : false
1285         }
1286       ],
1287       "returns" : [
1288         {
1289           "name" : "",
1290           "type" : "Boolean",
1291           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1292         }
1293       ]
1294     },
1295     {
1296       "name" : "hasListener",
1297       "type" : "function",
1298       "desc" : "Checks to see if this object has any listeners for a specified event",
1299       "sig" : "(eventName)",
1300       "static" : false,
1301       "memberOf" : "Roo.util.Observable",
1302       "isStatic" : false,
1303       "isConstructor" : false,
1304       "isPrivate" : false,
1305       "example" : "",
1306       "deprecated" : "",
1307       "since" : "",
1308       "see" : "",
1309       "exceptions" : "",
1310       "requires" : "",
1311       "params" : [
1312         {
1313           "name" : "eventName",
1314           "type" : "String",
1315           "desc" : "The name of the event to check for",
1316           "isOptional" : false
1317         }
1318       ],
1319       "returns" : [
1320         {
1321           "name" : "",
1322           "type" : "Boolean",
1323           "desc" : "True if the event is being listened for, else false"
1324         }
1325       ]
1326     },
1327     {
1328       "name" : "capture",
1329       "type" : "function",
1330       "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.",
1331       "sig" : "(o, fn, scope)",
1332       "static" : true,
1333       "memberOf" : "Roo.util.Observable",
1334       "isStatic" : true,
1335       "isConstructor" : false,
1336       "isPrivate" : false,
1337       "example" : "",
1338       "deprecated" : "",
1339       "since" : "",
1340       "see" : "",
1341       "exceptions" : "",
1342       "requires" : "",
1343       "params" : [
1344         {
1345           "name" : "o",
1346           "type" : "Observable",
1347           "desc" : "The Observable to capture",
1348           "isOptional" : false
1349         },
1350         {
1351           "name" : "fn",
1352           "type" : "Function",
1353           "desc" : "The function to call",
1354           "isOptional" : false
1355         },
1356         {
1357           "name" : "scope",
1358           "type" : "Object",
1359           "desc" : "(optional) The scope (this object) for the fn",
1360           "isOptional" : false
1361         }
1362       ],
1363       "returns" : []
1364     },
1365     {
1366       "name" : "addListener",
1367       "type" : "function",
1368       "desc" : "Appends an event handler to this component",
1369       "sig" : "(eventName, handler, scope, options)",
1370       "static" : false,
1371       "memberOf" : "Roo.util.Observable",
1372       "isStatic" : false,
1373       "isConstructor" : false,
1374       "isPrivate" : false,
1375       "example" : "",
1376       "deprecated" : "",
1377       "since" : "",
1378       "see" : "",
1379       "exceptions" : "",
1380       "requires" : "",
1381       "params" : [
1382         {
1383           "name" : "eventName",
1384           "type" : "String",
1385           "desc" : "The type of event to listen for",
1386           "isOptional" : false
1387         },
1388         {
1389           "name" : "handler",
1390           "type" : "Function",
1391           "desc" : "The method the event invokes",
1392           "isOptional" : false
1393         },
1394         {
1395           "name" : "scope",
1396           "type" : "Object",
1397           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1398           "isOptional" : false
1399         },
1400         {
1401           "name" : "options",
1402           "type" : "Object",
1403           "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>",
1404           "isOptional" : false
1405         }
1406       ],
1407       "returns" : []
1408     }
1409   ],
1410   "events" : [
1411     {
1412       "name" : "hiddenchange",
1413       "type" : "function",
1414       "desc" : "Fires when a column is hidden or \"unhidden\".",
1415       "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
1416       "memberOf" : "",
1417       "example" : "",
1418       "deprecated" : "",
1419       "since" : "",
1420       "see" : "",
1421       "params" : [
1422         {
1423           "name" : "this",
1424           "type" : "ColumnModel",
1425           "desc" : "",
1426           "isOptional" : false
1427         },
1428         {
1429           "name" : "columnIndex",
1430           "type" : "Number",
1431           "desc" : "The column index",
1432           "isOptional" : false
1433         },
1434         {
1435           "name" : "hidden",
1436           "type" : "Boolean",
1437           "desc" : "true if hidden, false otherwise",
1438           "isOptional" : false
1439         }
1440       ],
1441       "returns" : []
1442     },
1443     {
1444       "name" : "headerchange",
1445       "type" : "function",
1446       "desc" : "Fires when the text of a header changes.",
1447       "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
1448       "memberOf" : "",
1449       "example" : "",
1450       "deprecated" : "",
1451       "since" : "",
1452       "see" : "",
1453       "params" : [
1454         {
1455           "name" : "this",
1456           "type" : "ColumnModel",
1457           "desc" : "",
1458           "isOptional" : false
1459         },
1460         {
1461           "name" : "columnIndex",
1462           "type" : "Number",
1463           "desc" : "The column index",
1464           "isOptional" : false
1465         },
1466         {
1467           "name" : "newText",
1468           "type" : "Number",
1469           "desc" : "The new header text",
1470           "isOptional" : false
1471         }
1472       ],
1473       "returns" : []
1474     },
1475     {
1476       "name" : "columlockchange",
1477       "type" : "function",
1478       "desc" : "Fires when a column's locked state is changed",
1479       "sig" : "function (_self, colIndex, locked)\n{\n\n}",
1480       "memberOf" : "",
1481       "example" : "",
1482       "deprecated" : "",
1483       "since" : "",
1484       "see" : "",
1485       "params" : [
1486         {
1487           "name" : "this",
1488           "type" : "ColumnModel",
1489           "desc" : "",
1490           "isOptional" : false
1491         },
1492         {
1493           "name" : "colIndex",
1494           "type" : "Number",
1495           "desc" : "",
1496           "isOptional" : false
1497         },
1498         {
1499           "name" : "locked",
1500           "type" : "Boolean",
1501           "desc" : "true if locked",
1502           "isOptional" : false
1503         }
1504       ],
1505       "returns" : []
1506     },
1507     {
1508       "name" : "columnmoved",
1509       "type" : "function",
1510       "desc" : "Fires when a column is moved.",
1511       "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
1512       "memberOf" : "",
1513       "example" : "",
1514       "deprecated" : "",
1515       "since" : "",
1516       "see" : "",
1517       "params" : [
1518         {
1519           "name" : "this",
1520           "type" : "ColumnModel",
1521           "desc" : "",
1522           "isOptional" : false
1523         },
1524         {
1525           "name" : "oldIndex",
1526           "type" : "Number",
1527           "desc" : "",
1528           "isOptional" : false
1529         },
1530         {
1531           "name" : "newIndex",
1532           "type" : "Number",
1533           "desc" : "",
1534           "isOptional" : false
1535         }
1536       ],
1537       "returns" : []
1538     },
1539     {
1540       "name" : "widthchange",
1541       "type" : "function",
1542       "desc" : "Fires when the width of a column changes.",
1543       "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
1544       "memberOf" : "",
1545       "example" : "",
1546       "deprecated" : "",
1547       "since" : "",
1548       "see" : "",
1549       "params" : [
1550         {
1551           "name" : "this",
1552           "type" : "ColumnModel",
1553           "desc" : "",
1554           "isOptional" : false
1555         },
1556         {
1557           "name" : "columnIndex",
1558           "type" : "Number",
1559           "desc" : "The column index",
1560           "isOptional" : false
1561         },
1562         {
1563           "name" : "newWidth",
1564           "type" : "Number",
1565           "desc" : "The new width",
1566           "isOptional" : false
1567         }
1568       ],
1569       "returns" : []
1570     }
1571   ]
1572 }