Package com.onec.ui

Record Class FieldHint

java.lang.Object
java.lang.Record
com.onec.ui.FieldHint
public record FieldHint(Boolean visibleInList, Boolean visibleInForm, Boolean visibleInDetail, Integer order, String group, String width, String widget, String placeholder, String format, String hint) extends Record
UI hints for a single field, configured via UiLayoutBuilder.

All fields are nullable so callers can distinguish "not set" from "explicitly set to the default value". When merged with the descriptor produced by MetadataScanner, only non-null fields override the value derived from @UiHint (or its absence).

This is the configurer-side replacement for @UiHint. New code should use the DSL rather than the annotation; the annotation remains as a deprecated fallback for one release.

  • Constructor Details

    • FieldHint

      public FieldHint(Boolean visibleInList, Boolean visibleInForm, Boolean visibleInDetail, Integer order, String group, String width, String widget, String placeholder, String format, String hint)
      Creates an instance of a FieldHint record class.
      Parameters:
      visibleInList - the value for the visibleInList record component
      visibleInForm - the value for the visibleInForm record component
      visibleInDetail - the value for the visibleInDetail record component
      order - the value for the order record component
      group - the value for the group record component
      width - the value for the width record component
      widget - the value for the widget record component
      placeholder - the value for the placeholder record component
      format - the value for the format record component
      hint - the value for the hint record component

  • Method Details

    • empty

      public static FieldHint empty()

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • visibleInList

      public Boolean visibleInList()
      Returns the value of the visibleInList record component.
      Returns:
      the value of the visibleInList record component

    • visibleInForm

      public Boolean visibleInForm()
      Returns the value of the visibleInForm record component.
      Returns:
      the value of the visibleInForm record component

    • visibleInDetail

      public Boolean visibleInDetail()
      Returns the value of the visibleInDetail record component.
      Returns:
      the value of the visibleInDetail record component

    • order

      public Integer order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component

    • group

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

    • width

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

    • widget

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

    • placeholder

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

    • format

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

    • hint

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