Package io.jmix.ui.meta

Annotation Interface StudioFacet

@Documented @Retention(CLASS) @Target(TYPE) public @interface StudioFacet
Indicates that the annotated interface should be available in Studio Screen Designer as a non-visual component. Provides metadata for components Palette and Component Inspector of Screen Designer. The annotated interface must be a direct or indirect subclass of Facet.

  • Element Details

    • caption

      String caption
      Returns:
      caption in Studio Screen Designer Palette
      Default:
      ""

    • description

      String description
      Returns:
      description of the facet in Studio Screen Designer Palette
      Default:
      ""

    • category

      String category
      Returns:
      category of the event in Screen Designer Events, e.g. Data, Interaction, Lifecycle
      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 Palette and Component Hierarchy.
      Returns:
      relative path to the SVG or PNG icon file.
      Default:
      ""

    • xmlElement

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

    • xmlns

      String xmlns
      Specifies xml namespace required for the facet.
      Returns:
      xml namespace
      Default:
      ""

    • xmlnsAlias

      String xmlnsAlias
      Specifies xml namespace alias required for the facet.
      Returns:
      xml namespace alias
      Default:
      ""

    • defaultProperty

      String defaultProperty
      Returns:
      name of the default property, it will be automatically selected in Properties panel
      Default:
      ""

    • unsupportedProperties

      String[] unsupportedProperties
      Returns:
      names of unsupported properties that should be hidden from Properties panel
      Default:
      {}

    • documentationURL

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

    • unsupportedHandlers

      String[] unsupportedHandlers
      Returns:
      names of unsupported handlers that should be hidden from Handlers and Generate Handler panels
      Default:
      {}