org.jumpmind.metl.ui.common.TabbedPanel.java Source code

Introduction

Here is the source code for org.jumpmind.metl.ui.common.TabbedPanel.java

Source

/**
 * Licensed to JumpMind Inc under one or more contributor
 * license agreements.  See the NOTICE file distributed
 * with this work for additional information regarding
 * copyright ownership.  JumpMind Inc licenses this file
 * to you under the GNU General Public License, version 3.0 (GPLv3)
 * (the "License"); you may not use this file except in compliance
 * with the License.
 *
 * You should have received a copy of the GNU General Public License,
 * version 3.0 (GPLv3) along with this library; if not, see
 * <http://www.gnu.org/licenses/>.
 *
 * 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 org.jumpmind.metl.ui.common;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.jumpmind.vaadin.ui.common.IUiPanel;

import com.vaadin.addon.contextmenu.ContextMenu;
import com.vaadin.server.Resource;
import com.vaadin.ui.Component;
import com.vaadin.ui.TabSheet;
import com.vaadin.ui.themes.ValoTheme;

public class TabbedPanel extends TabSheet {

    private static final long serialVersionUID = 1L;

    protected Tab mainTab;

    protected Map<String, Tab> tabsById = new HashMap<String, Tab>();

    protected Map<Component, String> contentToId = new HashMap<Component, String>();

    protected List<CloseHandler> closeHandlers = new ArrayList<TabSheet.CloseHandler>();

    protected IUiPanel selectedTab;

    protected List<String> selectedOrder = new ArrayList<>();

    boolean closing = false;

    public TabbedPanel() {
        setSizeFull();
        addStyleName(ValoTheme.TABSHEET_FRAMED);

        addSelectedTabChangeListener((event) -> {
            Component selected = event.getTabSheet().getSelectedTab();
            if (selectedTab != null) {
                selectedTab.deselected();
                selectedTab = null;
            }

            if (selected instanceof IUiPanel) {
                selectedTab = ((IUiPanel) selected);
                selectedTab.selected();
            }

            String id = contentToId.get(selectedTab);
            if (id != null && !closing) {
                selectedOrder.add(id);
            }
        });

        setCloseHandler((tabsheet, tabContent) -> close(tabContent));

        ContextMenu menu = new ContextMenu(this, true);
        menu.addItem("Close", (selectedItem) -> close());
        menu.addItem("Close Others", (selectedItem) -> closeOthers());
        menu.addItem("Close To the Left", (selectedItem) -> closeToTheLeft());
        menu.addItem("Close To the Right", (selectedItem) -> closeToTheRight());
        menu.addSeparator();
        menu.addItem("Close All", (selectedItem) -> closeAll());
    }

    protected void close(Component tabContent) {
        String id = contentToId.get(tabContent);
        try {
            closing = true;
            if (tabContent instanceof IUiPanel) {
                if (((IUiPanel) tabContent).closing()) {
                    closeTab(id);
                }
                selectedTab = null;
            } else {
                closeTab(id);
            }

            for (CloseHandler closeHandler : closeHandlers) {
                closeHandler.onTabClose(this, tabContent);
            }

            while (selectedOrder.contains(id)) {
                selectedOrder.remove(id);
            }
        } finally {
            closing = false;
        }

        if (selectedOrder.size() > 0) {
            Tab selectNext = tabsById.get(selectedOrder.get(selectedOrder.size() - 1));
            if (selectNext != null) {
                setSelectedTab(selectNext);
            }
        }
    }

    protected void close() {
        close(getSelectedTab());
    }

    protected void closeAll() {
        for (Component next : getChildren()) {
            close(next);
        }
    }

    protected void closeToTheLeft() {
        Component selected = getSelectedTab();
        for (Component next : getChildren()) {
            if (!next.equals(selected)) {
                close(next);
            } else {
                break;
            }
        }
    }

    protected void closeToTheRight() {
        Component selected = getSelectedTab();
        boolean closing = false;
        for (Component next : getChildren()) {
            if (next.equals(selected)) {
                closing = true;
            } else if (closing) {
                close(next);
            }
        }
    }

    protected void closeOthers() {
        Component selected = getSelectedTab();
        for (Component next : getChildren()) {
            if (!next.equals(selected)) {
                close(next);
            }
        }
    }

    protected List<Component> getChildren() {
        List<Component> children = new ArrayList<>(getComponentCount());
        Iterator<Component> i = iterator();
        while (i.hasNext()) {
            children.add(i.next());
        }
        return children;
    }

    public void addCloseHandler(CloseHandler handler) {
        this.closeHandlers.add(handler);
    }

    public void setMainTab(String caption, Resource icon, Component component) {
        component.setSizeFull();
        this.mainTab = addTab(component, caption, icon, 0);
    }

    public boolean closeTab(String id) {
        Tab tab = tabsById.remove(id);
        if (tab != null) {
            contentToId.remove(tab.getComponent());
            this.removeTab(tab);
            return true;
        } else {
            return false;
        }
    }

    public void addCloseableTab(String id, String caption, Resource icon, Component component) {
        Tab tab = tabsById.get(id);
        if (tab == null) {
            component.setSizeFull();
            contentToId.put(component, id);
            tab = addTab(component, caption, icon);
            tab.setClosable(true);
            tabsById.put(id, tab);
            setSelectedTab(tab);
        } else {
            setSelectedTab(tab);
        }
    }

}