com.cedarsolutions.client.gwt.module.view.ModuleTabPanelView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cedar-common-gwt Show documentation
Utility code for use with GWT and Mvp4g.
The newest version!
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 *              C E D A R
 *          S O L U T I O N S       "Software done right."
 *           S O F T W A R E
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 * Copyright (c) 2013-2015 Kenneth J. Pronovici.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Apache License, Version 2.0.
 * See LICENSE for more information about the licensing terms.
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 * Author   : Kenneth J. Pronovici 
 * Language : Java 6
 * Project  : Common Java Functionality
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
package com.cedarsolutions.client.gwt.module.view;

import com.google.gwt.user.client.Window;

/**
 * Specialized page that holds a set of tabs on a tab layout panel.
 * @author Kenneth J. Pronovici 
 */
public abstract class ModuleTabPanelView extends ModulePageView implements IModuleTabPanelView {

    /** Default scaling for setting full-screen width. */
    public static final double WIDTH_SCALING = 0.95;

    /** Default scaling for setting full-screen height. */
    public static final double HEIGHT_SCALING = 0.85;

    /** The resize handler that is in use, if any. */
    protected com.cedarsolutions.client.gwt.module.view.TabPanelResizeHandler resizeHandler = null;

    /** The tab that is currently selected on the panel. */
    protected IModuleTabView selectedTabView;

    /** Get the tab that is currently selected on the panel. */
    @Override
    public IModuleTabView getSelectedTabView() {
        return this.selectedTabView;
    }

    /** Set the tab that is currently selected on the panel. */
    @Override
    public void setSelectedTabView(IModuleTabView selectedTabView) {
        this.selectedTabView = selectedTabView;
    }

    /** Get the history token for the nested view that is currently selected. */
    @Override
    public String getSelectedHistoryToken() {
        return this.selectedTabView == null ? null : this.selectedTabView.getHistoryToken();
    }

    /**
     * Add a new tab to the tab panel, with no view name.
     * @param view     View to use as tab contents
     * @param title    Title of the tab
     */
    protected void addTab(IModuleTabView view, String title) {
        addTab(view, null, title);
    }

    /**
     * Add a new tab to the tab panel.
     * @param view     View to use as tab contents
     * @param viewName Name of the view, to be used in a legible HTML id
     * @param title    Title of the tab
     */
    protected void addTab(IModuleTabView view, String viewName, String title) {
        this.getTabPanel().add(view.getViewWidget(), viewName, title);
        int tabIndex = this.getTabPanel().getWidgetCount() - 1;  // tab index for events is zero-based
        view.setContext(this, tabIndex);
    }

    /**
     * Add a new tab to the tab panel, automatically marking it as enabled.
     * The tab will be placed at the desired index, or at the end of the list if that's not possible.
     * @param view     View to use as tab contents
     * @param viewName Name of the view, to be used in a legible HTML id
     * @param title    Title of the tab
     * @param tabIndex Index at which tab should be placed, if possible
     */
    protected void addTab(IModuleTabView view, String viewName, String title, int tabIndex) {
        int actual = this.getTabPanel().add(view.getViewWidget(), viewName, title, tabIndex);
        view.setContext(this, actual);
        view.enableTab();
    }

    /** Configure the tab panel so it takes up the full screen, using default scaling. */
    protected void configureFullScreen() {
        this.configureFullScreen(WIDTH_SCALING, HEIGHT_SCALING);
    }

    /**
     * Configure the tab panel so it takes up the full screen.
     * @param widthScaling  Scaling percentage to use for the panel width
     * @param heightScaling Scaling percentage to use for the panel height
     */
    protected void configureFullScreen(double widthScaling, double heightScaling) {
        this.resizeHandler = new com.cedarsolutions.client.gwt.module.view.TabPanelResizeHandler(this, widthScaling, heightScaling);
        Window.addResizeHandler(this.resizeHandler);
    }

    /** Whether full-screen mode is configured. */
    public boolean isFullScreen() {
        return this.resizeHandler != null;
    }

