org.dominokit.domino.ui.stepper

Class Stepper

java.lang.Object

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

org.dominokit.domino.ui.stepper.Stepper

All Implemented Interfaces:

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

public class Stepper
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Stepper>

A Wizard like component that can have multiple Steps while only one step can be activated at a time

See Also:

Steppers sample

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Stepper.StepNumberRenderer An interface to provide a different implementation for rendering steps numbers
static interface	Stepper.StepperCompleteListener A function to implement logic that will be called when a step is marked as completed
static class	Stepper.StepperDirection An enum of possible Stepper directions
static class	Stepper.StepState An enum to list the Step possible states
static interface	Stepper.StepStateChangeListener A function to implement listeners to be called whenever the step state is changed
static interface	Stepper.StepStateColors An interface that can implemented to provide different colors for different Step states other than the default colors

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

Field Summary

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

element

Constructor Summary

Constructors

Constructor and Description
Stepper()

Method Summary

Modifier and Type	Method and Description
Stepper	activateStep(int index)
Stepper	activateStep(Step stepToActivate)
Stepper	addCompleteListener(Stepper.StepperCompleteListener listener)
Stepper	addStateChangeListener(Stepper.StepStateChangeListener listener) Adds a listener that listen to state changes of Stepper steps
Stepper	appendChild(Step step)
Stepper	complete() Marks the Stepper as completed and call the stepper complete handlers
Stepper	complete(org.jboss.elemento.IsElement<?> completeContent) Marks the Stepper as completed and call the stepper complete handlers
Stepper	complete(elemental2.dom.Node completeContent) Marks the Stepper as completed and call the stepper complete handlers
Stepper	completeActiveStep() Complete the current active step, if there is more steps this will also move the stepper to the next enabled non-completed step
static Stepper	create()
elemental2.dom.HTMLDivElement	element()
Transition	getActivateStepTransition()
int	getActivateStepTransitionDuration()
Step	getActiveStep()
List<Stepper.StepperCompleteListener>	getCompleteListeners()
Step	getCurrentStep()
Transition	getDeactivateStepTransition()
int	getDeactivateStepTransitionDuration()
FlexItem	getStepContentFlexItem()
Stepper.StepNumberRenderer	getStepNumberRenderer()
List<Step>	getSteps()
List<Stepper.StepStateChangeListener>	getStepStateChangeListeners()
Stepper.StepStateColors	getStepStateColors()
Stepper	next() Move the stepper to the next enabled non-completed step
Stepper	previous() Move the stepper back tp the previous step that is not disabled
Stepper	removeCompleteListener(Stepper.StepperCompleteListener listener)
Stepper	removeStateChangeListener(Stepper.StepStateChangeListener listener)
Stepper	reset() Activates he first step and reset all steps to the initial state
Stepper	setActivateStepTransition(Transition activateStepTransition)
Stepper	setActivateStepTransitionDuration(int activateStepTransitionDuration)
Stepper	setBarColor(Color color)
Stepper	setDeactivateStepTransition(Transition deactivateStepTransition)
Stepper	setDeactivateStepTransitionDuration(int deactivateStepTransitionDuration)
Stepper	setDirection(Stepper.StepperDirection direction)
Stepper	setStepFooter(org.jboss.elemento.IsElement<?> footerElement)
Stepper	setStepFooter(elemental2.dom.Node footerElement)
Stepper	setStepNumberRenderer(Stepper.StepNumberRenderer stepNumberRenderer)
Stepper	setStepStateColors(Stepper.StepStateColors stepStateColors)

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, 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

Stepper

public Stepper()

Method Detail

create

public static Stepper create()

setStepNumberRenderer

public Stepper setStepNumberRenderer(Stepper.StepNumberRenderer stepNumberRenderer)

Parameters:

stepNumberRenderer - Stepper.StepNumberRenderer to override the default one

Returns:

same Stepper instance

setStepStateColors

public Stepper setStepStateColors(Stepper.StepStateColors stepStateColors)

Parameters:

stepStateColors - Stepper.StepStateColors to override the default one

Returns:

same Stepper instance

setStepFooter

public Stepper setStepFooter(org.jboss.elemento.IsElement<?> footerElement)

Parameters:

footerElement - IsElement that will be used a footer for all steps

Returns:

same Stepper instance

setStepFooter

public Stepper setStepFooter(elemental2.dom.Node footerElement)

Parameters:

footerElement - Node that will be used a footer for all steps

Returns:

same Stepper instance

complete

public Stepper complete()

Marks the Stepper as completed and call the stepper complete handlers

Returns:

same Stepper instance

complete

public Stepper complete(org.jboss.elemento.IsElement<?> completeContent)

Marks the Stepper as completed and call the stepper complete handlers

Parameters:

completeContent - IsElement to show up in the stepper as a completed indicator of to finalize the stepper process

