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