com.gwtplatform.mvp.client.TabPanel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gwtp-all Show documentation
The newest version!
/*
 * Copyright 2011 ArcBees Inc.
 *
 * 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.
 */

package com.gwtplatform.mvp.client;

/**
 * Classes of this type hold a list of {@link Tab}, from which
 * only one can be active at any time.
 */
public interface TabPanel {

    /**
     * Adds a new tab to the widget.
     *
     * @param tabData      The data to use for that tab.
     * @param historyToken The history token the tab points to.
     * @return The newly added {@link Tab}.
     */
    Tab addTab(TabData tabData, String historyToken);

    /**
     * Removes a tab from the widget.
     *
     * @param tab The tab to remove.
     */
    void removeTab(Tab tab);

    /**
     * Removes all tabs from the widget.
     */
    void removeTabs();

    /**
     * Sets the currently active tab.
     *
     * @param tab The tab to activate.
     */
    void setActiveTab(Tab tab);

    /**
     * Change the data or history token associated with a tab.
     *
     * @param tab          The tab to change.
     * @param tabData      The data to set for this tab.
     * @param historyToken The history token to use for this tab.
     */
    void changeTab(Tab tab, TabData tabData, String historyToken);
}