Package com.storedobject.ui.util

Class Stepper

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.littemplate.LitTemplate

com.storedobject.helper.LitComponent

com.storedobject.ui.util.Stepper

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.internal.Template, Serializable

@Tag("so-stepper")
@JsModule("./so/stepper/so-stepper.js")
public class Stepper
extends LitComponent
implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stepper.Step	Container class containing the header and content component of a step also handles firing step events.

Constructor Summary

Constructors

Constructor	Description
Stepper()

Method Summary

Modifier and Type	Method	Description
void	addExtraButton(Button button)
void	addStep(Stepper.Step step)	Adds the given step to the stepper.
boolean	finish()
int	goToStep(int step)
void	hideBackButton()
void	hideCancelButton()
void	hideFinishButton()
void	hideNextButton()
boolean	initUI()
boolean	isFinalStep()
boolean	isFirstStep()
boolean	nextStep()
boolean	previousStep()
void	setBackLabel(String label)
void	setCancelLabel(String label)
void	setCancelledAction(Consumer<Stepper> cancelledAction)
void	setCompletedAction(Consumer<Stepper> completedAction)
void	setFinishLabel(String label)
void	setNextLabel(String label)
void	unhideBackButton()
void	unhideCancelButton()
void	unhideFinishButton()
void	unhideNextButton()

Methods inherited from class com.storedobject.helper.LitComponent

executeJS, onDetach

Methods inherited from class com.vaadin.flow.component.littemplate.LitTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

Stepper

public Stepper()

Method Details

goToStep

public int goToStep(int step)

nextStep

public boolean nextStep()

previousStep

public boolean previousStep()

finish

public boolean finish()

isFirstStep

public boolean isFirstStep()

isFinalStep

public boolean isFinalStep()

addStep

public void addStep(Stepper.Step step)
             throws IllegalArgumentException

Adds the given step to the stepper.

Parameters:

step - the step to add to the stepper. Each step consists of a header and a content component.

Throws:

IllegalArgumentException

initUI

public boolean initUI()

setCancelledAction

public void setCancelledAction(Consumer<Stepper> cancelledAction)

addExtraButton

public void addExtraButton(Button button)

setCancelLabel

public void setCancelLabel(String label)

setBackLabel

public void setBackLabel(String label)

setFinishLabel

public void setFinishLabel(String label)

setNextLabel

public void setNextLabel(String label)

setCompletedAction

public void setCompletedAction(Consumer<Stepper> completedAction)

hideBackButton

public void hideBackButton()

hideNextButton

public void hideNextButton()

hideFinishButton

public void hideFinishButton()

hideCancelButton

public void hideCancelButton()

unhideBackButton

public void unhideBackButton()

unhideNextButton

public void unhideNextButton()

unhideFinishButton

public void unhideFinishButton()

unhideCancelButton

public void unhideCancelButton()