org.jpedal.examples.viewer.gui.popups.WizardPanelModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsign-jpedal Show documentation
JPedal fork
The newest version!
/*
 * ===========================================
 * Java Pdf Extraction Decoding Access Library
 * ===========================================
 *
 * Project Info:  http://www.idrsolutions.com
 * Help section for developers at http://www.idrsolutions.com/java-pdf-library-support/
 *
 * (C) Copyright 1997-2013, IDRsolutions and Contributors.
 *
 * 	This file is part of JPedal
 *
     This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


 *
 * ---------------
 * WizardPanelModel.java
 * ---------------
 */

package org.jpedal.examples.viewer.gui.popups;

import java.awt.event.KeyListener;
import java.util.Map;

import javax.swing.event.ChangeListener;

/**
 * In order to use the Wizard class you need to implement this interface. The implemented class will contain the contents of the user defined panels
 * and add listeners to components that effect the ability to go to the next panel. See SignWizardModel.java for an example.
 */

public interface WizardPanelModel {
	/**
	 * @return true if the currently displayed panel requires a Finish box instead of a next box.
	 */
	public abstract boolean isFinishPanel();

	/**
	 * @return The unique ID String of the first JPanel to be shown
	 */
	public abstract String getStartPanelID();

	/**
	 * @return The ID of the JPanel that should be displayed if next is clicked.
	 */
	public abstract String next();

	/**
	 * @return The ID of the JPanel that should be displayed if previous is clicked.
	 */
	public abstract String previous();

	/**
	 * This method can contain any housekeeping you require when the Wizard is exited.
	 */
	public abstract void close();

	/**
	 * @return true if the current panel has a previous panel
	 */
	public abstract boolean hasPrevious();

	/**
	 * @return true if the current panel is able to advance.
	 */
	public abstract boolean canAdvance();

	/**
	 * In order to use the Card Layout in the wizard class each JPanel must have a unique String identifier. ie HashMap
	 * 
	 * @return A mapping of ID Strings to JPanels.
	 */
	public abstract Map getJPanels();

	/**
	 * A component that is registered will alert the Wizard class that it should check whether the advance button should be enabled.
	 * 
	 * @param changelistener
	 */
	public abstract void registerNextChangeListeners(ChangeListener changelistener);

	/**
	 * The same effect as registerNextChangeListeners(ChangeListener e) except applied to keys.
	 * 
	 * @param keylistener that the registered component effects the Next button enable/disable status
	 */
	public abstract void registerNextKeyListeners(KeyListener keylistener);
}