io.jmix.ui.meta

Annotation Type StudioPropertiesItem

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

Indicates that the annotated method should be shown in Studio Screen Designer as UI component property. The corresponding XML element is property with name and value attributes:

 <properties>
     <property name="openMode" value="DIALOG"/>
 </properties>
 

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	name
java.lang.String[]	options
boolean	required
PropertyType	type

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:

""

options

public abstract java.lang.String[] options

Returns:

enumeration options

Default:

{}