Package io.jmix.ui.meta

Annotation Interface StudioProperty

@Documented @Target(METHOD) public @interface StudioProperty
Indicates that the annotated method should be shown in Studio Screen Designer as UI component property.

  • 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:
      ""

    • initialValue

      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

      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

      String xmlAttribute
      Returns:
      target XML attribute name, if not set then equal to name of the property
      Default:
      ""

    • xmlElement

      String xmlElement
      Returns:
      target XML element name
      Default:
      ""

    • typeParameter

      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:
      ""