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

Class WizardController

java.lang.Object
bayern.steinbrecher.wizard.WizardController
public final class WizardController
extends java.lang.Object
Since:
1.0
Author:
Stefan Huber

  • Property Details

  • Constructor Details

  • Method Details

    • visitablePagesProperty

      @NotNull public @NotNull javafx.beans.property.MapProperty<java.lang.String,​WizardPage<?,​?>> visitablePagesProperty()
      Since:
      1.52
      See Also:
      getVisitablePages(), setVisitablePages(Map)

    • getVisitablePages

      @NotNull public @NotNull java.util.Map<java.lang.String,​WizardPage<?,​?>> getVisitablePages()
      Since:
      1.52

    • setVisitablePages

      public void setVisitablePages​(@NotNull @NotNull java.util.Map<java.lang.String,​WizardPage<?,​?>> visitablePages)
      Sets a new map of visitable pages. NOTE: Calling this method causes the wizard to reset to the first page and clear the history.
      Parameters:
      visitablePages - The map of pages to set.
      Since:
      1.52

    • putPage

      public void putPage​(@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. NOTE: The size of page is not considered anymore after start(...) was called.
      Parameters:
      key - The key the page is associated with.
      page - The page to add to the wizard.
      Since:
      1.52

    • getVisitedPages

      @NotNull public @NotNull java.util.Optional<java.util.ArrayList<java.lang.String>> getVisitedPages()

    • 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()
      See Also:
      isAtFinish()

    • isAtFinish

      public boolean isAtFinish()
      Gets the value of the property atFinish.
      Property description:

    • currentPageProperty

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

    • getCurrentPage

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

    • stateProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyObjectProperty<WizardState> stateProperty()
      See Also:
      getState()

    • getState

      @NotNull public @NotNull WizardState getState()
      Gets the value of the property state.
      Property description:

    • previousDisallowedProperty

      public javafx.beans.property.ReadOnlyBooleanProperty previousDisallowedProperty()
      See Also:
      isPreviousDisallowed()

    • isPreviousDisallowed

      public boolean isPreviousDisallowed()
      Gets the value of the property previousDisallowed.
      Property description:

    • nextDisallowedProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty nextDisallowedProperty()
      See Also:
      isNextDisallowed()

    • isNextDisallowed

      public boolean isNextDisallowed()
      Gets the value of the property nextDisallowed.
      Property description:

    • finishDisallowedProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty finishDisallowedProperty()
      See Also:
      isFinishDisallowed()

    • isFinishDisallowed

      public boolean isFinishDisallowed()
      Gets the value of the property finishDisallowed.
      Property description: