Package io.jmix.flowui.kit.meta

Annotation Interface StudioElementsGroup

@Target(METHOD)
@Inherited
public @interface StudioElementsGroup

Meta description that describes group of elements.

You can override an already existing StudioElementsGroup for your component by specifying the same xmlElement() and defining your xmlns() or defining a more specific target() (usually the FQN of your component).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	documentationLink
String	elementClassFqn	FQN of element class that should be added into group.
StudioExcludedElementsInfo	excludedElementsInfo	Specifies the information about elements that are excluded from a given elements group.
String	icon
String	identifier	Optional.
String	name
StudioProperty[]	properties
String[]	target	Target that group should be added to.
boolean	unlimitedCount	Defines whether an elements group can be added to component an unlimited number of times.
String[]	unsupportedTarget	Target that group should NOT be added to.
boolean	useGroupXmlns	Specifies that elements should use the same xml namespace as the group.
boolean	visible	Specifies that group should be visible in Studio preview.
String	xmlElement
StudioXmlElementInitializer	xmlElementInitializer
String	xmlns
String	xmlnsAlias

Element Details

identifier

String identifier

Optional.

Unique elements group identifier.

Identifier is used to identify elements group in target() and unsupportedTarget() when need to define a nested elements group in StudioElementsGroup meta.

See Also:

• StudioMetaConstants.IDENTIFIER_PREFIX

Default:

""

name

String name

See Also:

• StudioComponent.name()

Default:

""

elementClassFqn

String elementClassFqn

FQN of element class that should be added into group.

Default:

""

useGroupXmlns

boolean useGroupXmlns

Specifies that elements should use the same xml namespace as the group.

Default:

true

icon

String icon

See Also:

• StudioComponent.icon()

Default:

"io/jmix/flowui/kit/meta/icon/unknownComponent.svg"

xmlElement

String xmlElement

See Also:

• StudioComponent.xmlElement()

Default:

""

xmlns

String xmlns

See Also:

• StudioComponent.xmlns()

Default:

""

xmlnsAlias

String xmlnsAlias

See Also:

• StudioComponent.xmlnsAlias()

Default:

""

target

String[] target

Target that group should be added to.

Studio accepts the following formats:

• FQN of component class (e.g.: io.jmix.flowui.component.combobox.EntityComboBox)
• Component tag. Use StudioMetaConstants.TAG_PREFIX (e.g: tag:button)
• Identifier of an elements group. Use StudioMetaConstants.IDENTIFIER_PREFIX (e.g.: identifier:my_element_group_id)

Default:

{}

unsupportedTarget

String[] unsupportedTarget

Target that group should NOT be added to.

See target() for details and available formats.

Default:

{}

excludedElementsInfo

StudioExcludedElementsInfo excludedElementsInfo

Specifies the information about elements that are excluded from a given elements group.

Default:

@io.jmix.flowui.kit.meta.StudioExcludedElementsInfo

visible

boolean visible

Specifies that group should be visible in Studio preview.

Default:

false

unlimitedCount

boolean unlimitedCount

Defines whether an elements group can be added to component an unlimited number of times. By default, an elements group can only be added once.

Returns:

whether an elements group can be added to component an unlimited number of times

Default:

false

properties

StudioProperty[] properties

See Also:

• StudioComponent.properties()

Default:

{}

xmlElementInitializer

StudioXmlElementInitializer xmlElementInitializer

See Also:

• StudioComponent.xmlElementInitializer()

Default:

@io.jmix.flowui.kit.meta.StudioXmlElementInitializer

documentationLink

String documentationLink

See Also:

• StudioComponent.documentationLink()

Default:

""