Package io.jmix.flowui.kit.meta

Annotation Interface StudioElement

@Target(METHOD)
@Inherited
public @interface StudioElement

Meta description that describes specific element for component.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
StudioAvailableChildrenInfo	availableChildren
String	classFqn
StudioCustomInstall[]	customInstalls
StudioCustomSubscription[]	customSubscriptions
String	documentationLink
String	icon
String	identifier	Optional.
String	injectionIdentifier
boolean	isInjectable
String	name
StudioProperty[]	properties
StudioPropertiesBinding[]	propertiesBindings
Class<?>[]	propertyGroups
StudioSupplyHandler[]	supplyHandlers
String[]	target
boolean	unlimitedCount
String[]	unsupportedTarget
boolean	visible
String	xmlElement
StudioXmlElementInitializer	xmlElementInitializer
String	xmlns
String	xmlnsAlias

Element Details

identifier

String identifier

Optional.

Unique element identifier.

Can be useful to identify the element in target() and unsupportedTarget().

See Also:

• StudioMetaConstants.IDENTIFIER_PREFIX

Default:

""

name

String name

See Also:

• StudioComponent.name()

Default:

""

classFqn

String classFqn

See Also:

• StudioComponent.classFqn()

Default:

""

injectionIdentifier

String injectionIdentifier

See Also:

• StudioComponent.injectionIdentifier()

Default:

"id"

isInjectable

boolean isInjectable

See Also:

• StudioComponent.isInjectable()

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

See Also:

• StudioElementsGroup.target()

Default:

{}

unsupportedTarget

String[] unsupportedTarget

See Also:

• StudioElementsGroup.unsupportedTarget()

Default:

{}

visible

boolean visible

See Also:

• StudioElementsGroup.visible()

Default:

false

unlimitedCount

boolean unlimitedCount

See Also:

• StudioElementsGroup.unlimitedCount()

Default:

true

properties

StudioProperty[] properties

See Also:

• StudioComponent.properties()

Default:

{}

propertyGroups

Class<?>[] propertyGroups

See Also:

• StudioComponent.propertyGroups()

Default:

{}

propertiesBindings

StudioPropertiesBinding[] propertiesBindings

See Also:

• StudioComponent.propertiesBindings()

Default:

{}

supplyHandlers

StudioSupplyHandler[] supplyHandlers

See Also:

• StudioComponent.supplyHandlers()

Default:

{}

customSubscriptions

StudioCustomSubscription[] customSubscriptions

See Also:

• StudioComponent.customSubscriptions()

Default:

{}

customInstalls

StudioCustomInstall[] customInstalls

See Also:

• StudioComponent.customInstalls()

Default:

{}

availableChildren

StudioAvailableChildrenInfo availableChildren

See Also:

• StudioComponent.availableChildren()

Default:

@io.jmix.flowui.kit.meta.StudioAvailableChildrenInfo

xmlElementInitializer

StudioXmlElementInitializer xmlElementInitializer

See Also:

• StudioComponent.xmlElementInitializer()

Default:

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

documentationLink

String documentationLink

See Also:

• StudioComponent.documentationLink()

Default:

""