io.jmix.ui.meta

Annotation Type StudioCollection

@Target(value=METHOD)
public @interface StudioCollection

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	documentationURL Specifies URL pointing to the documentation page for the annotated element.
java.lang.String	icon Specifies path to the collection icon, SVG or PNG.
java.lang.String	itemCaption
java.lang.String	itemIcon Specifies path to the collection item icon, SVG or PNG.
StudioProperty[]	itemProperties
java.lang.String	itemXmlElement
java.lang.String	xmlElement

Element Detail

xmlElement

public abstract java.lang.String xmlElement

Returns:

XML tag of the collection

Default:

""

icon

public abstract java.lang.String icon

Specifies path to the collection 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:

""

itemXmlElement

public abstract java.lang.String itemXmlElement

Returns:

XML tag of the collection elements

Default:

""

itemIcon

public abstract java.lang.String itemIcon

Specifies path to the collection item 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:

""

itemCaption

public abstract java.lang.String itemCaption

Returns:

caption of the collection elements in Studio Screen Designer Palette

Default:

""

documentationURL

public abstract java.lang.String documentationURL

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

""

itemProperties

public abstract StudioProperty[] itemProperties

Returns:

collection item properties

Default:

{}