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