io.jmix.ui.meta

Annotation Type StudioAction

@Documented
 @Target(value=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 and Description
boolean	availableInScreenWizard Indicates that action should be available in screen wizard
java.lang.String	caption Caption of the action in Screen Designer Palette.
java.lang.String	description Description of the action in Screen Designer Palette.
java.lang.String	icon Component Palette icon, SVG or PNG.
java.lang.String[]	target Fully-qualified class names of the components to which the action can be applied.

Element Detail

caption

public abstract java.lang.String caption

Caption of the action in Screen Designer Palette.

Default:

""

description

public abstract java.lang.String description

Description of the action in Screen Designer Palette.

Default:

""

target

public abstract java.lang.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

public abstract java.lang.String icon

Component Palette icon, SVG or PNG.

Default:

""

availableInScreenWizard

public abstract boolean availableInScreenWizard

Indicates that action should be available in screen wizard

Default:

false