textField

textField is a component for editing or displaying small pieces of text.

  • XML element: textField

  • Java class: TypedTextField

Basics

textField is a typed component. You can set the data type using the datatype attribute. It is used to format field values. Usage example:

<textField id="nameField"
           label="Name"
           datatype="string"
           clearButtonVisible="true"
           helperText="msg://textField.helper"/>
text field basic

To work immediately with the necessary type (Integer, Long, etc.), TypedTextField has methods:

  • setTypedValue()

  • getTypedValue()

To create textField connected to data, use dataContainer and property attributes.

<data>
    <instance class="com.company.onboarding.entity.Department"
              id="departmentDc">
        <fetchPlan extends="_base"/>
        <loader id="departmentDl"/>
    </instance>
</data>
<layout>
    <textField dataContainer="departmentDc"
               property="name"/>
</layout>

In the example above, the view describes the departmentDc data container for the Department entity, which has the name attribute. The textField component has a link to the container specified in the dataContainer attribute; the property attribute contains the name of the entity attribute that is displayed in textField.

Attributes

id - autocapitalize - autocomplete - autocorrect - autofocus - autoselect - classNames - clearButtonVisible - dataContainer - datatype - enabled - errorMessage - height - helperText - invalid - label - maxHeight - maxWidth - minHeight - minWidth - pattern - placeholder - property - readOnly - required - requiredIndicatorVisible - requiredMessage - themeNames - title - value - valueChangeMode - valueChangeTimeout - visible - width

autoselect

Vaadin

Set to true to always have the field value automatically selected when the field gains focus, false otherwise.

clearButtonVisible

Vaadin

Sets the visibility of the button which clears the field.

required

Vaadin

Indicates that this field requires a value.

The required indicator will not be visible, if the label property is not set for the textField.

value

Defines the value of textField.

If the value cannot be parsed to a required data type, the default conversion error message appears.

Handlers

AttachEvent - BlurEvent - ChangeEvent - ComponentValueChangeEvent - CompositionEndEvent - CompositionStartEvent - CompositionUpdateEvent - DetachEvent - FocusEvent - InputEvent - InvalidChangeEvent - KeyDownEvent - KeyPressEvent - KeyUpEvent - TypedValueChangeEvent - validator

To generate a handler stub in Jmix Studio, use the Handlers tab of the Component 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).

ChangeEvent

com.vaadin.flow.component.textfield.GeneratedVaadinTextField.ChangeEvent corresponds to the change DOM event.

InvalidChangeEvent

com.vaadin.flow.component.textfield.GeneratedVaadinTextField.InvalidChangeEvent is sent when the value of the invalid attribute of the component changes.

validator

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

@Install(to = "zipField", subject = "validator")
protected void zipFieldValidator(Integer value) {
    if (value != null && String.valueOf(value).length() != 6)
        throw new ValidationException("Zip must be of 6 digits length");
}

See Also

See the Vaadin Docs for more information.