Annotation Interface UiHint


@Deprecated(since="next", forRemoval=true) @Retention(RUNTIME) @Target(FIELD) public @interface UiHint
Deprecated, for removal: This API element is subject to removal in a future version.
Configure field hints in an EntityView or Layout bean instead, e.g.
  class InvoiceView implements EntityView {
      public Class<?> entity() { return Invoice.class; }
      public void fields(EntityConfigBuilder f) {
          f.field("total").order(10).hideInForm()
           .field("notes").widget("textarea");
      }
  }
Layout-configured hints override this annotation. The annotation will be removed in the next release.

One exception: tabular section row classes (e.g. line-item rows inside a document's @TabularSection). The DSL does not yet expose tabular section field hints; use @UiHint on those row classes only when custom row-field hints are still required.

Per-field UI hint.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Deprecated, for removal: This API element is subject to removal in a future version.
    Controls the input widget rendered in the form.
    Deprecated, for removal: This API element is subject to removal in a future version.
     
  • Element Details

    • visibleInList

      boolean visibleInList
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      true
    • visibleInForm

      boolean visibleInForm
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      true
    • visibleInDetail

      boolean visibleInDetail
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      true
    • order

      int order
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      0
    • group

      String group
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      ""
    • width

      String width
      Deprecated, for removal: This API element is subject to removal in a future version.
      Default:
      ""
    • widget

      String widget
      Deprecated, for removal: This API element is subject to removal in a future version.
      Controls the input widget rendered in the form. Values: "" (default input), "textarea", "richtext"
      Default:
      ""