Package io.jmix.flowui.kit.meta

Annotation Interface StudioElementsGroup

@Target(METHOD) @Inherited public @interface StudioElementsGroup
Meta description that describes group of elements.

You can override an already existing StudioElementsGroup for your component by specifying the same xmlElement() and defining your xmlns() or defining a more specific target() (usually the FQN of your component).

  • Element Details

    • identifier

      String identifier
      Optional.

      Unique elements group identifier.

      Identifier is used to identify elements group in target() and unsupportedTarget() when need to define a nested elements group in StudioElementsGroup meta.
      See Also:
      Default:
      ""

    • name

      String name
      See Also:
      Default:
      ""

    • elementClassFqn

      String elementClassFqn
      FQN of element class that should be added into group.
      Default:
      ""

    • useGroupXmlns

      boolean useGroupXmlns
      Specifies that elements should use the same xml namespace as the group.
      Default:
      true

    • icon

      String icon
      See Also:
      Default:
      "io/jmix/flowui/kit/meta/icon/unknownComponent.svg"

    • xmlElement

      String xmlElement
      See Also:
      Default:
      ""

    • xmlns

      String xmlns
      See Also:
      Default:
      ""

    • xmlnsAlias

      String xmlnsAlias
      See Also:
      Default:
      ""

    • target

      String[] target
      Target that group should be added to.

      Studio accepts the following formats:

      Default:
      {}

    • unsupportedTarget

      String[] unsupportedTarget
      Target that group should NOT be added to.

      See target() for details and available formats.
      Default:
      {}

    • excludedElementsInfo

      StudioExcludedElementsInfo excludedElementsInfo
      Specifies the information about elements that are excluded from a given elements group.
      Default:
      @io.jmix.flowui.kit.meta.StudioExcludedElementsInfo

    • visible

      boolean visible
      Specifies that group should be visible in Studio preview.
      Default:
      false

    • unlimitedCount

      boolean unlimitedCount
      Defines whether an elements group can be added to component an unlimited number of times. By default, an elements group can only be added once.
      Returns:
      whether an elements group can be added to component an unlimited number of times
      Default:
      false

    • properties

      StudioProperty[] properties
      See Also:
      Default:
      {}

    • documentationLink

      String documentationLink
      See Also:
      Default:
      ""