Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addCompleteListener(ComponentEventListener<OtpCompleteEvent>) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Adds a listener that is notified when the entered code becomes complete.
- ALPHANUMERIC - Static variable in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
The allowed character pattern that accepts digits and Latin letters in either case.
C
- clear() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Empties the field and returns the caret to the first slot.
- com.flowingcode.vaadin.addons.otpfield - package com.flowingcode.vaadin.addons.otpfield
D
- DEFAULT_LENGTH - Static variable in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
The default number of slots, the dominant convention for TOTP and SMS codes.
- DEFAULT_MASK_GLYPH - Static variable in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
The default mask glyph, a bullet.
E
- Example - Search tag in class com.flowingcode.vaadin.addons.otpfield.OtpField
- Section
G
- getAriaLabel() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- getAriaLabelledBy() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- getCaseConversion() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets the case conversion applied to the value.
- getDefaultValidator() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- getEmptyValue() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- getI18n() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets the internationalization object of this field.
- getIncompleteErrorMessage() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
-
Gets the error message displayed when the code is non-empty but shorter than the length of the field.
- getInputMode() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets the
inputmodeof the field. - getInvalidErrorMessage() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
-
Gets the error message displayed when the code is longer than the length of the field, or contains characters the field does not accept.
- getLength() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets the number of slots.
- getMaskGlyph() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets the glyph rendered in filled slots while the field is masked.
- getRequiredErrorMessage() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
-
Gets the error message displayed when the field is required but empty.
- getValue() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Returns the code entered so far, which may be shorter than
OtpField.getLength(). - getValueChangeMode() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- getValueChangeTimeout() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
I
- isAutofocus() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets whether the field automatically receives focus when the page loads.
- isMasked() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Gets whether the entered characters are hidden behind a mask glyph.
L
- LOWERCASE - Enum constant in enum class com.flowingcode.vaadin.addons.otpfield.OtpCaseConversion
-
The value is converted to lower case.
M
- MAX_LENGTH - Static variable in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
The largest supported number of slots.
- MIN_LENGTH - Static variable in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
The smallest supported number of slots.
N
- NONE - Enum constant in enum class com.flowingcode.vaadin.addons.otpfield.OtpCaseConversion
-
The value is used as entered.
- NUMERIC - Static variable in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
The allowed character pattern that accepts digits only: the default, and the convention for TOTP and SMS codes.
O
- OtpCaseConversion - Enum Class in com.flowingcode.vaadin.addons.otpfield
-
The case conversion applied by an
OtpFieldto typed, pasted and programmatically set values, so that the server-side value and the displayed code always agree. - OtpCompleteEvent - Class in com.flowingcode.vaadin.addons.otpfield
-
Fired when the code entered in an
OtpFieldbecomes complete, that is, when its length reachesOtpField.getLength(). - OtpCompleteEvent(OtpField, boolean, String) - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpCompleteEvent
-
Creates a new complete event.
- OtpField - Class in com.flowingcode.vaadin.addons.otpfield
-
A field for entering a short verification code: a one-time password, a 2FA or SMS code, an e-mail confirmation code or a banking token.
- OtpField() - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Constructs an empty field with the default length of 6 and the
OtpField.NUMERICallowed character pattern. - OtpField(int) - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Constructs an empty field with the given length.
- OtpField(String) - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Constructs an empty field with the given label.
- OtpField(String, int) - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Constructs an empty field with the given label and length.
- OtpField(String, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<OtpField, String>>) - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Constructs an empty field with the given label and a value change listener.
- OtpFieldI18n - Class in com.flowingcode.vaadin.addons.otpfield
-
The internationalization properties of an
OtpField: the error messages of its three built-in constraints. - OtpFieldI18n() - Constructor for class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
S
- setAllowedCharPattern(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the characters the field accepts, as a single-character regular expression.
- setAriaLabel(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- setAriaLabelledBy(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- setAutofocus(boolean) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets whether the field should automatically receive focus when the page loads.
- setCaseConversion(OtpCaseConversion) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the case conversion applied to typed, pasted and programmatically set values.
- setI18n(OtpFieldI18n) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the internationalization object of this field.
- setIncompleteErrorMessage(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
-
Sets the error message to display when the code is non-empty but shorter than the length of the field.
- setInputMode(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the
inputmodeof the field, the hint that decides which on-screen keyboard mobile browsers show. - setInvalidErrorMessage(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
-
Sets the error message to display when the code is longer than the length of the field, or contains characters the field does not accept.
- setLength(int) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the number of slots, which is also the length at which the code is complete.
- setManualValidation(boolean) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- setMasked(boolean) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets whether the entered characters are hidden behind a mask glyph.
- setMaskGlyph(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the glyph rendered in filled slots while the field is masked.
- setPlaceholder(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the placeholder shown in empty slots.
- setRequiredErrorMessage(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpFieldI18n
-
Sets the error message to display when the field is required but empty.
- setRequiredIndicatorVisible(boolean) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets whether the user is required to provide a value.
- setValue(String) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Sets the value of the field, after applying the configured case conversion.
- setValueChangeMode(ValueChangeMode) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
- setValueChangeTimeout(int) - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
U
- UPPERCASE - Enum constant in enum class com.flowingcode.vaadin.addons.otpfield.OtpCaseConversion
-
The value is converted to upper case.
V
- validate() - Method in class com.flowingcode.vaadin.addons.otpfield.OtpField
-
Validates the current value against the built-in constraints and updates the invalid state and the error message accordingly.
- Validation - Search tag in class com.flowingcode.vaadin.addons.otpfield.OtpField
- Section
- Value - Search tag in class com.flowingcode.vaadin.addons.otpfield.OtpField
- Section
- valueOf(String) - Static method in enum class com.flowingcode.vaadin.addons.otpfield.OtpCaseConversion
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.flowingcode.vaadin.addons.otpfield.OtpCaseConversion
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form