/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @fileoverview Tabs library for gadgets.
 */

/**
 * @class Tab class for gadgets.
 * You create tabs using the TabSet addTab() method.
 * To get Tab objects,
 * use the TabSet getSelectedTab() or getTabs() methods.
 *
 * <p>
 * <b>See also:</b>
 * <a href="gadgets.TabSet.html">TabSet</a>
 * </p>
 *
 * @name gadgets.Tab
 * @description NOTE: CONSTRUCTOR SHOULD NOT BE DOCUMENTED
 */

/**
 * @private
 * @constructor
 */
gadgets.Tab = function() {};

/**
 * Returns the label of the tab as a string (may contain HTML).
 * @return {String} The label of the tab
 */
gadgets.Tab.prototype.getName = function() {};

/**
 * Returns the HTML element that contains the tab's label.
 * @return {HTMLElement} The HTML element of the tab's label
 */
gadgets.Tab.prototype.getNameContainer = function() {};

/**
 * Returns the HTML element where the tab content is rendered.
 * @return {HTMLElement} The HTML element of the content container
 */
gadgets.Tab.prototype.getContentContainer = function() {};

/**
 * 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() {};

/**
 * Returns the tab's index.
 * @return {Number} The tab's index
 */
gadgets.Tab.prototype.getIndex = function() {};

/**
 * @class A class gadgets can use to make tabs.
 * @description Creates a new TabSet object
 *
 * @param {String} opt_moduleId Optional suffix for the ID of tab container
 * @param {String} opt_defaultTab Optional tab name that specifies the name of
 *                   of the tab that is selected after initialization;
 *                   if this parameter is omitted, the first tab is selected by
 *                   default
 * @param {HTMLElement} opt_container The HTML element to contain the tabs; if
 *                    omitted, a new div element is created and inserted at the
 *                    very top
 */
gadgets.TabSet = function(opt_moduleId, opt_defaultTab, opt_container) {};

/**
 * Adds a new tab based on the name-value pairs specified in opt_params.
 * The following properties are supported in opt_params:
 * <dl>
 * <dt>contentContainer</dt>
 *   <dd>An existing HTML element to be used as
 *       the tab content container. If omitted, the tabs
 *       library creates one. </dd>
 * <dt>callback</dt>
 *   <dd>A callback function to be executed when the tab
 *       is selected. </dd>
 * <dt>tooltip</dt>
 *   <dd>A tooltip description that pops up when user moves
 *       the mouse cursor over the tab.</dd>
 * <dt>index</dt>
 *   <dd>The index at which to insert the tab. If omitted,
 *       the new tab is appended to the end.</dd>
 * </dl>
 * @param {String} tabName Label of the tab to create
 * @param {Object} opt_params Optional parameter object
 * @return {String} DOM id of the tab container
 */
gadgets.TabSet.prototype.addTab = function(tabName, opt_params) {};

/**
 * Removes a tab at tabIndex and all of its associated content.
 * @param {Number} tabIndex Index of the tab to remove
 */
gadgets.TabSet.prototype.removeTab = function(tabIndex) {};

/**
 * Returns the currently selected tab object.
 * @return {gadgets.Tab} The currently selected tab object
 */
gadgets.TabSet.prototype.getSelectedTab = function() {};

/**
 * Selects the tab at tabIndex and fires the tab's callback function if it
 * exists. If the tab is already selected, the callback is not fired.
 * @param {Number} tabIndex Index of the tab to select
 */
gadgets.TabSet.prototype.setSelectedTab = function(tabIndex) {};

/**
 * Swaps the positions of tabs at tabIndex1 and tabIndex2. The selected tab
 * does not change, and no callback functions are called.
 * @param {Number} tabIndex1 Index of the first tab to swap
 * @param {Number} tabIndex2 Index of the secnod tab to swap
 */
gadgets.TabSet.prototype.swapTabs = function(tabIndex1, tabIndex2) {};

/**
 * Returns an array of all existing tab objects.
 * @return {Array.&lt;gadgets.Tab&gt;} Array of all existing tab objects
 */
gadgets.TabSet.prototype.getTabs = function() {};

/**
 * Sets the alignment of tabs. Tabs are center-aligned by default.
 * @param {String} align 'left', 'center', or 'right'
 * @param {Number} opt_offset Optional parameter to set the number of pixels
 *                   to offset tabs from the left or right edge; the default
 *                   value is 3px
 */
gadgets.TabSet.prototype.alignTabs = function(align, opt_offset) {};

/**
 * Shows or hides tabs and all associated content.
 * @param {Boolean} display True to show tabs; false to hide tabs
 */
gadgets.TabSet.prototype.displayTabs = function(display) {};

/**
 * Returns the tab headers container element.
 * @return {HTMLElement} The tab headers container element
 */
gadgets.TabSet.prototype.getHeaderContainer = function() {};