io.jmix.ui.meta

Annotation Type StudioElementsGroup

@Documented
public @interface StudioElementsGroup

Indicates that the annotated method should be shown in Studio Screen Designer as a nested group of elements of UI component, e.g. columns, actions, fields.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	caption
java.lang.String	description
java.lang.String	documentationURL Specifies URL pointing to the documentation page for the annotated elements group.
java.lang.String	elementClass Specifies FQN of base element class.
java.lang.String	elementXmlName
java.lang.String	icon Specifies path to the component icon, SVG or PNG.
MaxOccurNumber	maxOccurs
java.lang.String	xmlElement

Element Detail

caption

public abstract java.lang.String caption

Returns:

caption of the elements group in Studio Screen Designer

Default:

""

description

public abstract java.lang.String description

Returns:

description of the elements group in Studio Screen Designer

Default:

""

xmlElement

public abstract java.lang.String xmlElement

Returns:

XML tag of the elements group

Default:

""

icon

public abstract java.lang.String icon

Specifies path to the component icon, SVG or PNG. Relative to the component module root. The icon used in the Component Hierarchy.

Returns:

relative path to the SVG or PNG icon file.

Default:

""

documentationURL

public abstract java.lang.String documentationURL

Specifies URL pointing to the documentation page for the annotated elements group. 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:

""

maxOccurs

public abstract MaxOccurNumber maxOccurs

Returns:

the maximum number of times a group of elements can occur

Default:

io.jmix.ui.meta.MaxOccurNumber.ONE

elementClass

public abstract java.lang.String elementClass

Specifies FQN of base element class. If not specified, then it will be automatically defined as a type of the method parameter.

Returns:

FQN of base element class

Default:

""

elementXmlName

public abstract java.lang.String elementXmlName

Returns:

XML tag of the element in the group if it differs from the xmlElement specified in the element definition class.

Default:

""