Package org.patternfly.component.progressstepper

Class ProgressStepper

java.lang.Object

org.patternfly.component.BaseComponent<HTMLOListElement,ProgressStepper>

org.patternfly.component.progressstepper.ProgressStepper

All Implemented Interfaces:

Iterable<ProgressStep>, ElementAttributeMethods<HTMLOListElement,ProgressStepper>, ElementClassListMethods<HTMLOListElement,ProgressStepper>, ElementConsumerMethods<HTMLOListElement,ProgressStepper>, ElementContainerMethods<HTMLOListElement,ProgressStepper>, ElementEventMethods<HTMLOListElement,ProgressStepper>, ElementIdMethods<HTMLOListElement,ProgressStepper>, ElementQueryMethods<HTMLOListElement>, HTMLElementAttributeMethods<HTMLOListElement,ProgressStepper>, HTMLElementDataMethods<HTMLOListElement,ProgressStepper>, HTMLElementStyleMethods<HTMLOListElement,ProgressStepper>, HTMLElementVisibilityMethods<HTMLOListElement,ProgressStepper>, IsElement<HTMLOListElement>, TypedBuilder<HTMLOListElement,ProgressStepper>, Component, HasItems<HTMLOListElement,ProgressStepper,ProgressStep>, org.patternfly.style.Modifiers.Center<HTMLOListElement,ProgressStepper>, org.patternfly.style.Modifiers.Compact<HTMLOListElement,ProgressStepper>, org.patternfly.style.Modifiers.Vertical<HTMLOListElement,ProgressStepper>

public class ProgressStepper
extends BaseComponent<HTMLOListElement,ProgressStepper>
implements org.patternfly.style.Modifiers.Center<HTMLOListElement,ProgressStepper>, org.patternfly.style.Modifiers.Compact<HTMLOListElement,ProgressStepper>, HasItems<HTMLOListElement,ProgressStepper,ProgressStep>, org.patternfly.style.Modifiers.Vertical<HTMLOListElement,ProgressStepper>

A progress stepper displays a timeline of tasks in a workflow and tracks a user's progress through the workflow. The navigation semantics use a sentinel index interval of [-1, size]:

• -1 → underflow / before first element (no current step)
• 0..n-1 → valid current step indices
• size() → overflow / after last element (no current step)

See Also:

• https://www.patternfly.org/components/progress-stepper/

Method Summary

Modifier and Type	Method	Description
ProgressStepper	add(ProgressStep item)
ProgressStepper	ariaLabel(String label)
void	clear()
boolean	contains(String identifier)
int	currentIndex()	Returns the index of the current progress step.
ProgressStepper	first()	Selects the first step (index 0) if available.
ProgressStepper	first(Consumer<ProgressStep> actionForTheFirstStep, Consumer<ProgressStep> actionForThePreviousCurrentStep)	Selects the first step (index 0) if available.
boolean	isEmpty()
ProgressStep	item(String identifier)
Iterator<ProgressStep>	iterator()
ProgressStepper	last()	Selects the last step (index size-1) if present.
ProgressStepper	last(Consumer<ProgressStep> actionForTheLastStep, Consumer<ProgressStep> actionForThePreviousCurrentStep)	Selects the last step (index size-1) if present.
ProgressStepper	next()	Moves one step forward.
ProgressStepper	next(BiConsumer<Optional<ProgressStep>,Integer> actionForTheNewCurrentWithIndex, Consumer<ProgressStep> actionForThePreviousCurrent)	Moves one step forward with callbacks.
ProgressStepper	previous()	Moves one step backward.
ProgressStepper	previous(BiConsumer<Optional<ProgressStep>,Integer> actionForTheNewCurrentStepWithIndex, Consumer<ProgressStep> actionForThePreviousCurrentStep)	Moves one step backward with callbacks.
static ProgressStepper	progressStepper()
ProgressStepper	setupSteps(BiConsumer<ProgressStep,Integer> stepConsumerWithIndex)	Applies the provided consumer to each step with its index in insertion order.
int	size()
ProgressStepper	that()
<T> void	updateItems(Iterable<T> items, Function<T,ProgressStep> display)

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.HasItems

addItem, addItems, items

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.patternfly.style.Modifiers.Center

center, center

Methods inherited from interface org.patternfly.style.Modifiers.Compact

