io.jmix.ui.meta

Annotation Type StudioProperty

@Documented
 @Target(value=METHOD)
public @interface StudioProperty

Indicates that the annotated method should be shown in Studio Screen Designer as UI component property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	caption
java.lang.String	category
java.lang.String	defaultValue
java.lang.String	description
java.lang.String	initialValue
java.lang.String	name
java.lang.String[]	options Context dependent list of options for the component property.
boolean	required
PropertyType	type
java.lang.String	typeParameter Specifies name of the type parameter for the generic UI component or Facet that is provided by the property. The actual class for the type parameter can be resolved for the following property types: PropertyType.JAVA_CLASS_NAME, PropertyType.ENTITY_CLASS, PropertyType.SCREEN_CLASS_NAME, PropertyType.DATACONTAINER_REF, PropertyType.COLLECTION_DATACONTAINER_REF, PropertyType.DATASOURCE_REF, PropertyType.COLLECTION_DATASOURCE_REF, PropertyType.COMPONENT_REF
java.lang.String	xmlAttribute
java.lang.String	xmlElement

Element Detail

name

public abstract java.lang.String name

Returns:

name of the property

Default:

""

type

public abstract PropertyType type

Returns:

type of property

Default:

io.jmix.ui.meta.PropertyType.AUTO

caption

public abstract java.lang.String caption

Returns:

caption of the property in Screen Designer Properties

Default:

""

description

public abstract java.lang.String description

Returns:

description of the property in Screen Designer Properties

Default:

""

category

public abstract java.lang.String category

Returns:

category of the property in Component Inspector, e.g. General, Size, Data

Default:

""

required

public abstract boolean required

Returns:

true if the property is required for component definition in XML

Default:

false

defaultValue

public abstract java.lang.String defaultValue

Returns:

default value of the property that can be safely omitted from XML

Default:

""

initialValue

public abstract java.lang.String initialValue

Returns:

the initial value of the property that will be added to the XML element when selected from the Component Palette

Default:

""

options

public abstract java.lang.String[] options

Context dependent list of options for the component property.

PropertyType.ENUMERATION: enumeration options. PropertyType.OPTIONS: non-strict list of possible options.
For the property types above: qualified name of the enum class can be specified with the "@link " prefix as a single option. In case it can't be inferred from method's parameter or return type. Example:

options = {"@link java.time.DayOfWeek"}

PropertyType.BEAN_REF: list of the allowed Spring bean base classes. PropertyType.COMPONENT_REF: list of the allowed component base classes. PropertyType.PROPERTY_PATH_REF: list of the allowed types for the property. Use registered Datatype names for the datatype properties or "to_one" and "to_many" for the association properties.

Returns:

options

Default:

{}

xmlAttribute

public abstract java.lang.String xmlAttribute

Returns:

target XML attribute name, if not set then equal to name of the property

Default:

""

xmlElement

public abstract java.lang.String xmlElement

Returns:

target XML element name

Default:

""

typeParameter

public abstract java.lang.String typeParameter

Specifies name of the type parameter for the generic UI component or Facet that is provided by the property.
The actual class for the type parameter can be resolved for the following property types: PropertyType.JAVA_CLASS_NAME, PropertyType.ENTITY_CLASS, PropertyType.SCREEN_CLASS_NAME, PropertyType.DATACONTAINER_REF, PropertyType.COLLECTION_DATACONTAINER_REF, PropertyType.DATASOURCE_REF, PropertyType.COLLECTION_DATASOURCE_REF, PropertyType.COMPONENT_REF

Returns:

name of the type parameter

Default:

""