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