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