Returns:

same Stepper instance

complete

public Stepper complete(elemental2.dom.Node completeContent)

Marks the Stepper as completed and call the stepper complete handlers

Parameters:

completeContent - Node to show up in the stepper as a completed indicator of to finalize the stepper process

Returns:

same Stepper instance

getCurrentStep

public Step getCurrentStep()

Returns:

the current active Step

completeActiveStep

public Stepper completeActiveStep()

Complete the current active step, if there is more steps this will also move the stepper to the next enabled non-completed step

Returns:

same Stepper instance

appendChild

public Stepper appendChild(Step step)

Parameters:

step - Step to be added to this Stepper instance

Returns:

same Stepper instance

setDirection

public Stepper setDirection(Stepper.StepperDirection direction)

Parameters:

direction - Stepper.StepperDirection

Returns:

same Stepper instance

next

public Stepper next()

Move the stepper to the next enabled non-completed step

Returns:

same Stepper instance

activateStep

public Stepper activateStep(Step stepToActivate)

Parameters:

stepToActivate - Step to be activated, the step should not disabled

Returns:

same Stepper instance

activateStep

public Stepper activateStep(int index)

Parameters:

index - int index of the step to be activated, the step should not disabled

Returns:

same Stepper instance

previous

public Stepper previous()

Move the stepper back tp the previous step that is not disabled

Returns:

same Stepper instance

setBarColor

public Stepper setBarColor(Color color)

Parameters:

color - Color the color of the bar connecting a step with the next step

Returns:

same Stepper instance

addStateChangeListener

public Stepper addStateChangeListener(Stepper.StepStateChangeListener listener)

Adds a listener that listen to state changes of Stepper steps

Parameters:

listener - Stepper.StepStateChangeListener

Returns:

same Stepper instance

removeStateChangeListener

public Stepper removeStateChangeListener(Stepper.StepStateChangeListener listener)

Parameters:

listener - Stepper.StepStateChangeListener

Returns:

same Stepper instance

getStepStateChangeListeners

public List<Stepper.StepStateChangeListener> getStepStateChangeListeners()

Returns:

List of all Stepper.StepStateChangeListeners of this Stepper

addCompleteListener

public Stepper addCompleteListener(Stepper.StepperCompleteListener listener)

Parameters:

listener - Stepper.StepperCompleteListener

Returns:

same Stepper instance

removeCompleteListener

public Stepper removeCompleteListener(Stepper.StepperCompleteListener listener)

Parameters:

listener - Stepper.StepperCompleteListener

Returns:

same Stepper instance

getCompleteListeners

public List<Stepper.StepperCompleteListener> getCompleteListeners()

Returns:

a List of Stepper.StepperCompleteListeners

getActivateStepTransition

public Transition getActivateStepTransition()

Returns:

the animation Transition currently used for activating a step

setActivateStepTransition

public Stepper setActivateStepTransition(Transition activateStepTransition)

Parameters:

activateStepTransition - Transition for the animation of activating a step

Returns:

same Stepper instance

getDeactivateStepTransition

public Transition getDeactivateStepTransition()

Returns:

the animation Transition currently used for deactivating a step

setDeactivateStepTransition

public Stepper setDeactivateStepTransition(Transition deactivateStepTransition)

Parameters:

deactivateStepTransition - Transition for the animation of deactivating a step

Returns:

same Stepper instance

getActivateStepTransitionDuration

public int getActivateStepTransitionDuration()

Returns:

int duration in milli-seconds for activating a step animation

setActivateStepTransitionDuration

public Stepper setActivateStepTransitionDuration(int activateStepTransitionDuration)

Parameters:

activateStepTransitionDuration - int duration in milli-seconds for activating a step animation

Returns:

same Stepper instance

getDeactivateStepTransitionDuration

public int getDeactivateStepTransitionDuration()

Returns:

int duration in milli-seconds for deactivating a step animation

setDeactivateStepTransitionDuration

public Stepper setDeactivateStepTransitionDuration(int deactivateStepTransitionDuration)

Parameters:

deactivateStepTransitionDuration - int duration in milli-seconds for deactivating a step animation

Returns:

same Stepper 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,Stepper>

Returns:

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

getSteps

public List<Step> getSteps()

Returns:

List of all Steps

getStepContentFlexItem

public FlexItem getStepContentFlexItem()

Returns:

the FlexItem that wraps the active step content

getStepStateColors

public Stepper.StepStateColors getStepStateColors()

Returns:

the Stepper.StepStateColors

getStepNumberRenderer

public Stepper.StepNumberRenderer getStepNumberRenderer()

Returns:

the Stepper.StepNumberRenderer

getActiveStep

public Step getActiveStep()

Returns:

the current active Step

reset

public Stepper reset()

Activates he first step and reset all steps to the initial state

Returns: