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