Package io.jmix.ui.meta

Annotation Interface StudioAction

@Documented @Target(TYPE) public @interface StudioAction
Indicates that the annotated interface should be available in Studio Screen Designer as an action. Provides metadata for Component Palette and Component Inspector of Screen Designer. The annotated interface must be a direct or indirect subclass of Action.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    availableInScreenWizard
    Indicates that action should be available in screen wizard
    String
    caption
    Caption of the action in Screen Designer Palette.
    String
    description
    Description of the action in Screen Designer Palette.
    String
    icon
    Component Palette icon, SVG or PNG.
    String[]
    target
    Fully-qualified class names of the components to which the action can be applied.

  • Element Details

    • caption

      String caption
      Caption of the action in Screen Designer Palette.
      Default:
      ""

    • description

      String description
      Description of the action in Screen Designer Palette.
      Default:
      ""

    • target

      String[] target
      Fully-qualified class names of the components to which the action can be applied. Some base interface is expected in most cases. E.g. "io.jmix.ui.component.ListComponent"
      Default:
      {}

    • icon

      String icon
      Component Palette icon, SVG or PNG.
      Default:
      ""

    • availableInScreenWizard

      boolean availableInScreenWizard
      Indicates that action should be available in screen wizard
      Default:
      false