Package io.jmix.flowui.kit.meta

Annotation Interface StudioProperty

@Documented @Target(TYPE_PARAMETER) public @interface StudioProperty

  • Element Details

    • classFqn

      String classFqn
      Fully-qualified name of property class
      Default:
      ""

    • name

      String name
      Default:
      ""

    • required

      boolean required
      Default:
      false

    • defaultValue

      String defaultValue
      Default:
      ""

    • defaultValueRef

      String defaultValueRef
      Describes an element whose default property value should be used as the default value for the current property.

      Supported syntax:
      1. parent:someParentProperty - where someParentProperty should be replaced with property name. For example: parent:sortable
      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:
      {}