org.dominokit.domino.ui.stepper

Class Step

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,Step>

org.dominokit.domino.ui.stepper.Step

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,Step,Step>, HasChildren<Step>, HasValidation<Step>, HasWavesElement, IsCollapsible<Step>, IsReadOnly<Step>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Step
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Step>
implements HasValidation<Step>

A component that is a single step inside a Stepper

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

HasValidation.Validator

Field Summary

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
Step(String title)
Step(String title, String description)
Step(String title, String description, Stepper.StepState initialState)

Method Summary

Modifier and Type	Method and Description
Step	addStateChangeListener(Stepper.StepStateChangeListener listener)
Step	addValidator(HasValidation.Validator validator)
Step	appendChild(org.jboss.elemento.IsElement<?> element) this will append the element to the step content element
Step	appendChild(elemental2.dom.Node node) this will append the element to the step content element
Step	clearInvalid() This will clear the step error and change it back to the state it had before it was invalidation Removes all error messages and mark the component as valid
Step	complete() Mark the step as completed
static Step	create(String title)
static Step	create(String title, String description)
static Step	create(String title, String description, Stepper.StepState initialState)
Step	disable() This will put the step in Stepper.StepState.DISABLED
elemental2.dom.HTMLDivElement	element()
Step	enable() This will not make the step active but will enable the step so it is clickable and can be stepped into with the stepper and by default will put the step in the Stepper.StepState.INACTIVE
String	getDescription()
List<String>	getErrors()
int	getIndex()
Stepper.StepState	getInitialState()
Stepper.StepState	getState()
int	getStepNumber()
Stepper	getStepper()
List<Stepper.StepStateChangeListener>	getStepStateChangeListeners()
String	getTitle()
boolean	hasValidator(HasValidation.Validator validator)
Step	invalidate(List<String> errorMessages) this will be put the step in the Stepper.StepState.ERROR Mark the component as invalid with a list of error messages
Step	invalidate(String errorMessage) this will be put the step in the Stepper.StepState.ERROR Mark the component as invalid with the specified error message
boolean	isActive()
boolean	isFirstStep()
boolean	isLastStep()
Step	removeStateChangeListener(Stepper.StepStateChangeListener listener)
Step	removeValidator(HasValidation.Validator validator)
Step	setActive() This will put the step in Stepper.StepState.ACTIVE
Step	setDescription(String description)
Step	setDisabled() This will put the step in Stepper.StepState.DISABLED
Step	setEnabled(Stepper.StepState targetState) This will not make the step active unless specified,but will enable the step so it is clickable and can be stepped into with the stepper and will put the step in the provided state
void	setInitialState(Stepper.StepState initialState)
Step	setStepNumber(int stepNumber) Change the order of the step in the stepper
Step	setTitle(String title)
ValidationResult	validate() if the step is invalid it will be put in the Stepper.StepState.ERROR validate the component and fail-fast with first error
List<ValidationResult>	validateAll() if the step is invalid it will be put in the Stepper.StepState.ERROR Run all the validators and return all errors

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

Step

public Step(String title,
            String description,
            Stepper.StepState initialState)

Parameters:

title - String title of the step

description - String to describe the step that show up under the title

initialState - Stepper.StepState to be used by default as the step state

Step

public Step(String title,
            String description)

Parameters:

title - String title of the step

description - String to describe the step that show up under the title

Step

public Step(String title)

Parameters:

title - String title of the step

Method Detail

create

public static Step create(String title)

Parameters:

title - String title of the step

Returns:

new Step instance

create

public static Step create(String title,
                          String description)

Parameters:

title - String title of the step

description - String to describe the step that show up under the title

Returns:

new Step instance

create

public static Step create(String title,
                          String description,
                          Stepper.StepState initialState)

Parameters:

title - String title of the step

description - String to describe the step that show up under the title

initialState - Stepper.StepState to be used by default as the step state

Returns:

new Step instance

setTitle

public Step setTitle(String title)

Parameters:

title - String new title for the step

Returns:

same Step instance

getTitle

public String getTitle()

Returns:

String

setDescription

public Step setDescription(String description)

Parameters:

description - String new description

Returns:

same Step instance

getDescription

public String getDescription()

Returns:

String

appendChild

public Step appendChild(org.jboss.elemento.IsElement<?> element)

this will append the element to the step content element

Specified by:

appendChild in interface HasChildren<Step>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,Step>

Parameters:

element - IsElement to be appended to the component

Returns:

same component

appendChild

public Step appendChild(elemental2.dom.Node node)

this will append the element to the step content element

Specified by:

appendChild in interface HasChildren<Step>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,Step>

Parameters:

node - Node to be appended to the component

Returns:

same component

