Package com.jbstrap.ui.components.wizard

Enum Class WizardStepState

java.lang.Object
java.lang.Enum<WizardStepState>
com.jbstrap.ui.components.wizard.WizardStepState
All Implemented Interfaces:
Serializable, Comparable<WizardStepState>, Constable
public enum WizardStepState extends Enum<WizardStepState>
Possible wizard step states.
Since:
4.0
Author:
JBStrap

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACTIVE
    Active
    A step is in “active” state if it is currently displayed to the user on the interface .
    DISABLED
    Disabled
    A step is in “disabled” state if it has been disabled by the code and the user is not allowed to re-enable it.
    DONE
    Done
    A step is in “done” state if the user has completed the step and successfully proceeds to the next one using the navigation buttons.
    INVALID
    Invalid
    A step is in “invalid” state if the user has previously completed the step, but navigates back to the previous step and modifies data.
    PROGRESS
    Progress
    A step is in “progress” state if the user has displayed it, that is, started to enter data, but left the step using either the “Previous” button or the header.
    SUBSEQUENT
    Subsequent
    A step is in “subsequent” state if the user has not displayed while using the wizard component.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getStyleClass()
     
    static WizardStepState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static WizardStepState[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DONE

      public static final WizardStepState DONE
      Done
      A step is in “done” state if the user has completed the step and successfully proceeds to the next one using the navigation buttons.

    • INVALID

      public static final WizardStepState INVALID
      Invalid
      A step is in “invalid” state if the user has previously completed the step, but navigates back to the previous step and modifies data. It is possible that the modification made in the previous step makes data in the current step invalid. The step itself becomes invalid in order for the user to check data validity once again.

    • ACTIVE

      public static final WizardStepState ACTIVE
      Active
      A step is in “active” state if it is currently displayed to the user on the interface .

    • PROGRESS

      public static final WizardStepState PROGRESS
      Progress
      A step is in “progress” state if the user has displayed it, that is, started to enter data, but left the step using either the “Previous” button or the header.

    • SUBSEQUENT

      public static final WizardStepState SUBSEQUENT
      Subsequent
      A step is in “subsequent” state if the user has not displayed while using the wizard component.

    • DISABLED

      public static final WizardStepState DISABLED
      Disabled
      A step is in “disabled” state if it has been disabled by the code and the user is not allowed to re-enable it. Disabled steps are skipped during the navigation.

  • Method Details

    • values

      public static WizardStepState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static WizardStepState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getStyleClass

      public String getStyleClass()
      Returns:
      The state’s style class name or null if there is no style class for the state