Record Class FormField

java.lang.Object
java.lang.Record
dev.boze.api.gui.editor.FormField
Record Components:
label - Shown next to the field, or empty to show the field alone
placeholder - Shown while the field is empty
masked - Whether the text is hidden, as for passwords
public record FormField(String label, TextFieldState field, String placeholder, boolean masked) extends Record
A text field in a form made with GuiEditors.form(String, String, String). Read what was typed from field.

  • Constructor Details

    • FormField

      public FormField(String label, TextFieldState field, String placeholder, boolean masked)
      Creates an instance of a FormField record class.
      Parameters:
      label - the value for the label record component
      field - the value for the field record component
      placeholder - the value for the placeholder record component
      masked - the value for the masked record component

    • FormField

      public FormField(String label, TextFieldState field, String placeholder)

  • Method Details

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • field

      public TextFieldState field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component

    • placeholder

      public String placeholder()
      Returns the value of the placeholder record component.
      Returns:
      the value of the placeholder record component

    • masked

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