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>, org.patternfly.core.OuiaSupport<HTMLElement, Wizard>, org.patternfly.style.Modifiers.Plain<HTMLElement, Wizard>
public class Wizard extends BaseComponent<HTMLElement, Wizard> implements HasItems<HTMLElement, Wizard, WizardStep>, org.patternfly.style.Modifiers.Plain<HTMLElement, Wizard>
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:

  • 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(org.patternfly.handler.ComponentHandler<Wizard> handler)

    • onFinish

      public Wizard onFinish(org.patternfly.handler.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()

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