git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.grid.GridView.json

   1 {
   2   "name" : "Roo.grid.GridView",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11     {
  12       "name" : "listeners",
  13       "type" : "Object",
  14       "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>",
  15       "memberOf" : "Roo.util.Observable",
  16       "values" : [
  17       ]
  18     }
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "getFooterPanel",
  23       "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.grid.GridView",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33         {
  34           "name" : "doShow",
  35           "type" : "Boolean",
  36           "desc" : "By default the footer is hidden. Pass true to show the panel",
  37           "isOptional" : false
  38         }
  39       ],
  40       "returns" : [
  41         {
  42           "name" : "",
  43           "type" : "",
  44           "desc" : "Roo.Element"
  45         }
  46       ]
  47     },
  48     {
  49       "name" : "fitColumns",
  50       "desc" : "Autofits all columns to the grid's width proportionate with their current size",
  51       "isStatic" : false,
  52       "isConstructor" : false,
  53       "isPrivate" : false,
  54       "memberOf" : "Roo.grid.GridView",
  55       "example" : "",
  56       "deprecated" : "",
  57       "since" : "",
  58       "see" : "",
  59       "params" : [
  60         {
  61           "name" : "reserveScrollSpace",
  62           "type" : "Boolean",
  63           "desc" : "Reserve space for a scrollbar",
  64           "isOptional" : false
  65         }
  66       ],
  67       "returns" : [
  68       ]
  69     },
  70     {
  71       "name" : "focusRow",
  72       "desc" : "Focuses the specified row.",
  73       "isStatic" : false,
  74       "isConstructor" : false,
  75       "isPrivate" : false,
  76       "memberOf" : "Roo.grid.GridView",
  77       "example" : "",
  78       "deprecated" : "",
  79       "since" : "",
  80       "see" : "",
  81       "params" : [
  82         {
  83           "name" : "row",
  84           "type" : "Number",
  85           "desc" : "The row index",
  86           "isOptional" : false
  87         }
  88       ],
  89       "returns" : [
  90       ]
  91     },
  92     {
  93       "name" : "focusCell",
  94       "desc" : "Focuses the specified cell.",
  95       "isStatic" : false,
  96       "isConstructor" : false,
  97       "isPrivate" : false,
  98       "memberOf" : "Roo.grid.GridView",
  99       "example" : "",
 100       "deprecated" : "",
 101       "since" : "",
 102       "see" : "",
 103       "params" : [
 104         {
 105           "name" : "row",
 106           "type" : "Number",
 107           "desc" : "The row index",
 108           "isOptional" : false
 109         },
 110         {
 111           "name" : "col",
 112           "type" : "Number",
 113           "desc" : "The column index",
 114           "isOptional" : false
 115         },
 116         {
 117           "name" : "hscroll",
 118           "type" : "Boolean",
 119           "desc" : "false to disable horizontal scrolling",
 120           "isOptional" : false
 121         }
 122       ],
 123       "returns" : [
 124       ]
 125     },
 126     {
 127       "name" : "autoSizeColumn",
 128       "desc" : "Autofit a column to its content.",
 129       "isStatic" : false,
 130       "isConstructor" : false,
 131       "isPrivate" : false,
 132       "memberOf" : "Roo.grid.GridView",
 133       "example" : "",
 134       "deprecated" : "",
 135       "since" : "",
 136       "see" : "",
 137       "params" : [
 138         {
 139           "name" : "colIndex",
 140           "type" : "Number",
 141           "desc" : "",
 142           "isOptional" : false
 143         },
 144         {
 145           "name" : "forceMinSize",
 146           "type" : "Boolean",
 147           "desc" : "true to force the column to go smaller if possible",
 148           "isOptional" : false
 149         }
 150       ],
 151       "returns" : [
 152       ]
 153     },
 154     {
 155       "name" : "getHeaderPanel",
 156       "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
 157       "isStatic" : false,
 158       "isConstructor" : false,
 159       "isPrivate" : false,
 160       "memberOf" : "Roo.grid.GridView",
 161       "example" : "",
 162       "deprecated" : "",
 163       "since" : "",
 164       "see" : "",
 165       "params" : [
 166         {
 167           "name" : "doShow",
 168           "type" : "Boolean",
 169           "desc" : "By default the header is hidden. Pass true to show the panel",
 170           "isOptional" : false
 171         }
 172       ],
 173       "returns" : [
 174         {
 175           "name" : "",
 176           "type" : "",
 177           "desc" : "Roo.Element"
 178         }
 179       ]
 180     },
 181     {
 182       "name" : "scrollToTop",
 183       "desc" : "Scrolls the grid to the top",
 184       "isStatic" : false,
 185       "isConstructor" : false,
 186       "isPrivate" : false,
 187       "memberOf" : "Roo.grid.GridView",
 188       "example" : "",
 189       "deprecated" : "",
 190       "since" : "",
 191       "see" : "",
 192       "params" : [
 193       ],
 194       "returns" : [
 195       ]
 196     },
 197     {
 198       "name" : "getCell",
 199       "desc" : "Gets the 'td' of the cell",
 200       "isStatic" : false,
 201       "isConstructor" : false,
 202       "isPrivate" : false,
 203       "memberOf" : "Roo.grid.GridView",
 204       "example" : "",
 205       "deprecated" : "",
 206       "since" : "",
 207       "see" : "",
 208       "params" : [
 209         {
 210           "name" : "rowIndex",
 211           "type" : "Integer",
 212           "desc" : "row to select",
 213           "isOptional" : false
 214         },
 215         {
 216           "name" : "colIndex",
 217           "type" : "Integer",
 218           "desc" : "column to select",
 219           "isOptional" : false
 220         }
 221       ],
 222       "returns" : [
 223         {
 224           "name" : "",
 225           "type" : "Object",
 226           "desc" : ""
 227         }
 228       ]
 229     },
 230     {
 231       "name" : "refresh",
 232       "desc" : "Refreshes the grid",
 233       "isStatic" : false,
 234       "isConstructor" : false,
 235       "isPrivate" : false,
 236       "memberOf" : "Roo.grid.GridView",
 237       "example" : "",
 238       "deprecated" : "",
 239       "since" : "",
 240       "see" : "",
 241       "params" : [
 242         {
 243           "name" : "headersToo",
 244           "type" : "Boolean",
 245           "desc" : "",
 246           "isOptional" : false
 247         }
 248       ],
 249       "returns" : [
 250       ]
 251     },
 252     {
 253       "name" : "autoSizeColumns",
 254       "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid",
 255       "isStatic" : false,
 256       "isConstructor" : false,
 257       "isPrivate" : false,
 258       "memberOf" : "Roo.grid.GridView",
 259       "example" : "",
 260       "deprecated" : "",
 261       "since" : "",
 262       "see" : "",
 263       "params" : [
 264       ],
 265       "returns" : [
 266       ]
 267     },
 268     {
 269       "name" : "ensureVisible",
 270       "desc" : "Scrolls the specified cell into view",
 271       "isStatic" : false,
 272       "isConstructor" : false,
 273       "isPrivate" : false,
 274       "memberOf" : "Roo.grid.GridView",
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "params" : [
 280         {
 281           "name" : "row",
 282           "type" : "Number",
 283           "desc" : "The row index",
 284           "isOptional" : false
 285         },
 286         {
 287           "name" : "col",
 288           "type" : "Number",
 289           "desc" : "The column index",
 290           "isOptional" : false
 291         },
 292         {
 293           "name" : "hscroll",
 294           "type" : "Boolean",
 295           "desc" : "false to disable horizontal scrolling",
 296           "isOptional" : false
 297         }
 298       ],
 299       "returns" : [
 300       ]
 301     },
 302     {
 303       "name" : "purgeListeners",
 304       "desc" : "Removes all listeners for this object",
 305       "isStatic" : false,
 306       "isConstructor" : false,
 307       "isPrivate" : false,
 308       "memberOf" : "Roo.util.Observable",
 309       "example" : "",
 310       "deprecated" : "",
 311       "since" : "",
 312       "see" : "",
 313       "params" : [
 314       ],
 315       "returns" : [
 316       ]
 317     },
 318     {
 319       "name" : "on",
 320       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 321       "isStatic" : false,
 322       "isConstructor" : false,
 323       "isPrivate" : false,
 324       "memberOf" : "Roo.util.Observable",
 325       "example" : "",
 326       "deprecated" : "",
 327       "since" : "",
 328       "see" : "",
 329       "params" : [
 330         {
 331           "name" : "eventName",
 332           "type" : "String",
 333           "desc" : "The type of event to listen for",
 334           "isOptional" : false
 335         },
 336         {
 337           "name" : "handler",
 338           "type" : "Function",
 339           "desc" : "The method the event invokes",
 340           "isOptional" : false
 341         },
 342         {
 343           "name" : "scope",
 344           "type" : "Object",
 345           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 346           "isOptional" : false
 347         },
 348         {
 349           "name" : "options",
 350           "type" : "Object",
 351           "desc" : "(optional)",
 352           "isOptional" : false
 353         }
 354       ],
 355       "returns" : [
 356       ]
 357     },
 358     {
 359       "name" : "un",
 360       "desc" : "Removes a listener (shorthand for removeListener)",
 361       "isStatic" : false,
 362       "isConstructor" : false,
 363       "isPrivate" : false,
 364       "memberOf" : "Roo.util.Observable",
 365       "example" : "",
 366       "deprecated" : "",
 367       "since" : "",
 368       "see" : "",
 369       "params" : [
 370         {
 371           "name" : "eventName",
 372           "type" : "String",
 373           "desc" : "The type of event to listen for",
 374           "isOptional" : false
 375         },
 376         {
 377           "name" : "handler",
 378           "type" : "Function",
 379           "desc" : "The handler to remove",
 380           "isOptional" : false
 381         },
 382         {
 383           "name" : "scope",
 384           "type" : "Object",
 385           "desc" : "(optional) The scope (this object) for the handler",
 386           "isOptional" : false
 387         }
 388       ],
 389       "returns" : [
 390       ]
 391     },
 392     {
 393       "name" : "addEvents",
 394       "desc" : "Used to define events on this Observable",
 395       "isStatic" : false,
 396       "isConstructor" : false,
 397       "isPrivate" : false,
 398       "memberOf" : "Roo.util.Observable",
 399       "example" : "",
 400       "deprecated" : "",
 401       "since" : "",
 402       "see" : "",
 403       "params" : [
 404         {
 405           "name" : "object",
 406           "type" : "Object",
 407           "desc" : "The object with the events defined",
 408           "isOptional" : false
 409         }
 410       ],
 411       "returns" : [
 412       ]
 413     },
 414     {
 415       "name" : "releaseCapture",
 416       "desc" : "Removes <b>all</b> added captures from the Observable.",
 417       "isStatic" : true,
 418       "isConstructor" : false,
 419       "isPrivate" : false,
 420       "memberOf" : "Roo.util.Observable",
 421       "example" : "",
 422       "deprecated" : "",
 423       "since" : "",
 424       "see" : "",
 425       "params" : [
 426         {
 427           "name" : "o",
 428           "type" : "Observable",
 429           "desc" : "The Observable to release",
 430           "isOptional" : false
 431         }
 432       ],
 433       "returns" : [
 434       ]
 435     },
 436     {
 437       "name" : "removeListener",
 438       "desc" : "Removes a listener",
 439       "isStatic" : false,
 440       "isConstructor" : false,
 441       "isPrivate" : false,
 442       "memberOf" : "Roo.util.Observable",
 443       "example" : "",
 444       "deprecated" : "",
 445       "since" : "",
 446       "see" : "",
 447       "params" : [
 448         {
 449           "name" : "eventName",
 450           "type" : "String",
 451           "desc" : "The type of event to listen for",
 452           "isOptional" : false
 453         },
 454         {
 455           "name" : "handler",
 456           "type" : "Function",
 457           "desc" : "The handler to remove",
 458           "isOptional" : false
 459         },
 460         {
 461           "name" : "scope",
 462           "type" : "Object",
 463           "desc" : "(optional) The scope (this object) for the handler",
 464           "isOptional" : false
 465         }
 466       ],
 467       "returns" : [
 468       ]
 469     },
 470     {
 471       "name" : "fireEvent",
 472       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "memberOf" : "Roo.util.Observable",
 477       "example" : "",
 478       "deprecated" : "",
 479       "since" : "",
 480       "see" : "",
 481       "params" : [
 482         {
 483           "name" : "eventName",
 484           "type" : "String",
 485           "desc" : "",
 486           "isOptional" : false
 487         },
 488         {
 489           "name" : "args",
 490           "type" : "Object...",
 491           "desc" : "Variable number of parameters are passed to handlers",
 492           "isOptional" : false
 493         }
 494       ],
 495       "returns" : [
 496         {
 497           "name" : "",
 498           "type" : "Boolean",
 499           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 500         }
 501       ]
 502     },
 503     {
 504       "name" : "hasListener",
 505       "desc" : "Checks to see if this object has any listeners for a specified event",
 506       "isStatic" : false,
 507       "isConstructor" : false,
 508       "isPrivate" : false,
 509       "memberOf" : "Roo.util.Observable",
 510       "example" : "",
 511       "deprecated" : "",
 512       "since" : "",
 513       "see" : "",
 514       "params" : [
 515         {
 516           "name" : "eventName",
 517           "type" : "String",
 518           "desc" : "The name of the event to check for",
 519           "isOptional" : false
 520         }
 521       ],
 522       "returns" : [
 523         {
 524           "name" : "",
 525           "type" : "Boolean",
 526           "desc" : "True if the event is being listened for, else false"
 527         }
 528       ]
 529     },
 530     {
 531       "name" : "capture",
 532       "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.",
 533       "isStatic" : true,
 534       "isConstructor" : false,
 535       "isPrivate" : false,
 536       "memberOf" : "Roo.util.Observable",
 537       "example" : "",
 538       "deprecated" : "",
 539       "since" : "",
 540       "see" : "",
 541       "params" : [
 542         {
 543           "name" : "o",
 544           "type" : "Observable",
 545           "desc" : "The Observable to capture",
 546           "isOptional" : false
 547         },
 548         {
 549           "name" : "fn",
 550           "type" : "Function",
 551           "desc" : "The function to call",
 552           "isOptional" : false
 553         },
 554         {
 555           "name" : "scope",
 556           "type" : "Object",
 557           "desc" : "(optional) The scope (this object) for the fn",
 558           "isOptional" : false
 559         }
 560       ],
 561       "returns" : [
 562       ]
 563     },
 564     {
 565       "name" : "addListener",
 566       "desc" : "Appends an event handler to this component",
 567       "isStatic" : false,
 568       "isConstructor" : false,
 569       "isPrivate" : false,
 570       "memberOf" : "Roo.util.Observable",
 571       "example" : "",
 572       "deprecated" : "",
 573       "since" : "",
 574       "see" : "",
 575       "params" : [
 576         {
 577           "name" : "eventName",
 578           "type" : "String",
 579           "desc" : "The type of event to listen for",
 580           "isOptional" : false
 581         },
 582         {
 583           "name" : "handler",
 584           "type" : "Function",
 585           "desc" : "The method the event invokes",
 586           "isOptional" : false
 587         },
 588         {
 589           "name" : "scope",
 590           "type" : "Object",
 591           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 592           "isOptional" : false
 593         },
 594         {
 595           "name" : "options",
 596           "type" : "Object",
 597           "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>",
 598           "isOptional" : false
 599         }
 600       ],
 601       "returns" : [
 602       ]
 603     }
 604   ],
 605   "events" : [
 606   ]
 607 }