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 pairid- It defines an identifier (ID) which must be unique in the whole documentcols- The visible width of the text control, in average character widthsrows- The number of visible text lines for the control.placeholder- A hint to the user of what can be entered in the controlrequired- 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 controlvalue- text area contentlabel- represents a caption for an item in a user interfaceerrors- 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classTextarea form builder. -
Constructor Summary
ConstructorsConstructorDescriptionTextareaFormElement(@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) Creates an instance of aTextareaFormElementrecord class. -
Method Summary
Modifier and TypeMethodDescriptionstatic @NonNull TextareaFormElement.Builderbuilder()@Nullable Integercols()Returns the value of thecolsrecord component.final booleanIndicates whether some other object is "equal to" this one.errors()Returns the value of theerrorsrecord component.getTag()final inthashCode()Returns a hash code value for this object.@Nullable Stringid()Returns the value of theidrecord component.@Nullable Messagelabel()Returns the value of thelabelrecord component.@NonNull Stringname()Returns the value of thenamerecord component.@Nullable StringReturns the value of theplaceholderrecord component.booleanreadOnly()Returns the value of thereadOnlyrecord component.booleanrequired()Returns the value of therequiredrecord component.@Nullable Integerrows()Returns the value of therowsrecord component.final StringtoString()Returns a string representation of this record class.@Nullable Stringvalue()Returns the value of thevaluerecord component.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface io.micronaut.views.fields.elements.FormElementAttributes
hasErrors
-
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 aTextareaFormElementrecord class.- Parameters:
name- the value for thenamerecord componentid- the value for theidrecord componentcols- the value for thecolsrecord componentrows- the value for therowsrecord componentplaceholder- the value for theplaceholderrecord componentrequired- the value for therequiredrecord componentreadOnly- the value for thereadOnlyrecord componentvalue- the value for thevaluerecord componentlabel- the value for thelabelrecord componenterrors- the value for theerrorsrecord component
-
-
Method Details
-
getTag
- Specified by:
getTagin interfaceFormElement- Returns:
- The HTML Tag this element refers to.
-
builder
- Returns:
- TextArea FormElement Builder
-
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. -
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. -
equals
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 withObjects::equals(Object,Object); primitive components are compared with '=='. -
name
Returns the value of thenamerecord component.- Specified by:
namein interfaceFormElementAttributes- Returns:
- the value of the
namerecord component
-
id
Returns the value of theidrecord component.- Specified by:
idin interfaceGlobalAttributes- Returns:
- the value of the
idrecord component
-
cols
Returns the value of thecolsrecord component.- Returns:
- the value of the
colsrecord component
-
rows
Returns the value of therowsrecord component.- Returns:
- the value of the
rowsrecord component
-
placeholder
Returns the value of theplaceholderrecord component.- Returns:
- the value of the
placeholderrecord component
-
required
public boolean required()Returns the value of therequiredrecord component.- Specified by:
requiredin interfaceGlobalAttributes- Returns:
- the value of the
requiredrecord component
-
readOnly
public boolean readOnly()Returns the value of thereadOnlyrecord component.- Returns:
- the value of the
readOnlyrecord component
-
value
Returns the value of thevaluerecord component.- Returns:
- the value of the
valuerecord component
-
label
Returns the value of thelabelrecord component.- Specified by:
labelin interfaceFormElementAttributes- Returns:
- the value of the
labelrecord component
-
errors
Returns the value of theerrorsrecord component.- Specified by:
errorsin interfaceFormElementAttributes- Returns:
- the value of the
errorsrecord component
-