Module bayern.steinbrecher.GenericWizard
Package bayern.steinbrecher.wizard

Class Wizard

java.lang.Object
bayern.steinbrecher.wizard.Wizard
public class Wizard
extends java.lang.Object
Represents a wizard for showing a sequence of Panes. You can step back and forward on these 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
Since:
1.0
Author:
Stefan Huber

  • Property Summary

    Properties 
    Type Property Description
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty atBeginning  
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty atFinish
    Property containing a boolean value representing whether the current page shown is a last one.
    @NotNull javafx.beans.property.ReadOnlyProperty<WizardPage<?>> currentPage  
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty finished
    Returns the property representing whether the wizard is finished.

  • Method Summary

    Modifier and Type Method Description
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty atBeginningProperty()  
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty atFinishProperty()
    Property containing a boolean value representing whether the current page shown is a last one.
    static @NotNull Wizard create​(@NotNull java.util.Map<java.lang.String,​WizardPage<?>> pages)  
    @NotNull javafx.beans.property.ReadOnlyProperty<WizardPage<?>> currentPageProperty()  
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty finishedProperty()
    Returns the property representing whether the wizard is finished.
    @NotNull WizardPage<?> getCurrentPage()
    Gets the value of the property currentPage.
    @NotNull java.util.Optional<java.util.Map<java.lang.String,​?>> getResults()
    Returns the results of all pages visited in a sequence to an end.
    @NotNull javafx.scene.Parent getRoot()  
    boolean isAtBeginning()
    Gets the value of the property atBeginning.
    boolean isAtFinish()
    Returns a boolean value representing whether the current page shown is a last one.
    boolean isFinished()
    Checks whether the wizard is finished.
    void put​(@NotNull java.lang.String key, @NotNull WizardPage<?> page)
    Adds the given page to the wizard and replaces pages with the same key but only if the page was not already visited.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Property Details

    • finished

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty finishedProperty
      Returns the property representing whether the wizard is finished. NOTE: It is not finished when it was closed without using the "finish" button.
      See Also:
      isFinished()

    • atBeginning

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty atBeginningProperty
      See Also:
      isAtBeginning()

    • atFinish

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty atFinishProperty
      Property containing a boolean value representing whether the current page shown is a last one.
      See Also:
      isAtFinish()

    • currentPage

      @NotNull public @NotNull javafx.beans.property.ReadOnlyProperty<WizardPage<?>> currentPageProperty
      See Also:
      getCurrentPage()

  • Method Details

    • create

      @Contract("_ -> new") @NotNull public static @NotNull Wizard create​(@NotNull @NotNull java.util.Map<java.lang.String,​WizardPage<?>> pages)

    • put

      public void put​(@NotNull @NotNull java.lang.String key, @NotNull @NotNull WizardPage<?> page)
      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.
      Parameters:
      key - The key the page is associated with.
      page - The page to add to the wizard.

    • getRoot

      @NotNull public @NotNull javafx.scene.Parent getRoot()

    • finishedProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty finishedProperty()
      Returns the property representing whether the wizard is finished. NOTE: It is not finished when it was closed without using the "finish" button.
      See Also:
      isFinished()

    • isFinished

      public boolean isFinished()
      Checks whether the wizard is finished. NOTE: It is not finished when it was closed without using the "finish" button.
      Returns:
      true only if the wizard is finished.

    • getResults

      @NotNull public @NotNull java.util.Optional<java.util.Map<java.lang.String,​?>> getResults()
      Returns the results of all pages visited in a sequence to an end.
      Returns:
      Optional.empty() only if the wizard is not finished yet, otherwise the results of the visited pages.

    • atBeginningProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty atBeginningProperty()
      See Also:
      isAtBeginning()

    • isAtBeginning

      public boolean isAtBeginning()
      Gets the value of the property atBeginning.
      Property description:

    • atFinishProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty atFinishProperty()
      Property containing a boolean value representing whether the current page shown is a last one.
      See Also:
      isAtFinish()

    • isAtFinish

      public boolean isAtFinish()
      Returns a boolean value representing whether the current page shown is a last one.
      Returns:
      true only if the current page is a last one.

    • currentPageProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyProperty<WizardPage<?>> currentPageProperty()
      See Also:
      getCurrentPage()

    • getCurrentPage

      @NotNull public @NotNull WizardPage<?> getCurrentPage()
      Gets the value of the property currentPage.
      Property description: