Package io.jmix.ui.meta

Annotation Interface StudioComponent

@Documented public @interface StudioComponent
Indicates that the annotated UI component interface should be available in Studio Screen Designer. Provides metadata for Component Palette and Component Inspector of Screen Designer. The annotated interface must be a direct or indirect subclass of Component.

  • Element Details

    • caption

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

    • description

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

    • category

      String category
      Returns:
      category of the component in Studio Screen Designer Palette, e.g. Containers, Components, Fields
      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 component
      Default:
      ""

    • xmlns

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

    • xmlnsAlias

      String xmlnsAlias
      Specifies xml namespace alias required for the component.
      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:
      {}

    • canvasIcon

      String canvasIcon
      Specifies path to the UI component icon shown on canvas as a placeholder, SVG or PNG. Relative to the component module root. Used if canvasBehaviour() is CanvasBehaviour.BOX.
      Returns:
      relative path to the SVG or PNG icon file.
      Default:
      ""

    • canvasIconSize

      CanvasIconSize canvasIconSize
      Returns:
      size of the icon shown on canvas as a placeholder.
      Default:
      SMALL

    • canvasText

      String canvasText
      Specifies text that will be shown on a canvas for the UI component E.g. button caption for CanvasBehaviour.BUTTON component
      Default:
      ""

    • canvasTextProperty

      String canvasTextProperty
      Specifies name of the component property that provides value that will be used as canvasText(). If property value is not set then canvasText() attribute value will be used
      Default:
      ""

    • canvasBehaviour

      CanvasBehaviour canvasBehaviour
      Returns:
      behaviour of UI component on Screen designer canvas
      Default:
      BOX

    • containerType

      ContainerType containerType
      Returns:
      type of container layout if canvasBehaviour() is CanvasBehaviour.CONTAINER
      Default:
      VERTICAL

    • documentationURL

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

    • unsupportedHandlers

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