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>, Component, HasItems<HTMLElement, Wizard, WizardStep>

public class Wizard
extends BaseComponent<HTMLElement, Wizard>
implements 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)	Adds an item to the component.
Wizard	addHeader(WizardHeader header)
void	cancel()
void	clear()	Clears all items from the component.
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given identifier.
WizardContext	context()
WizardStep	currentStep()
WizardStep	firstStep()
WizardFooter	footer()
WizardHeader	header()
Wizard	height(int height)
boolean	isEmpty()	Checks whether the collection of items in the component is empty.
WizardStep	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<WizardStep>	iterator()
WizardStep	lastStep()
WizardNav	nav()
void	next()
Wizard	onAdd(AddItemHandler<Wizard, WizardStep> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
Wizard	onCancel(ComponentHandler<Wizard> handler)
Wizard	onFinish(ComponentHandler<Wizard> handler)
Wizard	onRemove(RemoveItemHandler<Wizard, WizardStep> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
Wizard	onStepChange(WizardStepChangeHandler stepChangeHandler)
Wizard	onUpdate(UpdateItemHandler<Wizard, WizardStep> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
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)	Removes an item from the component based on the provided identifier.
void	select(String identifier)
void	select(WizardStep step)
int	size()	Retrieves the total number of items currently contained in the component.
Wizard	that()
void	updateItem(WizardStep item)	Updates an existing item in the component.
Wizard	visitRequired()	Same as visitRequired(true)
Wizard	visitRequired(boolean visitRequired)	Disables steps that haven't been visited.
static Wizard	wizard()

Methods inherited from class BaseComponent

componentType, element, registerComponent

Methods inherited from class Object

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

Methods inherited from interface ElementAttributeMethods

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

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerMethods

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

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface HasItems

addItem, addItems, items, replaceItemElement, updateItem, updateItem

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface Iterable

forEach, spliterator

Method Details

wizard

public static Wizard wizard()

add

public Wizard add(WizardStep item)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

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(AddItemHandler<Wizard, WizardStep> onAdd)

Description copied from interface: HasItems

Registers a callback to be invoked whenever a new item is added to the component.

Specified by:

onAdd in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

onAdd - a AddItemHandler that takes the builder instance and the item being added as arguments

Returns:

the builder instance after adding the callback

onCancel

public Wizard onCancel(ComponentHandler<Wizard> handler)

onFinish

public Wizard onFinish(ComponentHandler<Wizard> handler)

onUpdate

public Wizard onUpdate(UpdateItemHandler<Wizard, WizardStep> onUpdate)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is updated in the component.

Specified by:

onUpdate in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

onUpdate - a UpdateItemHandler that takes the component, the previous state of the item, and the updated state of the item as arguments

Returns:

the builder instance after adding the callback

onRemove

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

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is removed from the component.

Specified by:

onRemove in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

onRemove - a RemoveItemHandler that takes the component and the item being removed as arguments

Returns:

the builder instance after adding the callback

onStepChange

public Wizard onStepChange(WizardStepChangeHandler stepChangeHandler)

iterator

public Iterator<WizardStep> iterator()

Specified by:

iterator in interface Iterable<WizardStep>

size

public int size()

Description copied from interface: HasItems

Retrieves the total number of items currently contained in the component.

Specified by:

size in interface HasItems<HTMLElement, Wizard, WizardStep>

Returns:

the number of items contained in the component

isEmpty

public boolean isEmpty()

Description copied from interface: HasItems

Checks whether the collection of items in the component is empty.

Specified by:

isEmpty in interface HasItems<HTMLElement, Wizard, WizardStep>

Returns:

true if the component contains no items; false otherwise

contains

public boolean contains(String identifier)

Description copied from interface: HasItems

Checks whether the component contains an item associated with the given identifier.

Specified by:

contains in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

identifier - the identifier of the item to be checked

Returns:

true if the component contains an item associated with the provided identifier, false otherwise

item

public WizardStep item(String identifier)

Description copied from interface: HasItems

Retrieves the item associated with the specified identifier from the component.

Specified by:

item in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

identifier - the identifier of the item to be retrieved

Returns:

the item associated with the given identifier, or null if no item is found

updateItem

public void updateItem(WizardStep item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

item - the item to be updated

removeItem

public void removeItem(String identifier)

Description copied from interface: HasItems

Removes an item from the component based on the provided identifier.

Specified by:

removeItem in interface HasItems<HTMLElement, Wizard, WizardStep>

Parameters:

identifier - the identifier of the item to be removed

clear

public void clear()

Description copied from interface: HasItems

Clears all items from the component. This method removes any existing items within the component, leaving it empty. Any associated or registered callbacks related to the removal of items may be invoked as part of this operation.

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()