io.wcm.caconfig.editor

Interface DropdownOptionProvider

@ConsumerType
public interface DropdownOptionProvider

Allows to provide a dynamic list of options. Implement as OSGi service and set a service property PROPERTY_SELECTOR which is used to reference the implementation in the context-aware configuration property metadata options.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_SELECTOR Name of OSGi property to distinguish different implementations of the provider.

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<DropdownOptionItem>	getDropdownOptions(@NotNull org.apache.sling.api.resource.Resource contextResource) Get dynamic list of dropdown items to available in the context-aware configuration editor.

Field Detail

PROPERTY_SELECTOR

static final java.lang.String PROPERTY_SELECTOR

Name of OSGi property to distinguish different implementations of the provider. The value that this property is set to has to be configured in the Context-Aware configuration property metadata using EditorProperties.PROPERTY_DROPDOWN_OPTIONS_PROVIDER.

See Also:

Constant Field Values

Method Detail

getDropdownOptions

@NotNull
@NotNull java.util.List<DropdownOptionItem> getDropdownOptions(@NotNull
                                                                        @NotNull org.apache.sling.api.resource.Resource contextResource)

Get dynamic list of dropdown items to available in the context-aware configuration editor.

Parameters:

contextResource - Context resource. This is usually the AEM page of the configuration editor

Returns:

List of dropdown items