de.intarsys.tools.ui.UIWizard Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isrt Show documentation
The basic runtime tools and interfaces for intarsys components.
There is a newer version: 4.11
/*
 * Copyright (c) 2012, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.tools.ui;

import java.util.ArrayList;
import java.util.List;

import de.intarsys.tools.event.Event;
import de.intarsys.tools.event.INotificationSupport;
import de.intarsys.tools.functor.ArgsConfigurationException;
import de.intarsys.tools.functor.IArgs;
import de.intarsys.tools.functor.IArgsConfigurable;

/**
 * A simple wizard like user interface implementation.
 * 
 * @param 
 * @param 
 * @param 
 */
abstract public class UIWizard extends
		UIComponent {

	private List> pages = new ArrayList>();

	private IUIComponent currentPage;

	public UIWizard(IUIComponent parent) {
		super(parent);
		initPages();
	}

	protected void activatePage(IUIComponent page) {
		if (page == currentPage) {
			return;
		}
		if (currentPage != null) {
			currentPage.dispose();
		}
		currentPage = page;
		currentPage.setObservable(getObservable());
		currentPage.createComponent((C) getComponent());
	}

	protected void addPage(IUIComponent page) {
		pages.add(page);
	}

	@Override
	public void configure(IArgs args) throws ArgsConfigurationException {
		super.configure(args);
		for (IUIComponent page : pages) {
			if (page instanceof IArgsConfigurable) {
				((IArgsConfigurable) page).configure(args);
			}
		}
	}

	@Override
	public void dispose() {
		if (currentPage != null) {
			currentPage.dispose();
		}
		super.dispose();
	}

	public IUIComponent getCurrentPage() {
		return currentPage;
	}

	protected void initPages() {
	}

	public boolean isNextEnabled() {
		return selectNextPage() != currentPage;
	}

	public boolean isPreviousEnabled() {
		return selectPreviousPage() != currentPage;
	}

	public void onNextPressed() {
		activatePage(selectNextPage());
	}

	public void onPreviousPressed() {
		activatePage(selectPreviousPage());
	}

	protected IUIComponent selectInitialPage() {
		if (currentPage == null) {
			return pages.get(0);
		}
		return currentPage;
	}

	protected IUIComponent selectNextPage() {
		int index = pages.indexOf(currentPage);
		if (index == -1) {
			return currentPage;
		}
		if (index + 1 == pages.size()) {
			return currentPage;
		}
		return pages.get(index + 1);
	}

	protected IUIComponent selectPreviousPage() {
		int index = pages.indexOf(currentPage);
		if (index == -1) {
			return currentPage;
		}
		if (index == 0) {
			return currentPage;
		}
		return pages.get(index - 1);
	}

	protected void setCurrentPage(IUIComponent currentPage) {
		this.currentPage = currentPage;
	}

	@Override
	public void setObservable(M observable) {
		if (currentPage != null) {
			currentPage.setObservable(observable);
		}
		super.setObservable(observable);
	}

	@Override
	protected void updateView(Event e) {
		super.updateView(e);
		if (currentPage == null) {
			IUIComponent nextPage = selectInitialPage();
			activatePage(nextPage);
		}
	}
}