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.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<EmbeddedWizardPage<?>> currentPage  
    @NotNull javafx.beans.property.ReadOnlyObjectProperty<WizardState> state  
    @NotNull javafx.beans.property.MapProperty<java.lang.String,​EmbeddedWizardPage<?>> visitablePages  

  • Constructor Summary

    Constructors 
    Constructor Description
    WizardController()  

  • 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.
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty changingPageProperty()
    Returns the property holding whether the current page is currently changed.
    @NotNull javafx.beans.property.ReadOnlyObjectProperty<EmbeddedWizardPage<?>> currentPageProperty()  
    @NotNull EmbeddedWizardPage<?> getCurrentPage()
    Gets the value of the property currentPage.
    @NotNull WizardState getState()
    Gets the value of the property state.
    @NotNull java.util.Map<java.lang.String,​EmbeddedWizardPage<?>> getVisitablePages()
    Gets the value of the property visitablePages.
    @NotNull java.util.Optional<java.util.ArrayList<java.lang.String>> getVisitedPages()
    Returns a list of all visited pages if the wizard finished.
    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.
    void putPage​(@NotNull java.lang.String key, @NotNull EmbeddedWizardPage<?> 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,​EmbeddedWizardPage<?>> visitablePages)
    Sets a new map of visitable pages.
    @NotNull javafx.beans.property.ReadOnlyObjectProperty<WizardState> stateProperty()  
    @NotNull javafx.beans.property.MapProperty<java.lang.String,​EmbeddedWizardPage<?>> visitablePagesProperty()  

    Methods inherited from class java.lang.Object

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

  • Property Details

  • Constructor Details

    • WizardController

      public WizardController() throws javafx.fxml.LoadException
      Throws:
      javafx.fxml.LoadException

  • Method Details

    • visitablePagesProperty

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

    • getVisitablePages

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

    • setVisitablePages

      public void setVisitablePages​(@NotNull @NotNull java.util.Map<java.lang.String,​EmbeddedWizardPage<?>> 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.

    • putPage

      public void putPage​(@NotNull @NotNull java.lang.String key, @NotNull @NotNull EmbeddedWizardPage<?> 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.

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

    • getCurrentPage

      @NotNull public @NotNull EmbeddedWizardPage<?> 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.

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

    • getVisitedPages

      @NotNull public @NotNull java.util.Optional<java.util.ArrayList<java.lang.String>> getVisitedPages()
      Returns a list of all visited pages if the wizard finished.