Package io.jmix.flowui.kit.meta

Annotation Interface StudioProperty

@Documented
@Target(TYPE_PARAMETER)
public @interface StudioProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StudioProperty.Category

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
StudioPropertyType	type
String	xmlAttribute

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	addMethod
String	addParameterFqn
String	category	Property category.
String	cdataWrapperTag	Specifies tag that Studio will use when setting a CDATA value (if type equals StudioPropertyType.CDATA).
String	classFqn	Fully-qualified name of property class
String[]	componentRefTags	Specifies component tags that will be taken into account when searching for a reference (if type equals StudioPropertyType.COMPONENT_REF)
String	defaultValue
String	defaultValueRef	Describes an application property or an element whose default property value should be used as the default value for the current property.
String	initialValue
String[]	options
String	removeMethod
String	removeParameterFqn
boolean	required
String	setMethod
String	setParameterFqn
String	typeParameter	Specifies name of the type parameter for the component that is provided by the property. The actual class for the type parameter can be resolved for the following property types: StudioPropertyType.ENTITY_CLASS, StudioPropertyType.ENUM_CLASS, StudioPropertyType.COMPONENT_REF, StudioPropertyType.PROPERTY_REF, StudioPropertyType.DATA_CONTAINER_REF, StudioPropertyType.COLLECTION_DATA_CONTAINER_REF
boolean	useAsInjectionType	Use as type for injected field.

Element Details

xmlAttribute

String xmlAttribute

type

StudioPropertyType type

classFqn

String classFqn

Fully-qualified name of property class

Default:

""

category

String category

Property category.

See Also:

• StudioProperty.Category

Default:

"Other"

required

boolean required

Default:

false

defaultValue

String defaultValue

Default:

""

defaultValueRef

String defaultValueRef

Describes an application property or an element whose default property value should be used as the default value for the current property.

Supported syntax:

1. parent:someParentProperty

   Example: parent:sortable

2. application_property:someApplicationProperty

   Example: application_property:jmix.ui.component.default-trim-enabled

Default:

""

initialValue

String initialValue

Default:

""

options

String[] options

Default:

{}

setMethod

String setMethod

Default:

""

setParameterFqn

String setParameterFqn

Default:

""

addMethod

String addMethod

Default:

""

addParameterFqn

String addParameterFqn

Default:

""

removeMethod

String removeMethod

Default:

""

removeParameterFqn

String removeParameterFqn

Default:

""

typeParameter

String typeParameter

Specifies name of the type parameter for the component that is provided by the property.
The actual class for the type parameter can be resolved for the following property types: StudioPropertyType.ENTITY_CLASS, StudioPropertyType.ENUM_CLASS, StudioPropertyType.COMPONENT_REF, StudioPropertyType.PROPERTY_REF, StudioPropertyType.DATA_CONTAINER_REF, StudioPropertyType.COLLECTION_DATA_CONTAINER_REF

Returns:

name of the type parameter

Default:

""

useAsInjectionType

boolean useAsInjectionType

Use as type for injected field. Xml attribute value must be a valid class fqn.

Default:

false

componentRefTags

String[] componentRefTags

Specifies component tags that will be taken into account when searching for a reference (if type equals StudioPropertyType.COMPONENT_REF)

Default:

{}

cdataWrapperTag

String cdataWrapperTag

Specifies tag that Studio will use when setting a CDATA value (if type equals StudioPropertyType.CDATA).

By default, CDATA value will be set inside component tag (as nested subtag without tag name).

Default:

""