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" : "addColumn",
 263       "desc" : "Add a column (experimental...) - defaults to adding to the end..",
 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" : "config",
 275           "type" : "Object",
 276           "desc" : "",
 277           "isOptional" : false
 278         }
 279       ],
 280       "returns" : []
 281     },
 282     {
 283       "name" : "getColumnHeader",
 284       "desc" : "Returns the header for the specified column.",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "memberOf" : "Roo.grid.ColumnModel",
 289       "example" : "",
 290       "deprecated" : "",
 291       "since" : "",
 292       "see" : "",
 293       "params" : [
 294         {
 295           "name" : "col",
 296           "type" : "Number",
 297           "desc" : "The column index",
 298           "isOptional" : false
 299         }
 300       ],
 301       "returns" : [
 302         {
 303           "name" : "",
 304           "type" : "String",
 305           "desc" : ""
 306         }
 307       ]
 308     },
 309     {
 310       "name" : "getRenderer",
 311       "desc" : "Returns the rendering (formatting) function defined for the column.",
 312       "isStatic" : false,
 313       "isConstructor" : false,
 314       "isPrivate" : false,
 315       "memberOf" : "Roo.grid.ColumnModel",
 316       "example" : "",
 317       "deprecated" : "",
 318       "since" : "",
 319       "see" : "",
 320       "params" : [
 321         {
 322           "name" : "col",
 323           "type" : "Number",
 324           "desc" : "The column index.",
 325           "isOptional" : false
 326         }
 327       ],
 328       "returns" : [
 329         {
 330           "name" : "",
 331           "type" : "Function",
 332           "desc" : "The function used to render the cell. See {@link #setRenderer}."
 333         }
 334       ]
 335     },
 336     {
 337       "name" : "getColumnTooltip",
 338       "desc" : "Returns the tooltip for the specified column.",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "memberOf" : "Roo.grid.ColumnModel",
 343       "example" : "",
 344       "deprecated" : "",
 345       "since" : "",
 346       "see" : "",
 347       "params" : [
 348         {
 349           "name" : "col",
 350           "type" : "Number",
 351           "desc" : "The column index",
 352           "isOptional" : false
 353         }
 354       ],
 355       "returns" : [
 356         {
 357           "name" : "",
 358           "type" : "String",
 359           "desc" : ""
 360         }
 361       ]
 362     },
 363     {
 364       "name" : "setColumnWidth",
 365       "desc" : "Sets the width for a column.",
 366       "isStatic" : false,
 367       "isConstructor" : false,
 368       "isPrivate" : false,
 369       "memberOf" : "Roo.grid.ColumnModel",
 370       "example" : "",
 371       "deprecated" : "",
 372       "since" : "",
 373       "see" : "",
 374       "params" : [
 375         {
 376           "name" : "col",
 377           "type" : "Number",
 378           "desc" : "The column index",
 379           "isOptional" : false
 380         },
 381         {
 382           "name" : "width",
 383           "type" : "Number",
 384           "desc" : "The new width",
 385           "isOptional" : false
 386         }
 387       ],
 388       "returns" : []
 389     },
 390     {
 391       "name" : "setDataIndex",
 392       "desc" : "Sets the dataIndex for a column.",
 393       "isStatic" : false,
 394       "isConstructor" : false,
 395       "isPrivate" : false,
 396       "memberOf" : "Roo.grid.ColumnModel",
 397       "example" : "",
 398       "deprecated" : "",
 399       "since" : "",
 400       "see" : "",
 401       "params" : [
 402         {
 403           "name" : "col",
 404           "type" : "Number",
 405           "desc" : "The column index",
 406           "isOptional" : false
 407         },
 408         {
 409           "name" : "dataIndex",
 410           "type" : "Number",
 411           "desc" : "The new dataIndex",
 412           "isOptional" : false
 413         }
 414       ],
 415       "returns" : []
 416     },
 417     {
 418       "name" : "isCellEditable",
 419       "desc" : "Returns true if the cell is editable.",
 420       "isStatic" : false,
 421       "isConstructor" : false,
 422       "isPrivate" : false,
 423       "memberOf" : "Roo.grid.ColumnModel",
 424       "example" : "",
 425       "deprecated" : "",
 426       "since" : "",
 427       "see" : "",
 428       "params" : [
 429         {
 430           "name" : "colIndex",
 431           "type" : "Number",
 432           "desc" : "The column index",
 433           "isOptional" : false
 434         },
 435         {
 436           "name" : "rowIndex",
 437           "type" : "Number",
 438           "desc" : "The row index - this is nto actually used..?",
 439           "isOptional" : false
 440         }
 441       ],
 442       "returns" : [
 443         {
 444           "name" : "",
 445           "type" : "Boolean",
 446           "desc" : ""
 447         }
 448       ]
 449     },
 450     {
 451       "name" : "getColumnsBy",
 452       "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
 453       "isStatic" : false,
 454       "isConstructor" : false,
 455       "isPrivate" : false,
 456       "memberOf" : "Roo.grid.ColumnModel",
 457       "example" : "",
 458       "deprecated" : "",
 459       "since" : "",
 460       "see" : "",
 461       "params" : [
 462         {
 463           "name" : "fn",
 464           "type" : "Function",
 465           "desc" : "",
 466           "isOptional" : false
 467         },
 468         {
 469           "name" : "scope",
 470           "type" : "Object",
 471           "desc" : "(optional)",
 472           "isOptional" : false
 473         }
 474       ],
 475       "returns" : [
 476         {
 477           "name" : "",
 478           "type" : "Array",
 479           "desc" : "result"
 480         }
 481       ]
 482     },
 483     {
 484       "name" : "getColumnWidth",
 485       "desc" : "Returns the width for the specified column.",
 486       "isStatic" : false,
 487       "isConstructor" : false,
 488       "isPrivate" : false,
 489       "memberOf" : "Roo.grid.ColumnModel",
 490       "example" : "",
 491       "deprecated" : "",
 492       "since" : "",
 493       "see" : "",
 494       "params" : [
 495         {
 496           "name" : "col",
 497           "type" : "Number",
 498           "desc" : "The column index",
 499           "isOptional" : false
 500         }
 501       ],
 502       "returns" : [
 503         {
 504           "name" : "",
 505           "type" : "Number",
 506           "desc" : ""
 507         }
 508       ]
 509     },
 510     {
 511       "name" : "isFixed",
 512       "desc" : "Returns true if the column width cannot be changed",
 513       "isStatic" : false,
 514       "isConstructor" : false,
 515       "isPrivate" : false,
 516       "memberOf" : "Roo.grid.ColumnModel",
 517       "example" : "",
 518       "deprecated" : "",
 519       "since" : "",
 520       "see" : "",
 521       "params" : [],
 522       "returns" : []
 523     },
 524     {
 525       "name" : "getCellEditor",
 526       "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
 527       "isStatic" : false,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "memberOf" : "Roo.grid.ColumnModel",
 531       "example" : "",
 532       "deprecated" : "",
 533       "since" : "",
 534       "see" : "",
 535       "params" : [
 536         {
 537           "name" : "colIndex",
 538           "type" : "Number",
 539           "desc" : "The column index",
 540           "isOptional" : false
 541         },
 542         {
 543           "name" : "rowIndex",
 544           "type" : "Number",
 545           "desc" : "The row index",
 546           "isOptional" : false
 547         }
 548       ],
 549       "returns" : [
 550         {
 551           "name" : "",
 552           "type" : "Object",
 553           "desc" : ""
 554         }
 555       ]
 556     },
 557     {
 558       "name" : "getColumnId",
 559       "desc" : "Returns the id of the column at the specified index.",
 560       "isStatic" : false,
 561       "isConstructor" : false,
 562       "isPrivate" : false,
 563       "memberOf" : "Roo.grid.ColumnModel",
 564       "example" : "",
 565       "deprecated" : "",
 566       "since" : "",
 567       "see" : "",
 568       "params" : [
 569         {
 570           "name" : "index",
 571           "type" : "Number",
 572           "desc" : "The column index",
 573           "isOptional" : false
 574         }
 575       ],
 576       "returns" : [
 577         {
 578           "name" : "",
 579           "type" : "String",
 580           "desc" : "the id"
 581         }
 582       ]
 583     },
 584     {
 585       "name" : "getDataIndex",
 586       "desc" : "Returns the dataIndex for the specified column.",
 587       "isStatic" : false,
 588       "isConstructor" : false,
 589       "isPrivate" : false,
 590       "memberOf" : "Roo.grid.ColumnModel",
 591       "example" : "",
 592       "deprecated" : "",
 593       "since" : "",
 594       "see" : "",
 595       "params" : [
 596         {
 597           "name" : "col",
 598           "type" : "Number",
 599           "desc" : "The column index",
 600           "isOptional" : false
 601         }
 602       ],
 603       "returns" : [
 604         {
 605           "name" : "",
 606           "type" : "Number",
 607           "desc" : ""
 608         }
 609       ]
 610     },
 611     {
 612       "name" : "isResizable",
 613       "desc" : "Returns true if the column can be resized",
 614       "isStatic" : false,
 615       "isConstructor" : false,
 616       "isPrivate" : false,
 617       "memberOf" : "Roo.grid.ColumnModel",
 618       "example" : "",
 619       "deprecated" : "",
 620       "since" : "",
 621       "see" : "",
 622       "params" : [],
 623       "returns" : [
 624         {
 625           "name" : "",
 626           "type" : "Boolean",
 627           "desc" : ""
 628         }
 629       ]
 630     },
 631     {
 632       "name" : "setColumnTooltip",
 633       "desc" : "Sets the tooltip for a column.",
 634       "isStatic" : false,
 635       "isConstructor" : false,
 636       "isPrivate" : false,
 637       "memberOf" : "Roo.grid.ColumnModel",
 638       "example" : "",
 639       "deprecated" : "",
 640       "since" : "",
 641       "see" : "",
 642       "params" : [
 643         {
 644           "name" : "col",
 645           "type" : "Number",
 646           "desc" : "The column index",
 647           "isOptional" : false
 648         },
 649         {
 650           "name" : "tooltip",
 651           "type" : "String",
 652           "desc" : "The new tooltip",
 653           "isOptional" : false
 654         }
 655       ],
 656       "returns" : []
 657     },
 658     {
 659       "name" : "setHidden",
 660       "desc" : "Sets if a column is hidden.",
 661       "isStatic" : false,
 662       "isConstructor" : false,
 663       "isPrivate" : false,
 664       "memberOf" : "Roo.grid.ColumnModel",
 665       "example" : "",
 666       "deprecated" : "",
 667       "since" : "",
 668       "see" : "",
 669       "params" : [
 670         {
 671           "name" : "colIndex",
 672           "type" : "Number",
 673           "desc" : "The column index",
 674           "isOptional" : false
 675         },
 676         {
 677           "name" : "hidden",
 678           "type" : "Boolean",
 679           "desc" : "True if the column is hidden",
 680           "isOptional" : false
 681         }
 682       ],
 683       "returns" : []
 684     },
 685     {
 686       "name" : "setEditable",
 687       "desc" : "Sets if a column is editable.",
 688       "isStatic" : false,
 689       "isConstructor" : false,
 690       "isPrivate" : false,
 691       "memberOf" : "Roo.grid.ColumnModel",
 692       "example" : "",
 693       "deprecated" : "",
 694       "since" : "",
 695       "see" : "",
 696       "params" : [
 697         {
 698           "name" : "col",
 699           "type" : "Number",
 700           "desc" : "The column index",
 701           "isOptional" : false
 702         },
 703         {
 704           "name" : "editable",
 705           "type" : "Boolean",
 706           "desc" : "True if the column is editable",
 707           "isOptional" : false
 708         }
 709       ],
 710       "returns" : []
 711     },
 712     {
 713       "name" : "getColumnById",
 714       "desc" : "Returns the column for a specified id.",
 715       "isStatic" : false,
 716       "isConstructor" : false,
 717       "isPrivate" : false,
 718       "memberOf" : "Roo.grid.ColumnModel",
 719       "example" : "",
 720       "deprecated" : "",
 721       "since" : "",
 722       "see" : "",
 723       "params" : [
 724         {
 725           "name" : "id",
 726           "type" : "String",
 727           "desc" : "The column id",
 728           "isOptional" : false
 729         }
 730       ],
 731       "returns" : [
 732         {
 733           "name" : "",
 734           "type" : "Object",
 735           "desc" : "the column"
 736         }
 737       ]
 738     },
 739     {
 740       "name" : "getColumnByDataIndex",
 741       "desc" : "Returns the column Object for a specified dataIndex.",
 742       "isStatic" : false,
 743       "isConstructor" : false,
 744       "isPrivate" : false,
 745       "memberOf" : "Roo.grid.ColumnModel",
 746       "example" : "",
 747       "deprecated" : "",
 748       "since" : "",
 749       "see" : "",
 750       "params" : [
 751         {
 752           "name" : "dataIndex",
 753           "type" : "String",
 754           "desc" : "The column dataIndex",
 755           "isOptional" : false
 756         }
 757       ],
 758       "returns" : [
 759         {
 760           "name" : "",
 761           "type" : "Object|Boolean",
 762           "desc" : "the column or false if not found"
 763         }
 764       ]
 765     },
 766     {
 767       "name" : "setEditor",
 768       "desc" : "Sets the editor for a column.",
 769       "isStatic" : false,
 770       "isConstructor" : false,
 771       "isPrivate" : false,
 772       "memberOf" : "Roo.grid.ColumnModel",
 773       "example" : "",
 774       "deprecated" : "",
 775       "since" : "",
 776       "see" : "",
 777       "params" : [
 778         {
 779           "name" : "col",
 780           "type" : "Number",
 781           "desc" : "The column index",
 782           "isOptional" : false
 783         },
 784         {
 785           "name" : "editor",
 786           "type" : "Object",
 787           "desc" : "The editor object",
 788           "isOptional" : false
 789         }
 790       ],
 791       "returns" : []
 792     },
 793     {
 794       "name" : "findColumnIndex",
 795       "desc" : "Returns the index for a specified column dataIndex.",
 796       "isStatic" : false,
 797       "isConstructor" : false,
 798       "isPrivate" : false,
 799       "memberOf" : "Roo.grid.ColumnModel",
 800       "example" : "",
 801       "deprecated" : "",
 802       "since" : "",
 803       "see" : "",
 804       "params" : [
 805         {
 806           "name" : "dataIndex",
 807           "type" : "String",
 808           "desc" : "The column dataIndex",
 809           "isOptional" : false
 810         }
 811       ],
 812       "returns" : [
 813         {
 814           "name" : "",
 815           "type" : "Number",
 816           "desc" : "the index, or -1 if not found"
 817         }
 818       ]
 819     },
 820     {
 821       "name" : "isSortable",
 822       "desc" : "Returns true if the specified column is sortable.",
 823       "isStatic" : false,
 824       "isConstructor" : false,
 825       "isPrivate" : false,
 826       "memberOf" : "Roo.grid.ColumnModel",
 827       "example" : "",
 828       "deprecated" : "",
 829       "since" : "",
 830       "see" : "",
 831       "params" : [
 832         {
 833           "name" : "col",
 834           "type" : "Number",
 835           "desc" : "The column index",
 836           "isOptional" : false
 837         }
 838       ],
 839       "returns" : [
 840         {
 841           "name" : "",
 842           "type" : "Boolean",
 843           "desc" : ""
 844         }
 845       ]
 846     },
 847     {
 848       "name" : "getIndexById",
 849       "desc" : "Returns the index for a specified column id.",
 850       "isStatic" : false,
 851       "isConstructor" : false,
 852       "isPrivate" : false,
 853       "memberOf" : "Roo.grid.ColumnModel",
 854       "example" : "",
 855       "deprecated" : "",
 856       "since" : "",
 857       "see" : "",
 858       "params" : [
 859         {
 860           "name" : "id",
 861           "type" : "String",
 862           "desc" : "The column id",
 863           "isOptional" : false
 864         }
 865       ],
 866       "returns" : [
 867         {
 868           "name" : "",
 869           "type" : "Number",
 870           "desc" : "the index, or -1 if not found"
 871         }
 872       ]
 873     },
 874     {
 875       "name" : "getTotalWidth",
 876       "desc" : "Returns the total width of all columns.",
 877       "isStatic" : false,
 878       "isConstructor" : false,
 879       "isPrivate" : false,
 880       "memberOf" : "Roo.grid.ColumnModel",
 881       "example" : "",
 882       "deprecated" : "",
 883       "since" : "",
 884       "see" : "",
 885       "params" : [
 886         {
 887           "name" : "includeHidden",
 888           "type" : "Boolean",
 889           "desc" : "True to include hidden column widths",
 890           "isOptional" : false
 891         }
 892       ],
 893       "returns" : [
 894         {
 895           "name" : "",
 896           "type" : "Number",
 897           "desc" : ""
 898         }
 899       ]
 900     },
 901     {
 902       "name" : "purgeListeners",
 903       "desc" : "Removes all listeners for this object",
 904       "isStatic" : false,
 905       "isConstructor" : false,
 906       "isPrivate" : false,
 907       "memberOf" : "Roo.util.Observable",
 908       "example" : "",
 909       "deprecated" : "",
 910       "since" : "",
 911       "see" : "",
 912       "params" : [],
 913       "returns" : []
 914     },
 915     {
 916       "name" : "on",
 917       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 918       "isStatic" : false,
 919       "isConstructor" : false,
 920       "isPrivate" : false,
 921       "memberOf" : "Roo.util.Observable",
 922       "example" : "",
 923       "deprecated" : "",
 924       "since" : "",
 925       "see" : "",
 926       "params" : [
 927         {
 928           "name" : "eventName",
 929           "type" : "String",
 930           "desc" : "The type of event to listen for",
 931           "isOptional" : false
 932         },
 933         {
 934           "name" : "handler",
 935           "type" : "Function",
 936           "desc" : "The method the event invokes",
 937           "isOptional" : false
 938         },
 939         {
 940           "name" : "scope",
 941           "type" : "Object",
 942           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 943           "isOptional" : false
 944         },
 945         {
 946           "name" : "options",
 947           "type" : "Object",
 948           "desc" : "(optional)",
 949           "isOptional" : false
 950         }
 951       ],
 952       "returns" : []
 953     },
 954     {
 955       "name" : "un",
 956       "desc" : "Removes a listener (shorthand for removeListener)",
 957       "isStatic" : false,
 958       "isConstructor" : false,
 959       "isPrivate" : false,
 960       "memberOf" : "Roo.util.Observable",
 961       "example" : "",
 962       "deprecated" : "",
 963       "since" : "",
 964       "see" : "",
 965       "params" : [
 966         {
 967           "name" : "eventName",
 968           "type" : "String",
 969           "desc" : "The type of event to listen for",
 970           "isOptional" : false
 971         },
 972         {
 973           "name" : "handler",
 974           "type" : "Function",
 975           "desc" : "The handler to remove",
 976           "isOptional" : false
 977         },
 978         {
 979           "name" : "scope",
 980           "type" : "Object",
 981           "desc" : "(optional) The scope (this object) for the handler",
 982           "isOptional" : false
 983         }
 984       ],
 985       "returns" : []
 986     },
 987     {
 988       "name" : "addEvents",
 989       "desc" : "Used to define events on this Observable",
 990       "isStatic" : false,
 991       "isConstructor" : false,
 992       "isPrivate" : false,
 993       "memberOf" : "Roo.util.Observable",
 994       "example" : "",
 995       "deprecated" : "",
 996       "since" : "",
 997       "see" : "",
 998       "params" : [
 999         {
1000           "name" : "object",
1001           "type" : "Object",
1002           "desc" : "The object with the events defined",
1003           "isOptional" : false
1004         }
1005       ],
1006       "returns" : []
1007     },
1008     {
1009       "name" : "releaseCapture",
1010       "desc" : "Removes <b>all</b> added captures from the Observable.",
1011       "isStatic" : true,
1012       "isConstructor" : false,
1013       "isPrivate" : false,
1014       "memberOf" : "Roo.util.Observable",
1015       "example" : "",
1016       "deprecated" : "",
1017       "since" : "",
1018       "see" : "",
1019       "params" : [
1020         {
1021           "name" : "o",
1022           "type" : "Observable",
1023           "desc" : "The Observable to release",
1024           "isOptional" : false
1025         }
1026       ],
1027       "returns" : []
1028     },
1029     {
1030       "name" : "removeListener",
1031       "desc" : "Removes a listener",
1032       "isStatic" : false,
1033       "isConstructor" : false,
1034       "isPrivate" : false,
1035       "memberOf" : "Roo.util.Observable",
1036       "example" : "",
1037       "deprecated" : "",
1038       "since" : "",
1039       "see" : "",
1040       "params" : [
1041         {
1042           "name" : "eventName",
1043           "type" : "String",
1044           "desc" : "The type of event to listen for",
1045           "isOptional" : false
1046         },
1047         {
1048           "name" : "handler",
1049           "type" : "Function",
1050           "desc" : "The handler to remove",
1051           "isOptional" : false
1052         },
1053         {
1054           "name" : "scope",
1055           "type" : "Object",
1056           "desc" : "(optional) The scope (this object) for the handler",
1057           "isOptional" : false
1058         }
1059       ],
1060       "returns" : []
1061     },
1062     {
1063       "name" : "fireEvent",
1064       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1065       "isStatic" : false,
1066       "isConstructor" : false,
1067       "isPrivate" : false,
1068       "memberOf" : "Roo.util.Observable",
1069       "example" : "",
1070       "deprecated" : "",
1071       "since" : "",
1072       "see" : "",
1073       "params" : [
1074         {
1075           "name" : "eventName",
1076           "type" : "String",
1077           "desc" : "",
1078           "isOptional" : false
1079         },
1080         {
1081           "name" : "args",
1082           "type" : "Object...",
1083           "desc" : "Variable number of parameters are passed to handlers",
1084           "isOptional" : false
1085         }
1086       ],
1087       "returns" : [
1088         {
1089           "name" : "",
1090           "type" : "Boolean",
1091           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1092         }
1093       ]
1094     },
1095     {
1096       "name" : "hasListener",
1097       "desc" : "Checks to see if this object has any listeners for a specified event",
1098       "isStatic" : false,
1099       "isConstructor" : false,
1100       "isPrivate" : false,
1101       "memberOf" : "Roo.util.Observable",
1102       "example" : "",
1103       "deprecated" : "",
1104       "since" : "",
1105       "see" : "",
1106       "params" : [
1107         {
1108           "name" : "eventName",
1109           "type" : "String",
1110           "desc" : "The name of the event to check for",
1111           "isOptional" : false
1112         }
1113       ],
1114       "returns" : [
1115         {
1116           "name" : "",
1117           "type" : "Boolean",
1118           "desc" : "True if the event is being listened for, else false"
1119         }
1120       ]
1121     },
1122     {
1123       "name" : "capture",
1124       "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.",
1125       "isStatic" : true,
1126       "isConstructor" : false,
1127       "isPrivate" : false,
1128       "memberOf" : "Roo.util.Observable",
1129       "example" : "",
1130       "deprecated" : "",
1131       "since" : "",
1132       "see" : "",
1133       "params" : [
1134         {
1135           "name" : "o",
1136           "type" : "Observable",
1137           "desc" : "The Observable to capture",
1138           "isOptional" : false
1139         },
1140         {
1141           "name" : "fn",
1142           "type" : "Function",
1143           "desc" : "The function to call",
1144           "isOptional" : false
1145         },
1146         {
1147           "name" : "scope",
1148           "type" : "Object",
1149           "desc" : "(optional) The scope (this object) for the fn",
1150           "isOptional" : false
1151         }
1152       ],
1153       "returns" : []
1154     },
1155     {
1156       "name" : "addListener",
1157       "desc" : "Appends an event handler to this component",
1158       "isStatic" : false,
1159       "isConstructor" : false,
1160       "isPrivate" : false,
1161       "memberOf" : "Roo.util.Observable",
1162       "example" : "",
1163       "deprecated" : "",
1164       "since" : "",
1165       "see" : "",
1166       "params" : [
1167         {
1168           "name" : "eventName",
1169           "type" : "String",
1170           "desc" : "The type of event to listen for",
1171           "isOptional" : false
1172         },
1173         {
1174           "name" : "handler",
1175           "type" : "Function",
1176           "desc" : "The method the event invokes",
1177           "isOptional" : false
1178         },
1179         {
1180           "name" : "scope",
1181           "type" : "Object",
1182           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1183           "isOptional" : false
1184         },
1185         {
1186           "name" : "options",
1187           "type" : "Object",
1188           "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>",
1189           "isOptional" : false
1190         }
1191       ],
1192       "returns" : []
1193     }
1194   ],
1195   "events" : [
1196     {
1197       "name" : "hiddenchange",
1198       "desc" : "Fires when a column is hidden or \"unhidden\".",
1199       "memberOf" : "Roo.grid.ColumnModel",
1200       "example" : "",
1201       "deprecated" : "",
1202       "since" : "",
1203       "see" : "",
1204       "params" : [
1205         {
1206           "name" : "this",
1207           "type" : "ColumnModel",
1208           "desc" : "",
1209           "isOptional" : false
1210         },
1211         {
1212           "name" : "columnIndex",
1213           "type" : "Number",
1214           "desc" : "The column index",
1215           "isOptional" : false
1216         },
1217         {
1218           "name" : "hidden",
1219           "type" : "Boolean",
1220           "desc" : "true if hidden, false otherwise",
1221           "isOptional" : false
1222         }
1223       ],
1224       "returns" : []
1225     },
1226     {
1227       "name" : "headerchange",
1228       "desc" : "Fires when the text of a header changes.",
1229       "memberOf" : "Roo.grid.ColumnModel",
1230       "example" : "",
1231       "deprecated" : "",
1232       "since" : "",
1233       "see" : "",
1234       "params" : [
1235         {
1236           "name" : "this",
1237           "type" : "ColumnModel",
1238           "desc" : "",
1239           "isOptional" : false
1240         },
1241         {
1242           "name" : "columnIndex",
1243           "type" : "Number",
1244           "desc" : "The column index",
1245           "isOptional" : false
1246         },
1247         {
1248           "name" : "newText",
1249           "type" : "Number",
1250           "desc" : "The new header text",
1251           "isOptional" : false
1252         }
1253       ],
1254       "returns" : []
1255     },
1256     {
1257       "name" : "columlockchange",
1258       "desc" : "Fires when a column's locked state is changed",
1259       "memberOf" : "Roo.grid.ColumnModel",
1260       "example" : "",
1261       "deprecated" : "",
1262       "since" : "",
1263       "see" : "",
1264       "params" : [
1265         {
1266           "name" : "this",
1267           "type" : "ColumnModel",
1268           "desc" : "",
1269           "isOptional" : false
1270         },
1271         {
1272           "name" : "colIndex",
1273           "type" : "Number",
1274           "desc" : "",
1275           "isOptional" : false
1276         },
1277         {
1278           "name" : "locked",
1279           "type" : "Boolean",
1280           "desc" : "true if locked",
1281           "isOptional" : false
1282         }
1283       ],
1284       "returns" : []
1285     },
1286     {
1287       "name" : "columnmoved",
1288       "desc" : "Fires when a column is moved.",
1289       "memberOf" : "Roo.grid.ColumnModel",
1290       "example" : "",
1291       "deprecated" : "",
1292       "since" : "",
1293       "see" : "",
1294       "params" : [
1295         {
1296           "name" : "this",
1297           "type" : "ColumnModel",
1298           "desc" : "",
1299           "isOptional" : false
1300         },
1301         {
1302           "name" : "oldIndex",
1303           "type" : "Number",
1304           "desc" : "",
1305           "isOptional" : false
1306         },
1307         {
1308           "name" : "newIndex",
1309           "type" : "Number",
1310           "desc" : "",
1311           "isOptional" : false
1312         }
1313       ],
1314       "returns" : []
1315     },
1316     {
1317       "name" : "widthchange",
1318       "desc" : "Fires when the width of a column changes.",
1319       "memberOf" : "Roo.grid.ColumnModel",
1320       "example" : "",
1321       "deprecated" : "",
1322       "since" : "",
1323       "see" : "",
1324       "params" : [
1325         {
1326           "name" : "this",
1327           "type" : "ColumnModel",
1328           "desc" : "",
1329           "isOptional" : false
1330         },
1331         {
1332           "name" : "columnIndex",
1333           "type" : "Number",
1334           "desc" : "The column index",
1335           "isOptional" : false
1336         },
1337         {
1338           "name" : "newWidth",
1339           "type" : "Number",
1340           "desc" : "The new width",
1341           "isOptional" : false
1342         }
1343       ],
1344       "returns" : []
1345     }
1346   ]
1347 }