org.hippoecm.hst.core.parameters

Annotation Type DropDownList

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface DropDownList

Indicates that the value of the annotated method should be selected from a drop-down list. The available options in the drop-down list are specified as an array of Strings.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	value Static list of options to show in the drop-down list.
Class<? extends ValueListProvider>	valueListProvider Deprecated. use valueListProviderKey instead. Dynamic value list provider class that can return a list of options to show in the drop-down list dynamically from any data sources. The selected option value is converted from a String to the return type
String	valueListProviderKey Dynamic value list provider key that can be used to get a ValueListProvider instance from the ValueListProviderService.

Element Detail

value

public abstract String[] value

Static list of options to show in the drop-down list. The selected option value is converted from a String to the return type of the annotated method.

Returns:

the options to show in the drop-down list.

Default:

{}

valueListProvider

@Deprecated
public abstract Class<? extends ValueListProvider> valueListProvider

Deprecated. use valueListProviderKey instead. Dynamic value list provider class that can return a list of options to show in the drop-down list dynamically from any data sources. The selected option value is converted from a String to the return type

Returns:

dynamic value list provider class that can return a list of options to show in the drop-down list dynamically from any data sources.

Default:

org.hippoecm.hst.core.parameters.EmptyValueListProvider.class

valueListProviderKey

public abstract String valueListProviderKey

Dynamic value list provider key that can be used to get a ValueListProvider instance from the ValueListProviderService. That instance will return a list of options to show in the drop-down list dynamically from any data sources. The selected option value is converted from a String to the return type of the annotated method.

Returns:

dynamic value list provider class that can return a list of options to show in the drop-down list dynamically from any data sources.

Default:

""