    /**
     * Select the tab that displays the passed-in view.
     * @param view  View whose tab to select
     */
    @Override
    public void selectTabForView(IModuleTabView view) {
        this.selectTabForView(view, true);
    }

    /**
     * Select the tab that displays the passed-in view.
     * @param view       View whose tab to select
     * @param fireEvents Whether to fire events, such as result in history tokens
     */
    @Override
    public void selectTabForView(IModuleTabView view, boolean fireEvents) {
        int index = this.getTabPanel().getWidgetIndex(view.getViewWidget());
        if (index >= 0) {
            ModuleTabUtils.initializeTab(view);
            this.getTabPanel().selectTab(index, fireEvents);
            this.setSelectedTabView(view);
        }
    }

    /**
     * Replace the first tab on the screen with the passed-in view.
     *
     * 
     * This is intended for use with views that have a single tab and swap
     * out the view that is actually being displayed as part of that tab.
     * If you have multiple tabs and you want to select one of them, use
     * selectTabForView().
     * 
     *
     * @param view   View to use as tab contents
     * @param title  Title of the tab
     */
    protected void replaceFirstTabWithView(IModuleTabView view, String title) {
        this.replaceFirstTabWithView(view, null, title);
    }

    /**
     * Replace the first tab on the screen with the passed-in view.
     * @param view     View to use as tab contents
     * @param viewName Name of the view, to be used in a legible HTML id
     * @param title    Title of the tab
     */
    protected void replaceFirstTabWithView(IModuleTabView view, String viewName, String title) {
        if (this.getTabPanel().getWidgetCount() >= 1) {
            this.getTabPanel().remove(0);
        }

        this.addTab(view, viewName, title);
        view.selectTab();  // simulates the act of the user clicking on the tab
        this.setSelectedTabView(view);
    }

    /**
     * Replace a tab on the screen with the passed-in view, by index.
     * @param view     View to use as tab contents
     * @param viewName Name of the view, to be used in a legible HTML id
     * @param title    Title of the tab
     * @param tabIndex Index of the tab to replace.
     */
    protected void replaceTabWithView(IModuleTabView view, String viewName, String title, int tabIndex) {
        // Initialize the tab view, in case it hasn't been done already
        ModuleTabUtils.initializeTab(view);

        // Deselect all existing tabs.  If we don't do this, going to a
        // bookmark at initial login leaves the very first tab highlighted
        // along with the one that was selected by the bookmark.  The oldTab
        // comes back as the previous tab in the list, which is not actually
        // the highlighted one in all cases.  Since we don't have a reference
        // to the highlighted one, we need to deselect them all.
        this.getTabPanel().deselectAllTabs();

        // Check whether there's already a tab at this index
        IModuleTabView oldTab = null;
        if (this.getTabPanel().getWidgetCount() > tabIndex) {
            oldTab = (IModuleTabView) this.getTabPanel().getWidget(tabIndex);
        }

        if (oldTab == null) {
            // If there's no old tab, just add the new one at the specified index
            this.addTab(view, viewName, title, tabIndex);
            this.getTabPanel().selectTab(tabIndex);
        } else {
            if (oldTab == view) {
                // If the old tab is exactly the same as the new one, just select it
                this.getTabPanel().selectTab(tabIndex);
            } else {
                // Otherwise, replace the old tab with the new tab
                oldTab.disableTab();
                this.addTab(view, viewName, title, tabIndex);
                this.getTabPanel().removeWithoutSelecting(tabIndex);
                this.getTabPanel().selectTab(tabIndex);
            }
        }

        this.setSelectedTabView(view);
    }

    /**
     * Window resize handler, which resizes a tab panel to full-screen.
     * @deprecated Use com.cedarsolutions.client.gwt.module.view.TabPanelResizeHandler instead.
     */
    @Deprecated
    public static class TabPanelResizeHandler extends com.cedarsolutions.client.gwt.module.view.TabPanelResizeHandler {
        public TabPanelResizeHandler(IModuleTabPanelView view, double widthScaling, double heightScaling) {
            super(view, widthScaling, heightScaling);
        }
    }

}