Package io.jmix.ui.meta

Annotation Interface StudioPropertiesItem

@Documented @Target(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>

  • Element Details

    • name

      String name
      Returns:
      name of the property
      Default:
      ""

    • type

      PropertyType type
      Returns:
      type of property
      Default:
      AUTO

    • caption

      String caption
      Returns:
      caption of the property in Screen Designer Properties
      Default:
      ""

    • description

      String description
      Returns:
      description of the property in Screen Designer Properties
      Default:
      ""

    • category

      String category
      Returns:
      category of the property in Component Inspector, e.g. General, Size, Data
      Default:
      ""

    • required

      boolean required
      Returns:
      true if the property is required for component definition in XML
      Default:
      false

    • defaultValue

      String defaultValue
      Returns:
      default value of the property that can be safely omitted from XML
      Default:
      ""

    • options

      String[] options
      Returns:
      enumeration options
      Default:
      {}