Package io.micronaut.views.fields.elements

Record Class InputTextFormElement

java.lang.Object
java.lang.Record
io.micronaut.views.fields.elements.InputTextFormElement
Record Components:
name - Name of the form control. Submitted with the form as part of a name/value pair
id - It defines an identifier (ID) which must be unique in the whole document
placeholder - The placeholder attribute is a string that provides a brief hint to the user as to what kind of information is expected in the field.
required - If true indicates that the user must specify a value for the input before the owning form can be submitted.
readOnly - A Boolean attribute which, if present, means this field cannot be edited by the user.
maxLength - The maximum string length that the user can enter into the text input.
minLength - The minimum string length that the user can enter into the text input.
pattern - The pattern attribute, when specified, is a regular expression that the input's value must match for the value to pass constraint validation.
size - The size attribute is a numeric value indicating how many characters wide the input field should be.
value - input text value
label - the input label
errors - errors associated with this input
All Implemented Interfaces:
FormElementAttributes, GlobalAttributes, InputFormElement, InputStringFormElement, FormElement
@Introspected(builder=@IntrospectionBuilder(builderClass=Builder.class)) public record InputTextFormElement(@NonNull String name, @Nullable String id, @Nullable String placeholder, boolean required, boolean readOnly, @Nullable Number maxLength, @Nullable Number minLength, @Nullable String pattern, @Nullable Integer size, @Nullable String value, @Nullable Message label, @NonNull List<Message> errors) extends Record implements InputFormElement, GlobalAttributes, FormElementAttributes, InputStringFormElement
Input Text.
Since:
4.1.0
Author:
Sergio del Amo
See Also:

  • Constructor Details

    • InputTextFormElement

      public InputTextFormElement(@NonNull @NonNull String name, @Nullable @Nullable String id, @Nullable @Nullable String placeholder, boolean required, boolean readOnly, @Nullable @Nullable Number maxLength, @Nullable @Nullable Number minLength, @Nullable @Nullable String pattern, @Nullable @Nullable Integer size, @Nullable @Nullable String value, @Nullable @Nullable Message label, @NonNull @NonNull List<Message> errors)
      Creates an instance of a InputTextFormElement record class.
      Parameters:
      name - the value for the name record component
      id - the value for the id record component
      placeholder - the value for the placeholder record component
      required - the value for the required record component
      readOnly - the value for the readOnly record component
      maxLength - the value for the maxLength record component
      minLength - the value for the minLength record component
      pattern - the value for the pattern record component
      size - the value for the size record component
      value - the value for the value record component
      label - the value for the label record component
      errors - the value for the errors record component

  • Method Details

    • getType

      @NonNull public @NonNull InputType getType()
      Specified by:
      getType in interface InputFormElement
      Returns:
      Value of the type attribute of an input tag

    • builder

      @NonNull public static @NonNull InputTextFormElement.Builder builder()
      Returns:
      Input Text builder

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      @NonNull public @NonNull String name()
      Returns the value of the name record component.
      Specified by:
      name in interface FormElementAttributes
      Returns:
      the value of the name record component

    • id

      @Nullable public @Nullable String id()
      Returns the value of the id record component.
      Specified by:
      id in interface GlobalAttributes
      Specified by:
      id in interface InputStringFormElement
      Returns:
      the value of the id record component

    • placeholder

      @Nullable public @Nullable String placeholder()
      Returns the value of the placeholder record component.
      Specified by:
      placeholder in interface InputStringFormElement
      Returns:
      the value of the placeholder record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Specified by:
      required in interface GlobalAttributes
      Specified by:
      required in interface InputStringFormElement
      Returns:
      the value of the required record component

    • readOnly

      public boolean readOnly()
      Returns the value of the readOnly record component.
      Specified by:
      readOnly in interface InputStringFormElement
      Returns:
      the value of the readOnly record component

    • maxLength

      @Nullable public @Nullable Number maxLength()
      Returns the value of the maxLength record component.
      Specified by:
      maxLength in interface InputStringFormElement
      Returns:
      the value of the maxLength record component

    • minLength

      @Nullable public @Nullable Number minLength()
      Returns the value of the minLength record component.
      Specified by:
      minLength in interface InputStringFormElement
      Returns:
      the value of the minLength record component

    • pattern

      @Nullable public @Nullable String pattern()
      Returns the value of the pattern record component.
      Specified by:
      pattern in interface InputStringFormElement
      Returns:
      the value of the pattern record component

    • size

      @Nullable public @Nullable Integer size()
      Returns the value of the size record component.
      Specified by:
      size in interface InputStringFormElement
      Returns:
      the value of the size record component

    • value

      @Nullable public @Nullable String value()
      Returns the value of the value record component.
      Specified by:
      value in interface InputStringFormElement
      Returns:
      the value of the value record component

    • label

      @Nullable public @Nullable Message label()
      Returns the value of the label record component.
      Specified by:
      label in interface FormElementAttributes
      Returns:
      the value of the label record component

    • errors

      @NonNull public @NonNull List<Message> errors()
      Returns the value of the errors record component.
      Specified by:
      errors in interface FormElementAttributes
      Returns:
      the value of the errors record component