| Package | Description |
|---|---|
| org.dominokit.domino.ui.stepper |
| Modifier and Type | Method and Description |
|---|---|
Step |
Step.addStateChangeListener(Stepper.StepStateChangeListener listener) |
Step |
Step.addValidator(HasValidation.Validator validator) |
Step |
Step.appendChild(org.jboss.elemento.IsElement<?> element)
this will append the element to the step content element
|
Step |
Step.appendChild(elemental2.dom.Node node)
this will append the element to the step content element
|
Step |
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 |
Step.complete()
Mark the step as completed
|
static Step |
Step.create(String title) |
static Step |
Step.create(String title,
String description) |
static Step |
Step.create(String title,
String description,
Stepper.StepState initialState) |
Step |
Step.disable()
This will put the step in
Stepper.StepState.DISABLED |
Step |
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 |
Step |
Stepper.getActiveStep() |
Step |
Stepper.getCurrentStep() |
Step |
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 |
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 |
Step |
Step.removeStateChangeListener(Stepper.StepStateChangeListener listener) |
Step |
Step.removeValidator(HasValidation.Validator validator) |
Step |
Step.setActive()
This will put the step in
Stepper.StepState.ACTIVE |
Step |
Step.setDescription(String description) |
Step |
Step.setDisabled()
This will put the step in
Stepper.StepState.DISABLED |
Step |
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
|
Step |
Step.setStepNumber(int stepNumber)
Change the order of the step in the stepper
|
Step |
Step.setTitle(String title) |
| Modifier and Type | Method and Description |
|---|---|
List<Step> |
Stepper.getSteps() |
| Modifier and Type | Method and Description |
|---|---|
Stepper |
Stepper.activateStep(Step stepToActivate) |
elemental2.dom.Node |
Stepper.StepNumberRenderer.activeElement(Step step,
Stepper.StepStateColors stepStateColors)
Renders the number for active steps
|
Stepper |
Stepper.appendChild(Step step) |
elemental2.dom.Node |
Stepper.StepNumberRenderer.completedElement(Step step,
Stepper.StepStateColors stepStateColors)
Renders the number for completed steps
|
elemental2.dom.Node |
Stepper.StepNumberRenderer.disabledElement(Step step,
Stepper.StepStateColors stepStateColors)
Renders the number for disabled steps
|
elemental2.dom.Node |
Stepper.StepNumberRenderer.errorElement(Step step,
Stepper.StepStateColors stepStateColors)
Renders the number for steps with errors
|
elemental2.dom.Node |
Stepper.StepNumberRenderer.inactiveElement(Step step,
Stepper.StepStateColors stepStateColors)
Renders the number for inactive steps
|
void |
Stepper.StepStateChangeListener.onStateChanged(Stepper.StepState oldState,
Step step,
Stepper stepper) |
elemental2.dom.Node |
Stepper.StepState.render(Step step,
Stepper.StepStateColors colors,
Stepper.StepNumberRenderer stepNumberRenderer)
This method will be called whenever the Step state is changed, the method will use the
Stepper.StepNumberRenderer to render the step number based on the new step state |
Copyright © 2019–2022 Dominokit. All rights reserved.