bayern.steinbrecher.wizard.Wizard Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Wizard Show documentation
Contains a library to create dynamic and branching JavaFX wizards in an abstract way. Comes with a predefined collection of typical wizard pages.
There is a newer version: 1.60
Show newest version
package bayern.steinbrecher.wizard;

import javafx.beans.property.ReadOnlyBooleanProperty;
import javafx.beans.property.ReadOnlyObjectProperty;
import javafx.beans.property.ReadOnlyProperty;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.ResourceBundle;

/**
 * Represents a wizard for showing a sequence of {@code Pane}s. You can step back and forward on these {@code Panes} and
 * only can close is on the last page.

 * You also can style it using CSS. Following CSS classes are available:

 * 
 * wizard
 * wizard-content
 * wizard-controls
 * 
 *
 * @author Stefan Huber
 * @since 1.0
 */
public class Wizard {

    private final WizardController controller;
    private final Parent root;

    private Wizard(WizardController controller, Parent root) {
        super();
        this.controller = controller;
        this.root = root;
    }

    @Contract("_ -> new")
    @NotNull
    public static Wizard create(@NotNull Map> pages) {
        Objects.requireNonNull(pages);
        FXMLLoader fxmlLoader = new FXMLLoader(Wizard.class.getResource("Wizard.fxml"),
                ResourceBundle.getBundle("bayern.steinbrecher.wizard.Wizard"));
        Parent root;
        try {
            root = fxmlLoader.load();
        } catch (IOException ex) {
            throw new Error("The internal implementation is erroneous", ex);
        }
        WizardController controller = fxmlLoader.getController();
        controller.setVisitablePages(pages);
        Wizard wizard = new Wizard(controller, root);
        pages.values()
                .forEach(p -> p.setContainingWizard(wizard));
        return wizard;
    }

    /**
     * Adds the given page to the wizard and replaces pages with the same key but only if the page was not already
     * visited. This method can be used if a page of the wizard is depending on the result of a previous one.
     *
     * @param key  The key the page is associated with.
     * @param page The page to add to the wizard.
     */
    public void putPage(@NotNull String key, @NotNull EmbeddedWizardPage page) {
        controller.putPage(key, page);
        page.setContainingWizard(this);
    }

    @NotNull
    public Parent getRoot() {
        return root;
    }

    @NotNull
    public ReadOnlyObjectProperty stateProperty() {
        return controller.stateProperty();
    }

    @NotNull
    public WizardState getState() {
        return controller.getState();
    }

    /**
     * Returns the list of visited pages if the wizard finished.
     */
    @NotNull
    public Optional> getVisitedPages() {
        return controller.getVisitedPages();
    }

    @NotNull
    public ReadOnlyBooleanProperty atBeginningProperty() {
        return controller.atBeginningProperty();
    }

    public boolean isAtBeginning() {
        return atBeginningProperty().get();
    }

    /**
     * Property containing a boolean value representing whether the current page shown is a last one.
     *
     * @return {@code true} only if the current page is a last one.
     */
    @NotNull
    public ReadOnlyBooleanProperty atFinishProperty() {
        return controller.atFinishProperty();
    }

    /**
     * Returns a boolean value representing whether the current page shown is a last one.
     *
     * @return {@code true} only if the current page is a last one.
     */
    public boolean isAtFinish() {
        return atFinishProperty().get();
    }

    @NotNull
    public ReadOnlyProperty> currentPageProperty() {
        return controller.currentPageProperty();
    }

    @NotNull
    public EmbeddedWizardPage getCurrentPage() {
        return currentPageProperty().getValue();
    }
}