org.dominokit.domino.ui.stepper

Enum Stepper.StepState

java.lang.Object

java.lang.Enum<Stepper.StepState>

org.dominokit.domino.ui.stepper.Stepper.StepState

All Implemented Interfaces:

Serializable, Comparable<Stepper.StepState>

Enclosing class:

Stepper

public static enum Stepper.StepState
extends Enum<Stepper.StepState>

An enum to list the Step possible states

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE
COMPLETED
DISABLED
ERROR
INACTIVE

Method Summary

Modifier and Type	Method and Description
String	getStyle()
elemental2.dom.Node	render(Step step, Stepper.StepStateColors colors, Stepper.StepNumberRenderer stepNumberRenderer) This method will be called whenever the Step state is changed, the method will use the Stepper.StepNumberRenderer to render the step number based on the new step state
static Stepper.StepState	valueOf(String name) Returns the enum constant of this type with the specified name.
static Stepper.StepState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

public static final Stepper.StepState ACTIVE

INACTIVE

public static final Stepper.StepState INACTIVE

ERROR

public static final Stepper.StepState ERROR

COMPLETED

public static final Stepper.StepState COMPLETED

DISABLED

public static final Stepper.StepState DISABLED

Method Detail

values

public static Stepper.StepState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Stepper.StepState c : Stepper.StepState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Stepper.StepState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

render

public elemental2.dom.Node render(Step step,
                                  Stepper.StepStateColors colors,
                                  Stepper.StepNumberRenderer stepNumberRenderer)

This method will be called whenever the Step state is changed, the method will use the Stepper.StepNumberRenderer to render the step number based on the new step state

Parameters:

step - Step that has it is state changed

colors - Stepper.StepStateColors

stepNumberRenderer - Stepper.StepNumberRenderer

Returns:

the Node to be used as the step number element

getStyle

public String getStyle()

Returns:

String css class name