org.valkyriercp.dialog.TabbedDialogPage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of valkyrie-rcp-core Show documentation
There is a newer version: 1.3
package org.valkyriercp.dialog;

import org.valkyriercp.core.support.LabeledObjectSupport;
import org.valkyriercp.dialog.control.ExtTabbedPane;
import org.valkyriercp.dialog.control.Tab;
import org.valkyriercp.dialog.control.VetoableSingleSelectionModel;

import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * A concrete implementation of CompositeDialogPage that presents
 * the child pages in a JTabbedPane.
 * 
 * Each child page is placed into a separate tab of the JTabbedPane.
 * This class also decorates the tab titles to indicate the page completed
 * status.
 * 
 * Has support for hiding/showing DialogPages; on
 * DialogPage.setVisible(false) the tab for the page is removed
 * from the ui, on DialogPage.setVisible(true) it is shown again.
 *
 * @author Oliver Hutchison
 * @author Peter De Bruycker
 */
public class TabbedDialogPage extends CompositeDialogPage {
	private ExtTabbedPane tabbedPaneView;

	private Map page2tab = new HashMap();

	private Map tab2Page = new HashMap();

	private boolean settingSelection;

	public TabbedDialogPage(String pageId) {
		super(pageId);
	}

	public TabbedDialogPage(String pageId, boolean autoConfigure) {
		super(pageId, autoConfigure);
	}

	protected JComponent createControl() {
		createPageControls();
		final JTabbedPane tabbedPane = applicationConfig.componentFactory().createTabbedPane();
		tabbedPaneView = new ExtTabbedPane(tabbedPane);

		List pages = getPages();
		for (int i = 0; i < pages.size(); i++) {
			final DialogPage page = (DialogPage) pages.get(i);
			final Tab tab = new Tab();

			JComponent control = page.getControl();
			control.setPreferredSize(getLargestPageSize());

			tab.setComponent(control);
			tab.setVisible(page.isVisible());
			tab.setEnabled(page.isEnabled());
			decorateTab(tab, page);

			page2tab.put(page, tab);
			tab2Page.put(tab, page);
			tabbedPaneView.addTab(tab);
		}

		tabbedPane.setModel(new VetoableSingleSelectionModel() {
			protected boolean selectionAllowed(int index) {
				return canChangeTabs();
			}
		});

		tabbedPaneView.addChangeListener(new ChangeListener() {
			public void stateChanged(ChangeEvent e) {
				int index = tabbedPane.getSelectedIndex();

				if (index >= 0) {
					index = tabbedPaneView.convertUIIndexToModelIndex(index);
					Tab tab = tabbedPaneView.getTab(index);
					setActivePage((DialogPage) tab2Page.get(tab));
				}
				else {
					setActivePage(null);
				}
			}
		});

		// show first visible tab
		setActivePage((DialogPage) pages.get(tabbedPaneView.convertUIIndexToModelIndex(0)));
		return tabbedPane;
	}

	/**
	 * Sets the active page of this TabbedDialogPage. This method will also
	 * select the tab wich displays the new active page.
	 *
	 */
	public void setActivePage(DialogPage page) {
		if (settingSelection) {
			return;
		}

		try {
			settingSelection = true;

			super.setActivePage(page);
			if (page != null) {
				Tab tab = (Tab) page2tab.get(page);
				tabbedPaneView.selectTab(tab);
			}
		}
		finally {
			settingSelection = false;
		}
	}

	protected boolean canChangeTabs() {
		return true;
	}

	protected void updatePageComplete(DialogPage page) {
		super.updatePageComplete(page);

		if (tabbedPaneView != null) {
			Tab tab = (Tab) page2tab.get(page);
			decorateTab(tab, page);
		}
	}

	protected void decorateTab(Tab tab, DialogPage page) {
		tab.setTitle(getDecoratedPageTitle(page));
		tab.setTooltip(page.getDescription());
		if (page instanceof LabeledObjectSupport) {
			tab.setMnemonic(((LabeledObjectSupport) page).getMnemonic());
		}
		tab.setIcon(page.getIcon());
	}

	protected void updatePageVisibility(DialogPage page) {
		Tab tab = getTab(page);
		tab.setVisible(page.isVisible());
	}

	protected void updatePageEnabled(DialogPage page) {
		Tab tab = getTab(page);
		tab.setEnabled(page.isEnabled());
	}

	protected void updatePageLabels(DialogPage page) {
		Tab tab = getTab(page);
		tab.setTitle(getDecoratedPageTitle(page));
	}

	protected final Tab getTab(final DialogPage page) {
		return (Tab) page2tab.get(page);
	}
}