Package org.neotropic.util.visual.wizard

Class Wizard.Step

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.orderedlayout.VerticalLayout

org.neotropic.util.visual.wizard.Wizard.Step

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.orderedlayout.FlexComponent<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.orderedlayout.ThemableLayout, Serializable

Direct Known Subclasses:

NewPhysicalConnectionWizard.GeneralInfoStep, NewPhysicalConnectionWizard.GeneralInfoStep, NewPhysicalConnectionWizard.SelectContainerEndpointsStep, NewPhysicalConnectionWizard.SelectContainerEndpointsStep, NewPhysicalConnectionWizard.SelectLinkEndpointsStep, NewPhysicalConnectionWizard.SelectLinkEndpointsStep, SDHContainerLinkWizard.ChooseContainerLinkResourcesStep, SDHContainerLinkWizard.ChooseRouteStep, SDHContainerLinkWizard.GeneralInfoStep, SDHTransportLinkWizard.GeneralInfoStep, SDHTransportLinkWizard.SelectLinkEndpointsStep, SDHTributaryLinkWizard.ChooseRouteStep, SDHTributaryLinkWizard.ChooseTributaryLinkResourcesStep, SDHTributaryLinkWizard.GeneralInfoStep, SDHTributaryLinkWizard.SelectLinkEndpointsStep, SDHTributaryLinkWizard.SelectServiceStep

Enclosing class:

Wizard

public abstract class Wizard.Step
extends com.vaadin.flow.component.orderedlayout.VerticalLayout

Interface implemented by all the steps in the wizard

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

com.vaadin.flow.component.orderedlayout.FlexComponent.Alignment, com.vaadin.flow.component.orderedlayout.FlexComponent.JustifyContentMode

Constructor Summary

Constructors

Constructor	Description
Step()

Method Summary

Modifier and Type	Method	Description
abstract Properties	getProperties()	Each step saves the information related to it (forms, tree selections, etc) in a Properties object.
abstract boolean	isFinal()	Indicates if the step is the last one
abstract Wizard.Step	next()	What to do next.

Methods inherited from class com.vaadin.flow.component.orderedlayout.VerticalLayout

addAndExpand, getAlignItems, getAlignSelf, getDefaultHorizontalComponentAlignment, getHorizontalComponentAlignment, setAlignItems, setAlignSelf, setDefaultHorizontalComponentAlignment, setHorizontalComponentAlignment, setPadding, setSpacing

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.ClickNotifier

addClickListener, addClickShortcut

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

addDetachListener

Methods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

expand, getFlexGrow, getJustifyContentMode, replace, setFlexGrow, setJustifyContentMode

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

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

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

getElement

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

isEnabled, setEnabled

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

getChildren, getComponentAt, getComponentCount, indexOf

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

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

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

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

Methods inherited from interface com.vaadin.flow.component.orderedlayout.ThemableLayout

getBoxSizing, getThemeList, isMargin, isPadding, isSpacing, setBoxSizing, setMargin

Constructor Detail

Step

public Step()

Method Detail

next

public abstract Wizard.Step next()
                          throws InvalidArgumentException

What to do next. This method also validates if the information requested in the step is correct. Should be called upon the user clicking on th "Next/Finish" button

Returns:

Null if it's the final step, or the next step otherwise

Throws:

InvalidArgumentException - If the information provided by the user in the current step in missing or inconsistent

isFinal

public abstract boolean isFinal()

Indicates if the step is the last one

Returns:

True if the step is the last one, false otherwise

getProperties

public abstract Properties getProperties()

Each step saves the information related to it (forms, tree selections, etc) in a Properties object. This method allows to retrieve it. Also, the last step of a wizard packs the information in the WizardEvent.TYPE_FINAL_STEP step

Returns:

A Properties instance with the information collected in that step or anything relevant to the WizardEventListener