org.eclipse.jface.wizard.IWizardPage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface Show documentation
JFace
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2023 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.wizard;

import org.eclipse.jface.dialogs.IDialogPage;
import org.eclipse.swt.graphics.Point;

/**
 * Interface for a wizard page.
 * 
 * The class WizardPage provides an abstract implementation
 * of this interface. However, clients are also free to implement this
 * interface if WizardPage does not suit their needs.
 * 
 */
public interface IWizardPage extends IDialogPage {
	/**
	 * Returns whether the next page could be displayed.
	 *
	 * @return true if the next page could be displayed,
	 *   and false otherwise
	 */
	public boolean canFlipToNextPage();

	/**
	 * Returns the minimum page size used of this page. May return {@code null} if
	 * this page doesn't specify a minimum size..
	 *
	 * @see IWizard#getMinimumWizardSize()
	 * @return the minimum page size encoded as new Point(width,height)
	 * @since 3.30
	 */
	default Point getMinimumPageSize() {
		return null;
	}

	/**
	 * Returns this page's name.
	 *
	 * @return the name of this page
	 */
	public String getName();

	/**
	 * Returns the wizard page that would to be shown if the user was to
	 * press the Next button.
	 *
	 * @return the next wizard page, or null if none
	 */
	public IWizardPage getNextPage();

	/**
	 * Returns the wizard page that would to be shown if the user was to
	 * press the Back button.
	 *
	 * @return the previous wizard page, or null if none
	 */
	public IWizardPage getPreviousPage();

	/**
	 * Returns the wizard that hosts this wizard page.
	 *
	 * @return the wizard, or null if this page has not been
	 *   added to any wizard
	 * @see #setWizard
	 */
	public IWizard getWizard();

	/**
	 * Returns whether this page is complete or not.
	 * 
	 * This information is typically used by the wizard to decide
	 * when it is okay to finish.
	 * 
	 *
	 * @return true if this page is complete, and
	 *  false otherwise
	 */
	public boolean isPageComplete();

	/**
	 * Sets the wizard page that would typically be shown
	 * if the user was to press the Back button.
	 * 
	 * This method is called by the container.
	 * 
	 *
	 * @param page the previous wizard page
	 */
	public void setPreviousPage(IWizardPage page);

	/**
	 * Sets the wizard that hosts this wizard page.
	 * Once established, a page's wizard cannot be changed
	 * to a different wizard.
	 *
	 * @param newWizard the wizard
	 * @see #getWizard
	 */
	public void setWizard(IWizard newWizard);
}