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

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