org.mule.runtime.extension.api.annotation.param.display

Annotation Type Placement

@Target(value={PARAMETER,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface Placement

Defines the particular place of a Parameter field in the extension configuration window.

Since:

1.0

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ADVANCED Group or Tab name for parameters that are considered for advanced usage.
static String	CONNECTION Group or Tab name for parameters that are considered to be part of a connection configuration.
static int	DEFAULT_ORDER Parameter's default order.
static String	GENERAL Group or Tab name for parameters that are considered for general purposes.

Optional Element Summary

Optional Elements

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

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

Parameter's default order. Indicates that the order is not specified by the extension developer.

GENERAL

public static final String GENERAL

Group or Tab name for parameters that are considered for general purposes.

ADVANCED

public static final String ADVANCED

Group or Tab name for parameters that are considered for advanced usage.

CONNECTION

public static final String CONNECTION

Group or Tab name for parameters that are considered to be part of a connection configuration.

Element Detail

order

public abstract 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

group

public abstract String group

A group is a logical way to display one or more variables together. If no group is specified then a default group is assumed.

To place more than one element in the same group, use the exact same values for this attribute

Default:

""

tab

public abstract 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 GENERAL

Default:

"General"