org.valkyriercp.wizard.WizardContainer 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.wizard;

/**
 * Interface for containers that can host a wizard. It displays wizard pages, at
 * most one of which is considered the current page. getCurrentPage
 * returns the current page; showPage programmatically changes
 * the the current page. Note that the pages need not all belong to the same
 * wizard.
 * 
 * The class WizardDialog provides a fully functional
 * implementation of this interface which will meet the needs of most clients.
 * However, clients are also free to implement this interface if
 * WizardDialog does not suit their needs.
 * 
 * 
 * Implementors are responsible for disposing of their wizards.
 * 
 */
public interface WizardContainer {

    /**
     * Returns the current wizard page for this container.
     *
     * @return the current wizard page, or null if the container
     *         is not yet showing the wizard
     * @see #showPage
     */
    public WizardPage getCurrentPage();

    /**
     * Makes the given page visible.
     * 
     * This method should not be use for normal page sequencing (back, next)
     * which is handled by the container itself. It may, however, be used to
     * move to another page in response to some custom action such as double
     * clicking in a list.
     * 
     *
     * @param page
     *            the page to show
     * @see #getCurrentPage
     */
    public void showPage(WizardPage page);

}