Enum Class WizardStepType

java.lang.Object

java.lang.Enum<WizardStepType>

org.patternfly.component.wizard.WizardStepType

All Implemented Interfaces:

Serializable, Comparable<WizardStepType>, Constable

public enum WizardStepType
extends Enum<WizardStepType>

Wizard step types.

See Also:

• https://www.patternfly.org/components/wizard/design-guidelines/#review-and-completion

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
progress	If it takes a long time (more than a few seconds) for changes to be applied, a progress step is recommended.
review	Represents the last step in a wizard.
step	Represents a normal step in a wizard.
summary	Once the changes initiated by the wizard are completed, a final confirmation screen should be displayed.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

step

public static final WizardStepType step

Represents a normal step in a wizard.

review

public static final WizardStepType review

Represents the last step in a wizard. This step should include a summary of what the user has inputted so the user may confirm them before committing their changes.

progress

public static final WizardStepType progress

If it takes a long time (more than a few seconds) for changes to be applied, a progress step is recommended. This can be constructed from a variation of the empty state pattern by embedding a progress bar and appropriate messaging within the body of the wizard.

summary

public static final WizardStepType summary

Once the changes initiated by the wizard are completed, a final confirmation screen should be displayed. Again, this can leverage an empty state pattern to present a success (or failure) message to users.

Method Details

values

public static WizardStepType[] 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 WizardStepType 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