compact, compact

Methods inherited from interface org.patternfly.style.Modifiers.Vertical

vertical, vertical

Method Details

progressStepper

public static ProgressStepper progressStepper()

add

public ProgressStepper add(ProgressStep item)

Specified by:

add in interface HasItems<HTMLOListElement,ProgressStepper,ProgressStep>

that

public ProgressStepper that()

Specified by:

that in interface TypedBuilder<HTMLOListElement,ProgressStepper>

first

public ProgressStepper first()

Selects the first step (index 0) if available. Does nothing if there are no steps or the first step is already current.

Returns:

this instance

first

public ProgressStepper first(Consumer<ProgressStep> actionForTheFirstStep,
 Consumer<ProgressStep> actionForThePreviousCurrentStep)

Selects the first step (index 0) if available. Previous current (if any) is cleared, then the first step is marked current. No change if empty or already at index 0.

Parameters:

actionForTheFirstStep - invoked with the first step after it becomes current

actionForThePreviousCurrentStep - invoked with the previous current step after it is cleared

Returns:

this instance

previous

public ProgressStepper previous()

Moves one step backward.

Transitions:

• size → size-1 (from overflow to last)
• i > 0 → i-1 (normal backward)
• 0 → -1 (underflow; no current)
• -1 → no change

Returns:

this instance

previous

public ProgressStepper previous(BiConsumer<Optional<ProgressStep>,Integer> actionForTheNewCurrentStepWithIndex,
 Consumer<ProgressStep> actionForThePreviousCurrentStep)

Moves one step backward with callbacks. See previous() for state transitions.

Parameters:

actionForTheNewCurrentStepWithIndex - receives Optional(new step) and its index, or Optional.empty() on underflow

actionForThePreviousCurrentStep - receives the step that was current (if it existed) after clearing

Returns:

this instance

next

public ProgressStepper next()

Moves one step forward.

Transitions:

• -1 → 0 (from underflow to first)
• i < size - 1 → i + 1 (normal forward)
• size - 1 → size (overflow; no current)
• size → no change

Returns:

this instance

next

public ProgressStepper next(BiConsumer<Optional<ProgressStep>,Integer> actionForTheNewCurrentWithIndex,
 Consumer<ProgressStep> actionForThePreviousCurrent)

Moves one step forward with callbacks. See next() for state transitions.

Parameters:

actionForTheNewCurrentWithIndex - receives Optional(new step) and its index, or Optional.empty() on overflow

actionForThePreviousCurrent - receives the step that was current (if it existed) after clearing

Returns:

this instance

last

public ProgressStepper last()

Selects the last step (index size-1) if present. Does nothing if empty or already at last.

Returns:

this instance

last

public ProgressStepper last(Consumer<ProgressStep> actionForTheLastStep,
 Consumer<ProgressStep> actionForThePreviousCurrentStep)

Selects the last step (index size-1) if present. Previous current (if valid) is cleared, then the last step is marked current.

Parameters:

actionForTheLastStep - invoked with the last step after it becomes current

actionForThePreviousCurrentStep - invoked with the previous current step after it is cleared

Returns:

this instance

ariaLabel

public ProgressStepper ariaLabel(String label)

updateItems

public <T> void updateItems(Iterable<T> items,
 Function<T,ProgressStep> display)

iterator

public Iterator<ProgressStep> iterator()

Specified by:

iterator in interface Iterable<ProgressStep>

size

public int size()

Specified by:

size in interface HasItems<HTMLOListElement,ProgressStepper,ProgressStep>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLOListElement,ProgressStepper,ProgressStep>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLOListElement,ProgressStepper,ProgressStep>

item

public ProgressStep item(String identifier)

Specified by:

item in interface HasItems<HTMLOListElement,ProgressStepper,ProgressStep>

currentIndex

public int currentIndex()

Returns the index of the current progress step. The interval is [-1, size], where -1 implies no current step (before first) and size implies no current step (after last).

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLOListElement,ProgressStepper,ProgressStep>

setupSteps

public ProgressStepper setupSteps(BiConsumer<ProgressStep,Integer> stepConsumerWithIndex)

Applies the provided consumer to each step with its index in insertion order.

Parameters:

stepConsumerWithIndex - consumer receiving (step, index)

Returns:

this instance