Package io.jmix.ui.meta

Annotation Interface StudioElementsGroup

@Documented public @interface StudioElementsGroup
Indicates that the annotated method should be shown in Studio Screen Designer as a nested group of elements of UI component, e.g. columns, actions, fields.

  • Element Details

    • caption

      String caption
      Returns:
      caption of the elements group in Studio Screen Designer
      Default:
      ""

    • description

      String description
      Returns:
      description of the elements group in Studio Screen Designer
      Default:
      ""

    • xmlElement

      String xmlElement
      Returns:
      XML tag of the elements group
      Default:
      ""

    • icon

      String icon
      Specifies path to the component icon, SVG or PNG. Relative to the component module root. The icon used in the Component Hierarchy.
      Returns:
      relative path to the SVG or PNG icon file.
      Default:
      ""

    • documentationURL

      String documentationURL
      Specifies URL pointing to the documentation page for the annotated elements group. Used in Jmix Documentation action in the Studio Screen Designer.
      If the documentation is version dependent, use %VERSION% as a placeholder. It will be replaced with the minor version (e.g. 1.2) of the artifact containing UI component.
      Returns:
      URL of the documentation page
      Default:
      ""

    • maxOccurs

      MaxOccurNumber maxOccurs
      Returns:
      the maximum number of times a group of elements can occur
      Default:
      ONE

    • elementClass

      String elementClass
      Specifies FQN of base element class. If not specified, then it will be automatically defined as a type of the method parameter.
      Returns:
      FQN of base element class
      Default:
      ""

    • elementXmlName

      String elementXmlName
      Returns:
      XML tag of the element in the group if it differs from the xmlElement specified in the element definition class.
      Default:
      ""