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 Summary

    Properties 
    Type Property Description
    @NotNull javafx.beans.property.ReadOnlyBooleanWrapper aborted  
    @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.ReadOnlyBooleanProperty changingPage
    Returns the property holding whether the current page is currently changed.
    @NotNull javafx.beans.property.ReadOnlyObjectProperty<WizardPage<?>> currentPage  
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty finished
    Returns the property representing whether the wizard is finished.
    @NotNull javafx.beans.property.MapProperty<java.lang.String,​WizardPage<?>> visitablePages  

  • Constructor Summary

    Constructors 
    Constructor Description
    WizardController()  

  • Method Summary

    Modifier and Type Method Description
    @NotNull javafx.beans.property.ReadOnlyBooleanWrapper abortedProperty()  
    @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.
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty changingPageProperty()
    Returns the property holding whether the current page is currently changed.
    @NotNull javafx.beans.property.ReadOnlyObjectProperty<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 java.util.Map<java.lang.String,​WizardPage<?>> getVisitablePages()
    Gets the value of the property visitablePages.
    boolean isAborted()  
    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 isChangingPage()
    Checks whether this wizard is currently changing its page.
    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.
    void setVisitablePages​(@NotNull java.util.Map<java.lang.String,​WizardPage<?>> visitablePages)
    Sets a new map of visitable pages.
    @NotNull javafx.beans.property.MapProperty<java.lang.String,​WizardPage<?>> visitablePagesProperty()  

    Methods inherited from class java.lang.Object

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

  • Property Details

    • visitablePages

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

    • 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.ReadOnlyObjectProperty<WizardPage<?>> currentPageProperty
      See Also:
      getCurrentPage()

    • changingPage

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty changingPageProperty
      Returns the property holding whether the current page is currently changed.
      See Also:
      isChangingPage()

    • aborted

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanWrapper abortedProperty

  • Constructor Details

  • Method Details

    • visitablePagesProperty

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

    • getVisitablePages

      @NotNull public @NotNull java.util.Map<java.lang.String,​WizardPage<?>> getVisitablePages()
      Gets the value of the property visitablePages.
      Property description:

    • 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.

    • 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. 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.

    • 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.

    • 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.ReadOnlyObjectProperty<WizardPage<?>> currentPageProperty()
      See Also:
      getCurrentPage()

    • getCurrentPage

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

    • changingPageProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty changingPageProperty()
      Returns the property holding whether the current page is currently changed.
      See Also:
      isChangingPage()

    • isChangingPage

      public boolean isChangingPage()
      Checks whether this wizard is currently changing its page.
      Returns:
      true only if this wizard is currently changing its page.

    • abortedProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanWrapper abortedProperty()

    • isAborted

      public boolean isAborted()

    • 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.