Package com.flowingcode.vaadin.addons.regex

Class RegularExpressionField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<CustomField<T>,T>

com.vaadin.flow.component.customfield.CustomField<RegularExpression>

com.flowingcode.vaadin.addons.regex.RegularExpressionField

All Implemented Interfaces:

AttachNotifier, BlurNotifier<CustomField<RegularExpression>>, DetachNotifier, Focusable<CustomField<RegularExpression>>, FocusNotifier<CustomField<RegularExpression>>, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<CustomField<RegularExpression>,RegularExpression>,RegularExpression>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<CustomField<RegularExpression>,RegularExpression>,RegularExpression>, HasTooltip, HasValidationProperties, InputField<AbstractField.ComponentValueChangeEvent<CustomField<RegularExpression>,RegularExpression>,RegularExpression>, Serializable

public class RegularExpressionField
extends CustomField<RegularExpression>

A component for creating and testing regular expressions in real-time.

Features:

• Dropdown selection of predefined pattern types: STARTS_WITH, ENDS_WITH, CONTAINS.
• An ADVANCED mode for custom regular expressions.
• Text input field for defining the pattern.
• Real-time validation of words in the list when in advanced mode.

Author:

Javier Godoy

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

AbstractField.ComponentValueChangeEvent<C extends Component,V extends Object>

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

BlurNotifier.BlurEvent<C extends Component>

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

FocusNotifier.FocusEvent<C extends Component>

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

HasValue.ValueChangeEvent<V extends Object>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
RegularExpressionField()	Creates a new instance of RegularExpressionField.

Method Summary

Modifier and Type	Method	Description
protected RegularExpression	generateModelValue()
boolean	isInvalid()
boolean	isTestFieldEnabled()	Checks whether the test field is enabled.
void	setOperator(RegularExpressionOperator operator)	Sets the regular expression operator for this component.
protected void	setPresentationValue(RegularExpression newPresentationValue)
void	setTestFieldEnabled(boolean enabled)	Enables or disables the test field based on the given flag.
void	setTestStrings(String... strings)	Sets the test strings for validation using a variable-length argument array.
void	setTestStrings(Collection<String> strings)	Sets the test strings for validation using a collection.

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, onAttach, remove, removeThemeVariants, setLabel, updateValue

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

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, 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.BlurNotifier

addBlurListener

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

addDetachListener

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

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

addFocusListener

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.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, 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.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

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

setManualValidation

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, setErrorMessage, setInvalid

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

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

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Constructor Details

RegularExpressionField

public RegularExpressionField()

Creates a new instance of RegularExpressionField.

Method Details

generateModelValue

protected RegularExpression generateModelValue()

Specified by:

generateModelValue in class CustomField<RegularExpression>

setPresentationValue

protected void setPresentationValue(RegularExpression newPresentationValue)

Specified by:

setPresentationValue in class CustomField<RegularExpression>

isInvalid

public boolean isInvalid()

setTestFieldEnabled

public void setTestFieldEnabled(boolean enabled)

Enables or disables the test field based on the given flag.

If enabled, the test field is visible only when the selected operator is RegularExpressionOperator.ADVANCED.

Parameters:

enabled - true to enable the test field, false to disable it

isTestFieldEnabled

public boolean isTestFieldEnabled()

Checks whether the test field is enabled.

Returns:

true if the test field is enabled, otherwise false

setOperator

public void setOperator(RegularExpressionOperator operator)

Sets the regular expression operator for this component.

Parameters:

operator - the RegularExpressionOperator to set

setTestStrings

public void setTestStrings(String... strings)

Sets the test strings for validation using a variable-length argument array. The provided strings will be set as selectable test cases in the test field.

Parameters:

strings - the test strings to set

setTestStrings

public void setTestStrings(Collection<String> strings)

Sets the test strings for validation using a collection. The provided strings will be set as selectable test cases in the test field.

Parameters:

strings - the collection of test strings to set