Package org.patternfly.component.wizard

Class Wizard

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement,Wizard>

org.patternfly.component.wizard.Wizard

All Implemented Interfaces:

Iterable<WizardStep>, ElementAttributeMethods<HTMLElement,Wizard>, ElementClassListMethods<HTMLElement,Wizard>, ElementConsumerMethods<HTMLElement,Wizard>, ElementContainerMethods<HTMLElement,Wizard>, ElementEventMethods<HTMLElement,Wizard>, ElementIdMethods<HTMLElement,Wizard>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement,Wizard>, HTMLElementDataMethods<HTMLElement,Wizard>, HTMLElementStyleMethods<HTMLElement,Wizard>, HTMLElementVisibilityMethods<HTMLElement,Wizard>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Wizard>, Closeable<HTMLElement,Wizard>, Component, HasItems<HTMLElement,Wizard,WizardStep>

public class Wizard
extends BaseComponent<HTMLElement,Wizard>
implements Closeable<HTMLElement,Wizard>, HasItems<HTMLElement,Wizard,WizardStep>

A wizard provides a guided workflow that offers a path to complete a task, create an object or objects, or finish a series of steps for some other outcome. Wizards should incite trust in the user and guide them through an otherwise overwhelming experience.

See Also:

• https://www.patternfly.org/components/wizard

Method Summary

Modifier and Type	Method	Description
Wizard	add(WizardHeader header)
Wizard	add(WizardStep item)
Wizard	addHeader(WizardHeader header)
void	cancel()
void	clear()
void	close(Event event, boolean fireEvent)
boolean	contains(String identifier)
WizardContext	context()
WizardStep	currentStep()
WizardStep	firstStep()
WizardFooter	footer()
WizardHeader	header()
Wizard	height(int height)
boolean	isEmpty()
WizardStep	item(String identifier)
Iterator<WizardStep>	iterator()
WizardStep	lastStep()
WizardNav	nav()
void	next()
Wizard	onAdd(BiConsumer<Wizard,WizardStep> onAdd)
Wizard	onClose(CloseHandler<Wizard> closeHandler)
Wizard	onRemove(BiConsumer<Wizard,WizardStep> onRemove)
Wizard	onStepChange(WizardStepChangeHandler stepChangeHandler)
void	previous()
Wizard	progressive()	Same as progressive(true)
Wizard	progressive(boolean progressive)	Progressively shows steps, where all steps following the active step are hidden.
void	removeItem(String identifier)
void	select(String identifier)
void	select(WizardStep step)
int	size()
Wizard	that()
Wizard	visitRequired()	Same as visitRequired(true)
Wizard	visitRequired(boolean visitRequired)	Disables steps that haven't been visited.
static Wizard	wizard()

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element, registerComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.patternfly.component.Closeable

close, close

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

Method Details

wizard

public static Wizard wizard()

add

public Wizard add(WizardStep item)

Specified by:

add in interface HasItems<HTMLElement,Wizard,WizardStep>

addHeader

public Wizard addHeader(WizardHeader header)

add

public Wizard add(WizardHeader header)

height

public Wizard height(int height)

progressive

public Wizard progressive()

Same as progressive(true)

progressive

public Wizard progressive(boolean progressive)

Progressively shows steps, where all steps following the active step are hidden. Defaults to false. Must be called before adding steps.

visitRequired

public Wizard visitRequired()

Same as visitRequired(true)

visitRequired

public Wizard visitRequired(boolean visitRequired)

Disables steps that haven't been visited. Defaults to false. Must be called before adding steps.

that

public Wizard that()

Specified by:

that in interface TypedBuilder<HTMLElement,Wizard>

onAdd

public Wizard onAdd(BiConsumer<Wizard,WizardStep> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement,Wizard,WizardStep>

onClose

public Wizard onClose(CloseHandler<Wizard> closeHandler)

Specified by:

onClose in interface Closeable<HTMLElement,Wizard>

onRemove

public Wizard onRemove(BiConsumer<Wizard,WizardStep> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement,Wizard,WizardStep>

onStepChange

public Wizard onStepChange(WizardStepChangeHandler stepChangeHandler)

close

public void close(Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<HTMLElement,Wizard>

iterator

public Iterator<WizardStep> iterator()

Specified by:

iterator in interface Iterable<WizardStep>

size

public int size()

Specified by:

size in interface HasItems<HTMLElement,Wizard,WizardStep>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement,Wizard,WizardStep>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement,Wizard,WizardStep>

item

public WizardStep item(String identifier)

Specified by:

item in interface HasItems<HTMLElement,Wizard,WizardStep>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement,Wizard,WizardStep>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement,Wizard,WizardStep>

context

public WizardContext context()

header

public WizardHeader header()

nav

public WizardNav nav()

footer

public WizardFooter footer()

firstStep

public WizardStep firstStep()

lastStep

public WizardStep lastStep()

currentStep

public WizardStep currentStep()

previous

public void previous()

next

public void next()

select

public void select(String identifier)

select

public void select(WizardStep step)

cancel

public void cancel()