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