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

import org.springframework.core.style.ToStringCreator;
import org.valkyriercp.dialog.AbstractDialogPage;

import javax.swing.*;
import java.awt.*;

public abstract class AbstractWizardPage extends AbstractDialogPage implements WizardPage {
    private Wizard wizard;

    private WizardPage previousPage;

    /**
     * Creates a wizard page. This titles of this dialog page will be configured
     * using the default ObjectConfigurer.
     *
     * @param pageId
     *            the id of this wizard page. This will be used to configure the
     *            page.
     */
    protected AbstractWizardPage(String pageId) {
        this(pageId, false);
    }

    /**
     * Creates a new wizard page.
     *
     * @param pageId
     *            the id of this wizard page
     * @param autoConfigure
     *            whether or not to use an ObjectConfigurer to configure the
     *            titles of this dialog page using the given pageId
     */
    protected AbstractWizardPage(String pageId, boolean autoConfigure) {
        super(pageId, autoConfigure);
    }

    /**
     * Creates a new wizard page with the given title.
     *
     * @param pageId
     *            the id of this wizard page
     * @param autoConfigure
     *            whether or not to use an ObjectConfigurer to configure the
     *            titles of this dialog page using the given pageId
     * @param title
     *            the title of this wizard page, or null if none
     */
    protected AbstractWizardPage(String pageId, boolean autoConfigure, String title) {
        super(pageId, autoConfigure, title);
    }

    /**
     * Creates a new wizard page with the given title and image.
     *
     * @param pageId
     *            the id of this wizard page
     * @param autoConfigure
     *            whether or not to use an ObjectConfigurer to configure the
     *            titles of this wizard page using the given pageId
     * @param title
     *            the title of this wizard page, or null if none
     * @param icon
     *            the image for this wizard page, or null if none
     */
    protected AbstractWizardPage(String pageId, boolean autoConfigure, String title, Image icon) {
        super(pageId, autoConfigure, title, icon);
    }

    public String getKey() {
        return getWizard().getId() + "." + getId();
    }

    public Image getImage() {
        Image image = super.getImage();
        if (image != null) {
            return image;
        }
        return wizard.getDefaultPageImage();
    }

    public WizardPage getNextPage() {
        if (wizard == null) {
            return null;
        }
        return wizard.getNextPage(this);
    }

    public WizardPage getPreviousPage() {
        if (previousPage != null) {
            return previousPage;
        }
        if (wizard == null) {
            return null;
        }
        return wizard.getPreviousPage(this);
    }

    public boolean canFlipToNextPage() {
        return isPageComplete() && getNextPage() != null;
    }

    protected boolean isCurrentPage() {
        return (getContainer() != null && this == getContainer().getCurrentPage());
    }

    protected WizardContainer getContainer() {
        if (wizard == null) {
            return null;
        }
        return wizard.getContainer();
    }

    public Wizard getWizard() {
        return wizard;
    }

    public void setPreviousPage(WizardPage page) {
        previousPage = page;
    }

    public void setVisible(boolean visible) {
        JComponent control = getControl();
        if (control != null) {
            super.setVisible(visible);
            control.requestFocusInWindow();
        }
    }

    public void setEnabled(boolean enabled) {
        setPageComplete(enabled);
    }

    public void setWizard(Wizard newWizard) {
        Wizard oldValue = this.wizard;
        this.wizard = newWizard;
        firePropertyChange("wizard", oldValue, newWizard);
    }

    public void onAboutToShow() {
    }

    public String toString() {
        return new ToStringCreator(this).append("id", getId()).toString();
    }
}