Module org.mule.sdk.api
Package org.mule.sdk.api.annotation.param.display

Annotation Interface Placement

@Target({PARAMETER,FIELD}) @Retention(RUNTIME) @Documented @MinMuleVersion("4.5.0") public @interface Placement
Defines the particular place of a Parameter field in the extension configuration window.
Since:
1.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    order
    Gives the annotated element a relative order within its group.
    String
    tab
    A tab is a logical way to groups together.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADVANCED_TAB
    Tab name for parameters that are considered for advanced usage.
    static final String
    CONNECTION_TAB
    Tab name for parameters that are considered to be part of a connection configuration.
    static final int
    DEFAULT_ORDER
    Parameter's default order.
    static final String
    DEFAULT_TAB
     
    static final String
    SECURITY_TAB
     

  • Field Details

    • DEFAULT_ORDER

      static final int DEFAULT_ORDER
      Parameter's default order. Indicates that the order is not specified by the extension developer.
      See Also:

    • ADVANCED_TAB

      static final String ADVANCED_TAB
      Tab name for parameters that are considered for advanced usage.
      See Also:

    • CONNECTION_TAB

      static final String CONNECTION_TAB
      Tab name for parameters that are considered to be part of a connection configuration.
      See Also:

    • SECURITY_TAB

      static final String SECURITY_TAB
      See Also:

    • DEFAULT_TAB

      static final String DEFAULT_TAB
      See Also:

  • Element Details

    • order

      int order
      Gives the annotated element a relative order within its group. The value provided may be repeated and in that case the order is not guaranteed.

      The value is relative meaning that the element with order 10 is on top than one with value 25.

      Default:
      -1

    • tab

      String tab
      A tab is a logical way to groups together. This attributes specifies the name of the tab in which the annotated element should be displayed. If no tab is specified then a default tab is assumed.

      To display more than one parameter or field in the same the tab then this value should be exactly the same for all of them.

      By default the value is DEFAULT_TAB

      Default:
      "General"