passwordField

LIVE DEMO

A field for entering passwords. Characters typed into this field are masked by default.

The loginForm component includes a password input field, where users can enter their password as they log in.

  • XML element: passwordField

  • Java class: JmixPasswordField

Basics

The following example demonstrates basic passwordField functionality:

<passwordField id="passwordField"
               label="New password"
               required="true"
               clearButtonVisible="true"
               helperText="Make it strong!">
</passwordField>
<button id="createPasswordButton"
        text="Create"/>
@ViewComponent
protected JmixPasswordField passwordField;
@Autowired
protected Notifications notifications;

@Subscribe("createPasswordButton")
protected void onButtonClick(ClickEvent<Button> event) {
    if (!passwordField.getValue().isEmpty())
        notifications.create("Password created")
                .show();
    }
password field basic

The set of attributes for the passwordField component is similar to the attributes available for the textField component. However, there is no datatype attribute – the input for a passwordField can only be of type String.

Theme Variants

Use themeNames attribute to set a component theme.

Variant Description Supported By

small

Makes the component smaller.

Aura, Lumo

align-left

Aligns the field value to the left side.

Aura, Lumo

align-center

Centers the field value.

Aura, Lumo

align-right

Aligns the field value to the right side.

Aura, Lumo

helper-above-field

Renders the helper text above the field, below the label.

Aura, Lumo

Attributes

id - alignSelf - allowedCharPattern - ariaLabel - ariaLabelledBy autocapitalize - autocomplete - autocorrect - autofocus - autoselect - classNames - css - clearButtonVisible - colspan - dataContainer - enabled - errorMessage - focusShortcut - height - helperText - label - maxHeight - maxWidth - minHeight - minWidth - pattern - placeholder - property - readOnly - required - requiredMessage - tabIndex - themeNames - title - value - valueChangeMode - valueChangeTimeout - visible - width

value

Defines the value of passwordField.

Handlers

AttachEvent - BlurEvent - ComponentValueChangeEvent - CompositionEndEvent - CompositionStartEvent - CompositionUpdateEvent - DetachEvent - FocusEvent - InputEvent - KeyDownEvent - KeyPressEvent - KeyUpEvent - validator - statusChangeHandler

To generate a handler stub in Jmix Studio, use the Handlers tab of the Jmix UI inspector panel or the Generate Handler action available in the top panel of the view class and through the Code → Generate menu (Alt+Insert / Cmd+N).

validator

Adds a validator instance to the component. The validator must throw ValidationException if the value is not valid.

@Install(to = "passwordField", subject = "validator")
private void passwordFieldValidator(String value) {
    if (value != null && value.length() < 8)
        throw new ValidationException("Password must be at least 8 characters long");
}

Elements

tooltip - validator - prefix - suffix

See Also

See Vaadin Docs for more information.