Record Class TextareaFormElement

java.lang.Object
java.lang.Record
io.micronaut.views.fields.elements.TextareaFormElement
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
cols - The visible width of the text control, in average character widths
rows - The number of visible text lines for the control.
placeholder - A hint to the user of what can be entered in the control
required - If true indicates that the user must specify a value for the input before the owning form can be submitted.
readOnly - indicates that the user cannot modify the value of the control
value - text area content
label - represents a caption for an item in a user interface
errors - Form element validation Errors.
All Implemented Interfaces:
FormElementAttributes, GlobalAttributes, FormElement

@Introspected(builder=@IntrospectionBuilder(builderClass=Builder.class)) public record TextareaFormElement(@NonNull String name, @Nullable String id, @Nullable Integer cols, @Nullable Integer rows, @Nullable String placeholder, boolean required, boolean readOnly, @Nullable String value, @Nullable Message label, @NonNull List<Message> errors) extends Record implements FormElement, FormElementAttributes, GlobalAttributes
Text Area.
Since:
4.1.0
Author:
Sergio del Amo
See Also:
  • Constructor Details

    • TextareaFormElement

      public TextareaFormElement(@NonNull @NonNull String name, @Nullable @Nullable String id, @Nullable @Nullable Integer cols, @Nullable @Nullable Integer rows, @Nullable @Nullable String placeholder, boolean required, boolean readOnly, @Nullable @Nullable String value, @Nullable @Nullable Message label, @NonNull @NonNull List<Message> errors)
      Creates an instance of a TextareaFormElement record class.
      Parameters:
      name - the value for the name record component
      id - the value for the id record component
      cols - the value for the cols record component
      rows - the value for the rows 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
      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

    • getTag

      public HtmlTag getTag()
      Specified by:
      getTag in interface FormElement
      Returns:
      The HTML Tag this element refers to.
    • builder

      @NonNull public static @NonNull TextareaFormElement.Builder builder()
      Returns:
      TextArea FormElement 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
      Returns:
      the value of the id record component
    • cols

      @Nullable public @Nullable Integer cols()
      Returns the value of the cols record component.
      Returns:
      the value of the cols record component
    • rows

      @Nullable public @Nullable Integer rows()
      Returns the value of the rows record component.
      Returns:
      the value of the rows record component
    • placeholder

      @Nullable public @Nullable String placeholder()
      Returns the value of the placeholder record component.
      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
      Returns:
      the value of the required record component
    • readOnly

      public boolean readOnly()
      Returns the value of the readOnly record component.
      Returns:
      the value of the readOnly record component
    • value

      @Nullable public @Nullable String value()
      Returns the value of the value record component.
      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