com.gwtplatform.mvp.client.proxy.NonLeafTabContentProxy 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.proxy;

import com.gwtplatform.mvp.client.Presenter;
import com.gwtplatform.mvp.client.TabData;

/**
 * The interface for the {@link Proxy} of a {@link Presenter} that does not have a name token and
 * that can be displayed within a
 * {@link com.gwtplatform.mvp.client.TabContainerPresenter TabContainerPresenter}'s main area.
 * Useful, among other things, for tabs within tabs.
 * If the presenter is associated to a name token use {@link TabContentProxyPlace} instead.
 * Example of use:
 *  * {@literal @}ProxyCodeSplit
 * {@literal @}TabInfo(container = MainPagePresenter.class, priority = 0,
 *          label = "Home", nameToken = "homepage")
 * public interface MyProxy extends NonLeafTabContentProxy<ThisPresenter> { }
 * 
 * In this case, the {@code nameToken} parameter indicates the presenter to reveal
 * when this tab is selected.
 *
 * @param  The type of the {@link Presenter} associated with this proxy.
 * @see com.gwtplatform.mvp.client.annotations.TabInfo TabInfo
 */
public interface NonLeafTabContentProxy
> extends TabContentProxy {

    /**
     * Changes the data and target history token associated with this tab. This will automatically
     * cause the displayed tab to change, provided the
     * {@link com.gwtplatform.mvp.client.TabContainerPresenter TabContainerPresenter} containing this
     * tab defines a {@link com.gwtplatform.mvp.client.annotations.ChangeTab ChangeTab} field and
     * passes it to the parent constructor.
     */
    void changeTab(TabData tabData, String targetHistoryToken);
}