org.dominokit.domino.ui.utils

Class Mask

java.lang.Object

org.dominokit.domino.ui.utils.Mask

public class Mask
extends Object

A utility that provides masking feature on input elements based on pattern and regex

For example:

     Mask.of(element)
             .pattern("dd/mm/yyyy hh:mm")
             .dataSlots("dmyh")
             .onPatternMatched(
                 value -> {
                   // value matched the pattern
                 })
             .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mask.MaskingBuilder A builder class for Mask

Method Summary

Modifier and Type	Method and Description
String	getPattern()
String	getValue()
static Mask.MaskingBuilder	of(elemental2.dom.HTMLInputElement element) Build mask for HTML input element
static Mask.MaskingBuilder	of(ValueBox<?,elemental2.dom.HTMLInputElement,?> valueBox) Build mask for ValueBox
void	onPatternNotMatched(Consumer<String> onPatternNotMatched)
void	setPattern(String pattern)
void	setRegex(String regex)

Methods inherited from class java.lang.Object

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

Method Detail

of

public static Mask.MaskingBuilder of(ValueBox<?,elemental2.dom.HTMLInputElement,?> valueBox)

Build mask for ValueBox

Parameters:

valueBox - ValueBox

Returns:

Mask.MaskingBuilder

of

public static Mask.MaskingBuilder of(elemental2.dom.HTMLInputElement element)

Build mask for HTML input element

Parameters:

element - HTMLInputElement

Returns:

Mask.MaskingBuilder

getValue

public String getValue()

Returns:

the element value

getPattern

public String getPattern()

Returns:

the pattern

setPattern

public void setPattern(String pattern)

Parameters:

pattern - the new pattern

setRegex

public void setRegex(String regex)

Parameters:

regex - the regex to check if the value matches the expected input

onPatternNotMatched

public void onPatternNotMatched(Consumer<String> onPatternNotMatched)

Parameters:

onPatternNotMatched - a consumer that will be called when the value is filled but it does not match the pattern