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