Package io.jmix.flowui.kit.meta

Annotation Interface StudioAction

@Target(METHOD)
@Inherited
public @interface StudioAction

Meta description that describes action.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	availableInViewWizard	Specifies whether the action should be displayed in the view creation wizard.
String	classFqn
String	description	Action description.
String	documentationLink
String	icon
StudioPropertiesItem[]	items	Properties that should be wrapped into property tag and added to the properties tag.
StudioProperty[]	properties
String[]	target
String	type	Action type.
String[]	unsupportedTarget

Element Details

type

String type

Action type. Should be related to io.jmix.flowui.action.ActionType.

Default:

""

classFqn

String classFqn

See Also:

• StudioComponent.classFqn()

Default:

""

icon

String icon

See Also:

• StudioComponent.classFqn()

Default:

""

description

String description

Action description. Studio will use the description in wizards.

Default:

""

target

String[] target

See Also:

• StudioActionsGroup.target()

Default:

{}

unsupportedTarget

String[] unsupportedTarget

See Also:

• StudioActionsGroup.unsupportedTarget()

Default:

{}

availableInViewWizard

boolean availableInViewWizard

Specifies whether the action should be displayed in the view creation wizard.

Default:

false

properties

StudioProperty[] properties

See Also:

• StudioComponent.properties()

Default:

{}

items

StudioPropertiesItem[] items

Properties that should be wrapped into property tag and added to the properties tag.

Default:

{}

documentationLink

String documentationLink

See Also:

• StudioComponent.documentationLink()

Default:

""