Class WizardStep

java.lang.Object
org.patternfly.component.SubComponent<HTMLElement, WizardStep>
org.patternfly.component.wizard.WizardStep
All Implemented Interfaces:
ElementAttributeMethods<HTMLElement, WizardStep>, ElementClassListMethods<HTMLElement, WizardStep>, ElementConsumerMethods<HTMLElement, WizardStep>, ElementContainerDelegate<HTMLElement, WizardStep>, ElementContainerMethods<HTMLElement, WizardStep>, ElementEventMethods<HTMLElement, WizardStep>, ElementIdMethods<HTMLElement, WizardStep>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, WizardStep>, HTMLElementDataMethods<HTMLElement, WizardStep>, HTMLElementStyleMethods<HTMLElement, WizardStep>, HTMLElementVisibilityMethods<HTMLElement, WizardStep>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, WizardStep>, HasIdentifier<HTMLElement, WizardStep>, ComponentContext<HTMLElement, WizardStep>, Modifiers.Disabled<HTMLElement, WizardStep>
public class WizardStep extends SubComponent<HTMLElement, WizardStep> implements ComponentContext<HTMLElement, WizardStep>, Modifiers.Disabled<HTMLElement, WizardStep>, ElementContainerDelegate<HTMLElement, WizardStep>, HasIdentifier<HTMLElement, WizardStep>

  • Field Details

  • Method Details

    • wizardStep

      public static WizardStep wizardStep(String identifier, String title)

    • wizardStep

      public static WizardStep wizardStep(String identifier, String title, WizardStepType type)

    • containerDelegate

      public Element containerDelegate()
      Specified by:
      containerDelegate in interface ElementContainerDelegate<HTMLElement, WizardStep>

    • disabled

      public WizardStep disabled(boolean disabled)
      Description copied from interface: Modifiers.Disabled
      Adds/removes modifier(disabled)
      Specified by:
      disabled in interface Modifiers.Disabled<HTMLElement, WizardStep>

    • store

      public <T> WizardStep store(String key, T value)
      Description copied from interface: ComponentContext
      Stores a value associated with a key.
      Specified by:
      store in interface ComponentContext<HTMLElement, WizardStep>
      Type Parameters:
      T - the type of the value being stored
      Parameters:
      key - the key associated with the value
      value - the value to be stored

    • that

      public WizardStep that()
      Specified by:
      that in interface TypedBuilder<HTMLElement, WizardStep>

    • previousIf

      public WizardStep previousIf(WizardStepPreviousHandler handler)
      Assigns a callback to be executed when navigating to the previous step in a wizard workflow. This method allows for defining custom behavior when the user attempts to transition to a previous step.

      If a previous promise is already set, the existing promise will be cleared, and the new callback will overwrite it.

      Parameters:
      handler - the callback to be invoked during the transition to a previous step
      Returns:
      the current instance of WizardStep, enabling method chaining

    • previousIfPromised

      public WizardStep previousIfPromised(WizardStepPreviousPromise promise)
      Associates a promise to handle the transition when navigating to the previous step in a wizard workflow. This method enables defining custom asynchronous behavior for the step transition.

      If a previous callback is already set, the existing callback will be cleared, and the new promise will overwrite it.

      Parameters:
      promise - the WizardPreviousPromise to be executed during the transition to a previous step
      Returns:
      the current WizardStep instance, allowing method chaining

    • nextIf

      public WizardStep nextIf(WizardStepNextHandler handler)
      Configures a callback to handle the transition to the next step in a wizard workflow. This method enables defining custom behavior that should occur when attempting to navigate from the current step to the next step.

      If a next promise is already set, it will be cleared, and the new callback will overwrite the existing configuration.

      Parameters:
      handler - the callback to be executed during the transition to the next step
      Returns:
      the current instance of WizardStep to allow method chaining

    • nextIfPromised

      public WizardStep nextIfPromised(WizardStepNextPromise promise)
      Associates a promise to handle the transition when navigating to the next step in a wizard workflow. This method allows for defining custom asynchronous behavior that should occur during the transition.

      If a next callback is already set, the existing callback will be cleared, and the new promise will overwrite it.

      Parameters:
      promise - the WizardNextPromise to be executed during the transition to the next step
      Returns:
      the current WizardStep instance, allowing method chaining

    • onEnter

      public WizardStep onEnter(WizardStepEnterHandler handler)

    • onLeave

      public WizardStep onLeave(WizardStepLeaveHandler handler)

    • identifier

      public String identifier()
      Specified by:
      identifier in interface HasIdentifier<HTMLElement, WizardStep>

    • has

      public boolean has(String key)
      Description copied from interface: ComponentContext
      Determines whether a value is stored with the specified key.
      Specified by:
      has in interface ComponentContext<HTMLElement, WizardStep>
      Parameters:
      key - the key to check
      Returns:
      true if a value is stored with the specified key, false otherwise

    • get

      public <T> T get(String key)
      Description copied from interface: ComponentContext
      Retrieves the value associated with the given key from the ComponentContext.
      Specified by:
      get in interface ComponentContext<HTMLElement, WizardStep>
      Type Parameters:
      T - the type of the value being retrieved
      Parameters:
      key - the key associated with the value
      Returns:
      the value associated with the key, or null if no value is found

    • next

      public WizardStep next()

    • previous

      public WizardStep previous()

    • status

      public ValidationStatus status()

    • status

      public void status(ValidationStatus status)

    • clearStatus

      public void clearStatus()

    • isDisabled

      public boolean isDisabled()
      Specified by:
      isDisabled in interface Modifiers.Disabled<HTMLElement, WizardStep>

    • visited

      public boolean visited()