svn commit: r615081 - /incubator/shindig/trunk/features/tabs/tabs.js

[zh...@apache.org]

Author: zhen
Date: Thu Jan 24 15:40:12 2008
New Revision: 615081

URL: http://svn.apache.org/viewvc?rev=615081&view=rev
Log:
Added the interface of gadgets.Tab.


Modified:
    incubator/shindig/trunk/features/tabs/tabs.js

Modified: incubator/shindig/trunk/features/tabs/tabs.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/tabs/tabs.js?rev=615081&r1=615080&r2=615081&view=diff
==============================================================================
--- incubator/shindig/trunk/features/tabs/tabs.js (original)
+++ incubator/shindig/trunk/features/tabs/tabs.js Thu Jan 24 15:40:12 2008
@@ -23,6 +23,55 @@
 var gadgets = gadgets || {};
 
 /**
+ * @class Tab class for gadgets.
+ * @param {gadgets.Tabs} handle The associated gadgets.Tabs instance.
+ * @constructor
+ */
+gadgets.Tab = function(handle) {
+  // TODO
+};
+
+/**
+ * Returns the label of the tab as a string (may contain HTML).
+ * @return {String} The label of the tab.
+ */
+gadgets.Tab.prototype.getName = function() {
+  // TODO
+};
+
+/**
+ * Returns the HTML element that contains the tab's label.
+ * @return {Element} The HTML element of the tab's label.
+ */
+gadgets.Tab.prototype.getNameContainer = function() {
+  // TODO
+};
+
+/**
+ * Returns the HTML element where the tab content is rendered.
+ * @return {Element} The HTML element of the content container.
+ */
+gadgets.Tab.prototype.getContentContainer = function() {
+  // TODO
+};
+
+/**
+ * Returns the callback function that is executed when the tab is selected.
+ * @return {Function} The callback function of the tab.
+ */
+gadgets.Tab.prototype.getCallback = function() {
+  // TODO
+};
+
+/**
+ * Returns the tab's index.
+ * @return {Number} The tab's index.
+ */
+gadgets.Tab.prototype.getIndex = function() {
+  // TODO
+};
+
+/**
  * @class A class gadgets can use to make tabs.
  * @description Creates a new Tabs object
  *
@@ -34,6 +83,7 @@
  * @param {Element} opt_container The HTML element to contain the tabs.  If
  *                    omitted, a new div element is created and inserted at the
  *                    very top.
+ * @constructor
  */
 gadgets.Tabs = function(opt_moduleId, opt_defaultTab, opt_container) {
   // TODO
@@ -69,7 +119,7 @@
 
 /**
  * Returns the currently selected tab object.
- * @return {Object} The currently selected tab object.
+ * @return {gadgets.Tab} The currently selected tab object.
  */
 gadgets.Tabs.prototype.getSelectedTab = function() {
   // TODO
@@ -97,7 +147,7 @@
 
 /**
  * Returns an array of all existing tab objects.
- * @return {Array.<Object>} Array of all existing tab objects.
+ * @return {Array.<gadgets.Tab>} Array of all existing tab objects.
  */
 gadgets.Tabs.prototype.getTabs = function() {
   // TODO
@@ -124,7 +174,7 @@
 
 /**
  * Returns the tab headers container element.
- * @return {Object} The tab headers container element.
+ * @return {Element} The tab headers container element.
  */
 gadgets.Tabs.prototype.getHeaderContainer = function() {
   // TODO