git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.panel.TabItem.json

   1 {
   2   "name" : "Roo.bootstrap.panel.TabItem",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "Represents an individual item (tab plus body) in a TabPanel.",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "TabItem",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "tabPanel",
  18       "type" : "Roo.TabPanel",
  19       "desc" : "The {@link Roo.TabPanel} this TabPanelItem belongs to",
  20       "isOptional" : false
  21     },
  22     {
  23       "name" : "id",
  24       "type" : "String",
  25       "desc" : "The id of this TabPanelItem",
  26       "isOptional" : false
  27     },
  28     {
  29       "name" : "text",
  30       "type" : "String",
  31       "desc" : "The text for the tab of this TabPanelItem",
  32       "isOptional" : false
  33     },
  34     {
  35       "name" : "closable",
  36       "type" : "Boolean",
  37       "desc" : "True to allow this TabPanelItem to be closable (defaults to false)",
  38       "isOptional" : false
  39     }
  40   ],
  41   "returns" : [],
  42   "config" : [
  43     {
  44       "name" : "listeners",
  45       "type" : "Object",
  46       "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>",
  47       "memberOf" : "Roo.util.Observable",
  48       "optvals" : []
  49     }
  50   ],
  51   "methods" : [
  52     {
  53       "name" : "hide",
  54       "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
  55       "isStatic" : false,
  56       "isConstructor" : false,
  57       "isPrivate" : false,
  58       "memberOf" : "Roo.bootstrap.panel.TabItem",
  59       "example" : "",
  60       "deprecated" : "",
  61       "since" : "",
  62       "see" : "",
  63       "params" : [],
  64       "returns" : []
  65     },
  66     {
  67       "name" : "show",
  68       "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
  69       "isStatic" : false,
  70       "isConstructor" : false,
  71       "isPrivate" : false,
  72       "memberOf" : "Roo.bootstrap.panel.TabItem",
  73       "example" : "",
  74       "deprecated" : "",
  75       "since" : "",
  76       "see" : "",
  77       "params" : [],
  78       "returns" : []
  79     },
  80     {
  81       "name" : "isHidden",
  82       "desc" : "Returns true if this tab is \"hidden\"",
  83       "isStatic" : false,
  84       "isConstructor" : false,
  85       "isPrivate" : false,
  86       "memberOf" : "Roo.bootstrap.panel.TabItem",
  87       "example" : "",
  88       "deprecated" : "",
  89       "since" : "",
  90       "see" : "",
  91       "params" : [],
  92       "returns" : [
  93         {
  94           "name" : "",
  95           "type" : "Boolean",
  96           "desc" : ""
  97         }
  98       ]
  99     },
 100     {
 101       "name" : "activate",
 102       "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
 103       "isStatic" : false,
 104       "isConstructor" : false,
 105       "isPrivate" : false,
 106       "memberOf" : "Roo.bootstrap.panel.TabItem",
 107       "example" : "",
 108       "deprecated" : "",
 109       "since" : "",
 110       "see" : "",
 111       "params" : [],
 112       "returns" : []
 113     },
 114     {
 115       "name" : "isActive",
 116       "desc" : "Returns true if this tab is the active tab.",
 117       "isStatic" : false,
 118       "isConstructor" : false,
 119       "isPrivate" : false,
 120       "memberOf" : "Roo.bootstrap.panel.TabItem",
 121       "example" : "",
 122       "deprecated" : "",
 123       "since" : "",
 124       "see" : "",
 125       "params" : [],
 126       "returns" : [
 127         {
 128           "name" : "",
 129           "type" : "Boolean",
 130           "desc" : ""
 131         }
 132       ]
 133     },
 134     {
 135       "name" : "disable",
 136       "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
 137       "isStatic" : false,
 138       "isConstructor" : false,
 139       "isPrivate" : false,
 140       "memberOf" : "Roo.bootstrap.panel.TabItem",
 141       "example" : "",
 142       "deprecated" : "",
 143       "since" : "",
 144       "see" : "",
 145       "params" : [],
 146       "returns" : []
 147     },
 148     {
 149       "name" : "setUrl",
 150       "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
 151       "isStatic" : false,
 152       "isConstructor" : false,
 153       "isPrivate" : false,
 154       "memberOf" : "Roo.bootstrap.panel.TabItem",
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "params" : [
 160         {
 161           "name" : "url",
 162           "type" : "String/Function",
 163           "desc" : "The URL to load the content from, or a function to call to get the URL",
 164           "isOptional" : false
 165         },
 166         {
 167           "name" : "params",
 168           "type" : "String/Object",
 169           "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
 170           "isOptional" : false
 171         },
 172         {
 173           "name" : "loadOnce",
 174           "type" : "Boolean",
 175           "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
 176           "isOptional" : false
 177         }
 178       ],
 179       "returns" : [
 180         {
 181           "name" : "",
 182           "type" : "Roo.UpdateManager",
 183           "desc" : "The UpdateManager"
 184         }
 185       ]
 186     },
 187     {
 188       "name" : "setContent",
 189       "desc" : "Sets the content for this TabPanelItem.",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "memberOf" : "Roo.bootstrap.panel.TabItem",
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "params" : [
 199         {
 200           "name" : "content",
 201           "type" : "String",
 202           "desc" : "The content",
 203           "isOptional" : false
 204         },
 205         {
 206           "name" : "loadScripts",
 207           "type" : "Boolean",
 208           "desc" : "true to look for and load scripts",
 209           "isOptional" : false
 210         }
 211       ],
 212       "returns" : []
 213     },
 214     {
 215       "name" : "getUpdateManager",
 216       "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
 217       "isStatic" : false,
 218       "isConstructor" : false,
 219       "isPrivate" : false,
 220       "memberOf" : "Roo.bootstrap.panel.TabItem",
 221       "example" : "",
 222       "deprecated" : "",
 223       "since" : "",
 224       "see" : "",
 225       "params" : [],
 226       "returns" : [
 227         {
 228           "name" : "",
 229           "type" : "Roo.UpdateManager",
 230           "desc" : "The UpdateManager"
 231         }
 232       ]
 233     },
 234     {
 235       "name" : "setTooltip",
 236       "desc" : "Set the tooltip for the tab.",
 237       "isStatic" : false,
 238       "isConstructor" : false,
 239       "isPrivate" : false,
 240       "memberOf" : "Roo.bootstrap.panel.TabItem",
 241       "example" : "",
 242       "deprecated" : "",
 243       "since" : "",
 244       "see" : "",
 245       "params" : [
 246         {
 247           "name" : "tooltip",
 248           "type" : "String",
 249           "desc" : "The tab's tooltip",
 250           "isOptional" : false
 251         }
 252       ],
 253       "returns" : []
 254     },
 255     {
 256       "name" : "getText",
 257       "desc" : "Returns the text for this tab",
 258       "isStatic" : false,
 259       "isConstructor" : false,
 260       "isPrivate" : false,
 261       "memberOf" : "Roo.bootstrap.panel.TabItem",
 262       "example" : "",
 263       "deprecated" : "",
 264       "since" : "",
 265       "see" : "",
 266       "params" : [],
 267       "returns" : [
 268         {
 269           "name" : "",
 270           "type" : "String",
 271           "desc" : ""
 272         }
 273       ]
 274     },
 275     {
 276       "name" : "setText",
 277       "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
 278       "isStatic" : false,
 279       "isConstructor" : false,
 280       "isPrivate" : false,
 281       "memberOf" : "Roo.bootstrap.panel.TabItem",
 282       "example" : "",
 283       "deprecated" : "",
 284       "since" : "",
 285       "see" : "",
 286       "params" : [
 287         {
 288           "name" : "text",
 289           "type" : "String",
 290           "desc" : "The tab's text and tooltip",
 291           "isOptional" : false
 292         }
 293       ],
 294       "returns" : []
 295     },
 296     {
 297       "name" : "setHidden",
 298       "desc" : "Show or hide the tab",
 299       "isStatic" : false,
 300       "isConstructor" : false,
 301       "isPrivate" : false,
 302       "memberOf" : "Roo.bootstrap.panel.TabItem",
 303       "example" : "",
 304       "deprecated" : "",
 305       "since" : "",
 306       "see" : "",
 307       "params" : [
 308         {
 309           "name" : "hidden",
 310           "type" : "Boolean",
 311           "desc" : "True to hide or false to show.",
 312           "isOptional" : false
 313         }
 314       ],
 315       "returns" : []
 316     },
 317     {
 318       "name" : "refresh",
 319       "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n  Will fail silently if the setUrl method has not been called.\n  This does not activate the panel, just updates its content.",
 320       "isStatic" : false,
 321       "isConstructor" : false,
 322       "isPrivate" : false,
 323       "memberOf" : "Roo.bootstrap.panel.TabItem",
 324       "example" : "",
 325       "deprecated" : "",
 326       "since" : "",
 327       "see" : "",
 328       "params" : [],
 329       "returns" : []
 330     },
 331     {
 332       "name" : "enable",
 333       "desc" : "Enables this TabPanelItem if it was previously disabled.",
 334       "isStatic" : false,
 335       "isConstructor" : false,
 336       "isPrivate" : false,
 337       "memberOf" : "Roo.bootstrap.panel.TabItem",
 338       "example" : "",
 339       "deprecated" : "",
 340       "since" : "",
 341       "see" : "",
 342       "params" : [],
 343       "returns" : []
 344     },
 345     {
 346       "name" : "purgeListeners",
 347       "desc" : "Removes all listeners for this object",
 348       "isStatic" : false,
 349       "isConstructor" : false,
 350       "isPrivate" : false,
 351       "memberOf" : "Roo.util.Observable",
 352       "example" : "",
 353       "deprecated" : "",
 354       "since" : "",
 355       "see" : "",
 356       "params" : [],
 357       "returns" : []
 358     },
 359     {
 360       "name" : "on",
 361       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 362       "isStatic" : false,
 363       "isConstructor" : false,
 364       "isPrivate" : false,
 365       "memberOf" : "Roo.util.Observable",
 366       "example" : "",
 367       "deprecated" : "",
 368       "since" : "",
 369       "see" : "",
 370       "params" : [
 371         {
 372           "name" : "eventName",
 373           "type" : "String",
 374           "desc" : "The type of event to listen for",
 375           "isOptional" : false
 376         },
 377         {
 378           "name" : "handler",
 379           "type" : "Function",
 380           "desc" : "The method the event invokes",
 381           "isOptional" : false
 382         },
 383         {
 384           "name" : "scope",
 385           "type" : "Object",
 386           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 387           "isOptional" : false
 388         },
 389         {
 390           "name" : "options",
 391           "type" : "Object",
 392           "desc" : "(optional)",
 393           "isOptional" : false
 394         }
 395       ],
 396       "returns" : []
 397     },
 398     {
 399       "name" : "un",
 400       "desc" : "Removes a listener (shorthand for removeListener)",
 401       "isStatic" : false,
 402       "isConstructor" : false,
 403       "isPrivate" : false,
 404       "memberOf" : "Roo.util.Observable",
 405       "example" : "",
 406       "deprecated" : "",
 407       "since" : "",
 408       "see" : "",
 409       "params" : [
 410         {
 411           "name" : "eventName",
 412           "type" : "String",
 413           "desc" : "The type of event to listen for",
 414           "isOptional" : false
 415         },
 416         {
 417           "name" : "handler",
 418           "type" : "Function",
 419           "desc" : "The handler to remove",
 420           "isOptional" : false
 421         },
 422         {
 423           "name" : "scope",
 424           "type" : "Object",
 425           "desc" : "(optional) The scope (this object) for the handler",
 426           "isOptional" : false
 427         }
 428       ],
 429       "returns" : []
 430     },
 431     {
 432       "name" : "addEvents",
 433       "desc" : "Used to define events on this Observable",
 434       "isStatic" : false,
 435       "isConstructor" : false,
 436       "isPrivate" : false,
 437       "memberOf" : "Roo.util.Observable",
 438       "example" : "",
 439       "deprecated" : "",
 440       "since" : "",
 441       "see" : "",
 442       "params" : [
 443         {
 444           "name" : "object",
 445           "type" : "Object",
 446           "desc" : "The object with the events defined",
 447           "isOptional" : false
 448         }
 449       ],
 450       "returns" : []
 451     },
 452     {
 453       "name" : "releaseCapture",
 454       "desc" : "Removes <b>all</b> added captures from the Observable.",
 455       "isStatic" : true,
 456       "isConstructor" : false,
 457       "isPrivate" : false,
 458       "memberOf" : "Roo.util.Observable",
 459       "example" : "",
 460       "deprecated" : "",
 461       "since" : "",
 462       "see" : "",
 463       "params" : [
 464         {
 465           "name" : "o",
 466           "type" : "Observable",
 467           "desc" : "The Observable to release",
 468           "isOptional" : false
 469         }
 470       ],
 471       "returns" : []
 472     },
 473     {
 474       "name" : "removeListener",
 475       "desc" : "Removes a listener",
 476       "isStatic" : false,
 477       "isConstructor" : false,
 478       "isPrivate" : false,
 479       "memberOf" : "Roo.util.Observable",
 480       "example" : "",
 481       "deprecated" : "",
 482       "since" : "",
 483       "see" : "",
 484       "params" : [
 485         {
 486           "name" : "eventName",
 487           "type" : "String",
 488           "desc" : "The type of event to listen for",
 489           "isOptional" : false
 490         },
 491         {
 492           "name" : "handler",
 493           "type" : "Function",
 494           "desc" : "The handler to remove",
 495           "isOptional" : false
 496         },
 497         {
 498           "name" : "scope",
 499           "type" : "Object",
 500           "desc" : "(optional) The scope (this object) for the handler",
 501           "isOptional" : false
 502         }
 503       ],
 504       "returns" : []
 505     },
 506     {
 507       "name" : "fireEvent",
 508       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 509       "isStatic" : false,
 510       "isConstructor" : false,
 511       "isPrivate" : false,
 512       "memberOf" : "Roo.util.Observable",
 513       "example" : "",
 514       "deprecated" : "",
 515       "since" : "",
 516       "see" : "",
 517       "params" : [
 518         {
 519           "name" : "eventName",
 520           "type" : "String",
 521           "desc" : "",
 522           "isOptional" : false
 523         },
 524         {
 525           "name" : "args",
 526           "type" : "Object...",
 527           "desc" : "Variable number of parameters are passed to handlers",
 528           "isOptional" : false
 529         }
 530       ],
 531       "returns" : [
 532         {
 533           "name" : "",
 534           "type" : "Boolean",
 535           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 536         }
 537       ]
 538     },
 539     {
 540       "name" : "hasListener",
 541       "desc" : "Checks to see if this object has any listeners for a specified event",
 542       "isStatic" : false,
 543       "isConstructor" : false,
 544       "isPrivate" : false,
 545       "memberOf" : "Roo.util.Observable",
 546       "example" : "",
 547       "deprecated" : "",
 548       "since" : "",
 549       "see" : "",
 550       "params" : [
 551         {
 552           "name" : "eventName",
 553           "type" : "String",
 554           "desc" : "The name of the event to check for",
 555           "isOptional" : false
 556         }
 557       ],
 558       "returns" : [
 559         {
 560           "name" : "",
 561           "type" : "Boolean",
 562           "desc" : "True if the event is being listened for, else false"
 563         }
 564       ]
 565     },
 566     {
 567       "name" : "capture",
 568       "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.",
 569       "isStatic" : true,
 570       "isConstructor" : false,
 571       "isPrivate" : false,
 572       "memberOf" : "Roo.util.Observable",
 573       "example" : "",
 574       "deprecated" : "",
 575       "since" : "",
 576       "see" : "",
 577       "params" : [
 578         {
 579           "name" : "o",
 580           "type" : "Observable",
 581           "desc" : "The Observable to capture",
 582           "isOptional" : false
 583         },
 584         {
 585           "name" : "fn",
 586           "type" : "Function",
 587           "desc" : "The function to call",
 588           "isOptional" : false
 589         },
 590         {
 591           "name" : "scope",
 592           "type" : "Object",
 593           "desc" : "(optional) The scope (this object) for the fn",
 594           "isOptional" : false
 595         }
 596       ],
 597       "returns" : []
 598     },
 599     {
 600       "name" : "addListener",
 601       "desc" : "Appends an event handler to this component",
 602       "isStatic" : false,
 603       "isConstructor" : false,
 604       "isPrivate" : false,
 605       "memberOf" : "Roo.util.Observable",
 606       "example" : "",
 607       "deprecated" : "",
 608       "since" : "",
 609       "see" : "",
 610       "params" : [
 611         {
 612           "name" : "eventName",
 613           "type" : "String",
 614           "desc" : "The type of event to listen for",
 615           "isOptional" : false
 616         },
 617         {
 618           "name" : "handler",
 619           "type" : "Function",
 620           "desc" : "The method the event invokes",
 621           "isOptional" : false
 622         },
 623         {
 624           "name" : "scope",
 625           "type" : "Object",
 626           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 627           "isOptional" : false
 628         },
 629         {
 630           "name" : "options",
 631           "type" : "Object",
 632           "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>",
 633           "isOptional" : false
 634         }
 635       ],
 636       "returns" : []
 637     }
 638   ],
 639   "events" : [
 640     {
 641       "name" : "close",
 642       "desc" : "Fires when this tab is closed.",
 643       "memberOf" : "Roo.bootstrap.panel.TabItem",
 644       "example" : "",
 645       "deprecated" : "",
 646       "since" : "",
 647       "see" : "",
 648       "params" : [
 649         {
 650           "name" : "this",
 651           "type" : "Roo.TabPanelItem",
 652           "desc" : "",
 653           "isOptional" : false
 654         }
 655       ],
 656       "returns" : []
 657     },
 658     {
 659       "name" : "activate",
 660       "desc" : "Fires when this tab becomes the active tab.",
 661       "memberOf" : "Roo.bootstrap.panel.TabItem",
 662       "example" : "",
 663       "deprecated" : "",
 664       "since" : "",
 665       "see" : "",
 666       "params" : [
 667         {
 668           "name" : "tabPanel",
 669           "type" : "Roo.TabPanel",
 670           "desc" : "The parent TabPanel",
 671           "isOptional" : false
 672         },
 673         {
 674           "name" : "this",
 675           "type" : "Roo.TabPanelItem",
 676           "desc" : "",
 677           "isOptional" : false
 678         }
 679       ],
 680       "returns" : []
 681     },
 682     {
 683       "name" : "beforeclose",
 684       "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
 685       "memberOf" : "Roo.bootstrap.panel.TabItem",
 686       "example" : "",
 687       "deprecated" : "",
 688       "since" : "",
 689       "see" : "",
 690       "params" : [
 691         {
 692           "name" : "this",
 693           "type" : "Roo.TabPanelItem",
 694           "desc" : "",
 695           "isOptional" : false
 696         },
 697         {
 698           "name" : "e",
 699           "type" : "Object",
 700           "desc" : "Set cancel to true on this object to cancel the close.",
 701           "isOptional" : false
 702         }
 703       ],
 704       "returns" : []
 705     },
 706     {
 707       "name" : "deactivate",
 708       "desc" : "Fires when this tab is no longer the active tab.",
 709       "memberOf" : "Roo.bootstrap.panel.TabItem",
 710       "example" : "",
 711       "deprecated" : "",
 712       "since" : "",
 713       "see" : "",
 714       "params" : [
 715         {
 716           "name" : "tabPanel",
 717           "type" : "Roo.TabPanel",
 718           "desc" : "The parent TabPanel",
 719           "isOptional" : false
 720         },
 721         {
 722           "name" : "this",
 723           "type" : "Roo.TabPanelItem",
 724           "desc" : "",
 725           "isOptional" : false
 726         }
 727       ],
 728       "returns" : []
 729     }
 730   ]
 731 }