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