Package io.jmix.ui.meta

Annotation Interface StudioCollection

@Target(METHOD) public @interface StudioCollection
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

    • xmlElement

      String xmlElement
      Returns:
      XML tag of the collection
      Default:
      ""

    • icon

      String icon
      Specifies path to the collection 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:
      ""

    • itemXmlElement

      String itemXmlElement
      Returns:
      XML tag of the collection elements
      Default:
      ""

    • itemIcon

      String itemIcon
      Specifies path to the collection item 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:
      ""

    • itemCaption

      String itemCaption
      Returns:
      caption of the collection elements in Studio Screen Designer Palette
      Default:
      ""

    • documentationURL

      String documentationURL
      Specifies URL pointing to the documentation page for the annotated element. 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:
      ""

    • itemProperties

      StudioProperty[] itemProperties
      Returns:
      collection item properties
      Default:
      {}