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

Class WizardPage<T>

java.lang.Object
bayern.steinbrecher.wizard.WizardPage<T>
Type Parameters:
T - The return type of the result represented by the page.
public final class WizardPage<T>
extends java.lang.Object
Represents a page of the wizard.
Since:
1.0
Author:
Stefan Huber

  • Property Summary

    Properties 
    Type Property Description
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty hasNextFunction
    Returns the property holding true only if this page has a nextFunction.
    @NotNull javafx.beans.property.ReadOnlyProperty<java.util.function.Supplier<java.lang.String>> nextFunction
    The property containing the function calculating which page to show next.
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty valid
    Returns the property representing whether this page has valid input.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String FIRST_PAGE_KEY
    The key of the page to be used as first one.

  • Constructor Summary

    Constructors 
    Constructor Description
    WizardPage​(@NotNull javafx.scene.layout.Pane root, @Nullable java.util.function.Supplier<java.lang.String> nextFunction, boolean finish, @NotNull java.util.function.Supplier<T> resultFunction)
    Creates a new page with given params.
    WizardPage​(@NotNull javafx.scene.layout.Pane root, @Nullable java.util.function.Supplier<java.lang.String> nextFunction, boolean finish, @NotNull java.util.function.Supplier<T> resultFunction, @NotNull javafx.beans.value.ObservableValue<? extends java.lang.Boolean> valid)
    Creates a new page with given params.

  • Method Summary

    Modifier and Type Method Description
    @Nullable java.util.function.Supplier<java.lang.String> getNextFunction()
    Returns the function calculating the key of the next page.
    @NotNull java.util.function.Supplier<T> getResultFunction()
    Returns the function calculating the result this page represents.
    @NotNull javafx.scene.layout.Pane getRoot()
    Returns the pane containing all controls.
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty hasNextFunctionProperty()
    Returns the property holding true only if this page has a nextFunction.
    boolean isFinish()
    Returns whether this page is a last one.
    boolean isHasNextFunction()
    Checks whether this page has a nextFunction.
    boolean isValid()
    Returns whether the current input of this page is valid.
    void makeFinishPage​(boolean finish, @Nullable java.util.function.Supplier<java.lang.String> nextFunction)  
    @NotNull javafx.beans.property.ReadOnlyProperty<java.util.function.Supplier<java.lang.String>> nextFunctionProperty()
    The property containing the function calculating which page to show next.
    void setValidBinding​(@NotNull javafx.beans.value.ObservableValue<? extends java.lang.Boolean> validBinding)
    Sets a new binding to bind this pages valid property to.
    @NotNull javafx.beans.property.ReadOnlyBooleanProperty validProperty()
    Returns the property representing whether this page has valid input.

    Methods inherited from class java.lang.Object

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

  • Property Details

    • nextFunction

      @NotNull public @NotNull javafx.beans.property.ReadOnlyProperty<java.util.function.Supplier<java.lang.String>> nextFunctionProperty
      The property containing the function calculating which page to show next.
      See Also:
      getNextFunction()

    • valid

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty validProperty
      Returns the property representing whether this page has valid input.
      See Also:
      isValid()

    • hasNextFunction

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty hasNextFunctionProperty
      Returns the property holding true only if this page has a nextFunction.
      See Also:
      isHasNextFunction()

  • Field Details

  • Constructor Details

    • WizardPage

      public WizardPage​(@NotNull @NotNull javafx.scene.layout.Pane root, @Nullable @Nullable java.util.function.Supplier<java.lang.String> nextFunction, boolean finish, @NotNull @NotNull java.util.function.Supplier<T> resultFunction, @NotNull @NotNull javafx.beans.value.ObservableValue<? extends java.lang.Boolean> valid)
      Creates a new page with given params.
      Parameters:
      root - The root pane containing all controls.
      nextFunction - The function calculating the name of the next page. In case finish is true this value is allowed to be null.
      finish - true only if this page is a last one.
      resultFunction - The function calculating the result this page represents.
      valid - A binding to bind this pages valid property to.

    • WizardPage

      public WizardPage​(@NotNull @NotNull javafx.scene.layout.Pane root, @Nullable @Nullable java.util.function.Supplier<java.lang.String> nextFunction, boolean finish, @NotNull @NotNull java.util.function.Supplier<T> resultFunction)
      Creates a new page with given params. The valid property always contains true.
      Parameters:
      root - The root pane containing all controls.
      nextFunction - The function calculating the name of the next page. In case finish is true this value is allowed to be null.
      finish - true only if this page is a last one.
      resultFunction - The function calculating the result this page represents.

  • Method Details

    • getRoot

      @NotNull public @NotNull javafx.scene.layout.Pane getRoot()
      Returns the pane containing all controls.
      Returns:
      The pane containing all controls.

    • nextFunctionProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyProperty<java.util.function.Supplier<java.lang.String>> nextFunctionProperty()
      The property containing the function calculating which page to show next.
      See Also:
      getNextFunction()

    • getNextFunction

      @Nullable public @Nullable java.util.function.Supplier<java.lang.String> getNextFunction()
      Returns the function calculating the key of the next page.
      Returns:
      The function calculating the key of the next page. Returns null if this page has no next one.

    • isFinish

      public boolean isFinish()
      Returns whether this page is a last one.
      Returns:
      true only if this page is a last one.

    • makeFinishPage

      public void makeFinishPage​(boolean finish, @Nullable @Nullable java.util.function.Supplier<java.lang.String> nextFunction)

    • getResultFunction

      @NotNull public @NotNull java.util.function.Supplier<T> getResultFunction()
      Returns the function calculating the result this page represents.
      Returns:
      The function calculating the result this page represents.

    • setValidBinding

      public void setValidBinding​(@NotNull @NotNull javafx.beans.value.ObservableValue<? extends java.lang.Boolean> validBinding)
      Sets a new binding to bind this pages valid property to.
      Parameters:
      validBinding - A new binding to bind this pages valid property to.

    • validProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty validProperty()
      Returns the property representing whether this page has valid input.
      See Also:
      isValid()

    • isValid

      public boolean isValid()
      Returns whether the current input of this page is valid.
      Returns:
      true only if the current input of this page is valid.

    • hasNextFunctionProperty

      @NotNull public @NotNull javafx.beans.property.ReadOnlyBooleanProperty hasNextFunctionProperty()
      Returns the property holding true only if this page has a nextFunction.
      See Also:
      isHasNextFunction()

    • isHasNextFunction

      public boolean isHasNextFunction()
      Checks whether this page has a nextFunction.
      Returns:
      Returns true only if this page has a nextFunction.
      See Also:
      nextFunctionProperty()