com.ocs.dynamo.ui.composite.layout.TabWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamo-frontend Show documentation
The newest version!
/*
   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.ocs.dynamo.ui.composite.layout;

import java.util.HashMap;
import java.util.Map;

import com.ocs.dynamo.constants.DynamoConstants;
import com.ocs.dynamo.ui.component.DefaultVerticalLayout;
import com.ocs.dynamo.ui.utils.VaadinUtils;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.ComponentEventListener;
import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.button.ButtonVariant;
import com.vaadin.flow.component.icon.Icon;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.component.tabs.Tab;
import com.vaadin.flow.component.tabs.Tabs;
import com.vaadin.flow.component.tabs.Tabs.SelectedChangeEvent;
import com.vaadin.flow.shared.Registration;

/**
 * A simple wrapper component around the Vaadin Flow tab sheet that displays a
 * component when a tab sheet is clicked
 * 
 * @author Bas Rutten
 *
 */
public class TabWrapper extends DefaultVerticalLayout {

	private static final long serialVersionUID = -3247803933862947954L;

	private VerticalLayout displayedPage;

	private Tabs tabs;

	private Map tabsToPages = new HashMap<>();

	public TabWrapper() {
		setMargin(false);
		tabs = new Tabs();
		tabs.addSelectedChangeListener(event -> {
			Component selectedPage = tabsToPages.get(tabs.getSelectedTab());
			if (selectedPage != null) {
				displayedPage.removeAll();
				displayedPage.add(selectedPage);
			}
		});
		add(tabs);
		displayedPage = new DefaultVerticalLayout(true, false);
		displayedPage.setClassName(DynamoConstants.CSS_TAB_LAYOUT_DISPLAY_PAGE);
		displayedPage.setMargin(true);
		add(displayedPage);
	}

	/**
	 * Adds a selection change listener
	 * 
	 * @param listener the listener to add
	 * @return
	 */
	public Registration addSelectedChangeListener(ComponentEventListener listener) {
		return tabs.addSelectedChangeListener(listener);
	}

	/**
	 * Adds a new tab
	 * 
	 * @param caption     the caption of the tab
	 * @param description the tool tip/description of the tab
	 * @param component   the component to display inside the tab
	 * @param icon        the icon to display on the tab(optional)
	 * @return
	 */
	public Tab addTab(String caption, String description, Component component, Icon icon) {
		Button button = new Button(caption);
		button.addThemeVariants(ButtonVariant.LUMO_TERTIARY_INLINE);

		if (icon != null) {
			button.setIcon(icon);
		}
		if (description != null) {
			VaadinUtils.setTooltip(button, description);
		}

		Tab tab = new Tab(button);

		tabsToPages.put(tab, component);
		tabs.add(tab);
		if (displayedPage.getChildren().count() == 0L) {
			displayedPage.add(component);
		}

		return tab;
	}

	@Override
	public Component getComponentAt(int index) {
		Tab tab = getTabByIndex(index);
		return tabsToPages.get(tab);
	}

	public int getSelectedIndex() {
		return tabs.getSelectedIndex();
	}

	public Tab getTabByIndex(int index) {
		return (Tab) tabs.getTabAt(index);
	}

	/**
	 * Replaces the component at the specified index by the specified component
	 * 
	 * @param index     the index
	 * @param component the component
	 */
	public void setComponent(int index, Component component) {

		Tab tab = getTabByIndex(index);
		tabsToPages.put(tab, component);

		// show just this tab
		if (component != null) {
			displayedPage.removeAll();
			displayedPage.add(component);
		}
	}

	public void setSelectedIndex(int selectedIndex) {
		tabs.setSelectedIndex(selectedIndex);
	}
}