Interface PanelManager

src/main/java/docking/wizard/PanelManager.java:24–106

Interface to define methods that control what panel is displayed in a wizard.

 * wizard.
 */
public interface PanelManager {
	/**
	 * Return true if the "finish" step can be completed. 
	 * @return boolean true if ok to finish
	 */
	public boolean canFinish();

	/**
	 * Return true if there is a "next" panel.
	 * @return boolean true means there is a next panel to display
	 */
	public boolean hasNextPanel();

	/**
	 * Return true if there is a "previous" panel.
	 * @return boolean true means there is a previous panel to display
	 */
	public boolean hasPreviousPanel();

	/**
	 * Get the next panel in the process.
	 * @return WizardPanel the next panel
	 * @throws IllegalPanelStateException if an IOException or other unexpected error occurs
	 */
	public WizardPanel getNextPanel() throws IllegalPanelStateException;

	/**
	 * Get the first panel in the process.
	 * @return WizardPanel the first panel
	 * @throws IllegalPanelStateException if an IOException or other unexpected error occurs 
	 */
	public WizardPanel getInitialPanel() throws IllegalPanelStateException;

	/**
	 * Get the previous panel in the process.
	 * @return WizardPanel the previous panel
	 * @throws IllegalPanelStateException if an IOException or other unexpected error occurs 
	 */
	public WizardPanel getPreviousPanel() throws IllegalPanelStateException;

	/**
	 * Get the status message for the current panel.
	 * @return String message to display;
	 *                may be null if there is no message that should be displayed
	 */
	public String getStatusMessage();

	/**
	 * Method called when the user wants to finish the process.
	 * @throws IllegalPanelStateException if an IOException or other unexpected error occurs
	 */
	public void finish() throws IllegalPanelStateException;

	/**
	 * Method called when the user wants to cancel the process.
	 */
	public void cancel();