setStepNumber

public Step setStepNumber(int stepNumber)

Change the order of the step in the stepper

Parameters:

stepNumber - int

Returns:

same Step instance

getStepNumber

public int getStepNumber()

Returns:

int step number in the stepper

complete

public Step complete()

Mark the step as completed

Returns:

same Step instance

disable

public Step disable()

This will put the step in Stepper.StepState.DISABLED

Overrides:

disable in class BaseDominoElement<elemental2.dom.HTMLDivElement,Step>

enable

public Step enable()

This will not make the step active but will enable the step so it is clickable and can be stepped into with the stepper and by default will put the step in the Stepper.StepState.INACTIVE

Overrides:

enable in class BaseDominoElement<elemental2.dom.HTMLDivElement,Step>

setDisabled

public Step setDisabled()

This will put the step in Stepper.StepState.DISABLED

Returns:

the same Step instance

setActive

public Step setActive()

This will put the step in Stepper.StepState.ACTIVE

Returns:

the same Step instance

setEnabled

public Step setEnabled(Stepper.StepState targetState)

This will not make the step active unless specified,but will enable the step so it is clickable and can be stepped into with the stepper and will put the step in the provided state

Parameters:

targetState - Stepper.StepState

Returns:

the same Step instance

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,Step>

Returns:

the HTML element of type E which is the root element of the component

validate

public ValidationResult validate()

if the step is invalid it will be put in the Stepper.StepState.ERROR validate the component and fail-fast with first error

Specified by:

validate in interface HasValidation<Step>

Returns:

same implementing component

validateAll

public List<ValidationResult> validateAll()

if the step is invalid it will be put in the Stepper.StepState.ERROR Run all the validators and return all errors

Specified by:

validateAll in interface HasValidation<Step>

Returns:

All ValidationResults, default to a single validation result

addValidator

public Step addValidator(HasValidation.Validator validator)

Specified by:

addValidator in interface HasValidation<Step>

Parameters:

validator - HasValidation.Validator

Returns:

same implementing component

removeValidator

public Step removeValidator(HasValidation.Validator validator)

Specified by:

removeValidator in interface HasValidation<Step>

Parameters:

validator - HasValidation.Validator

Returns:

same implementing component

hasValidator

public boolean hasValidator(HasValidation.Validator validator)

Specified by:

hasValidator in interface HasValidation<Step>

Parameters:

validator - HasValidation.Validator

Returns:

same implementing component

invalidate

public Step invalidate(String errorMessage)

this will be put the step in the Stepper.StepState.ERROR Mark the component as invalid with the specified error message

Specified by:

invalidate in interface HasValidation<Step>

Parameters:

errorMessage - String

Returns:

same implementing component

invalidate

public Step invalidate(List<String> errorMessages)

this will be put the step in the Stepper.StepState.ERROR Mark the component as invalid with a list of error messages

Specified by:

invalidate in interface HasValidation<Step>

Parameters:

errorMessages - List of String error messages

Returns:

same implementing component

getErrors

public List<String> getErrors()

Specified by:

getErrors in interface HasValidation<Step>

Returns:

a List of String error messages

clearInvalid

public Step clearInvalid()

This will clear the step error and change it back to the state it had before it was invalidation Removes all error messages and mark the component as valid

Specified by:

clearInvalid in interface HasValidation<Step>

Returns:

same implementing component

getStepper

public Stepper getStepper()

Returns:

the Stepper this step belongs to

addStateChangeListener

public Step addStateChangeListener(Stepper.StepStateChangeListener listener)

Parameters:

listener - Stepper.StepStateChangeListener

Returns:

same Step instance

removeStateChangeListener

public Step removeStateChangeListener(Stepper.StepStateChangeListener listener)

Parameters:

listener - Stepper.StepStateChangeListener

Returns:

same Step instance

getStepStateChangeListeners

public List<Stepper.StepStateChangeListener> getStepStateChangeListeners()

Returns:

List of all Stepper.StepStateChangeListener added to this step

getIndex

public int getIndex()

Returns:

int index of the step within the stepper

isFirstStep

public boolean isFirstStep()

Returns:

boolean, true if the step index is 0

isLastStep

public boolean isLastStep()

Returns:

boolean, true if the step is last step in the stepper

getState

public Stepper.StepState getState()

Returns:

the current Stepper.StepState of the step

isActive

public boolean isActive()

Returns:

boolean, true if the step state is Stepper.StepState.ACTIVE

getInitialState

public Stepper.StepState getInitialState()

Returns:

the Stepper.StepState this step was initially constructed with

setInitialState

public void setInitialState(Stepper.StepState initialState)

Parameters:

initialState - Stepper.StepState to be used as default initial state for the step