org.broadleafcommerce.common.presentation
Annotation Type AdminPresentationMapField

public @interface AdminPresentationMapField

This annotation is used to describe a member of a Map structure that should be displayed as a regular field in the admin tool.

Author:

Jeff Fischer

Required Element Summary

AdminPresentationMapKey	fieldName Represents the field name for this field.
AdminPresentation	fieldPresentation Represents the metadata for this field.

Optional Element Summary

Class<?>

targetClass Optional - if the Map structure is using generics, then the system can usually infer the concrete type for the Map value.

Element Detail

fieldName

public abstract AdminPresentationMapKey fieldName

Represents the field name for this field. The keyName property of AdminPresentationMapKey will be used as the field name in the admin form, as well as the key value for the Map structure. The friendlyKeyName property of AdminPresentationKey will be used as the display name for the field in the admin tool form.

Returns:

the name and friendly name for this field

fieldPresentation

public abstract AdminPresentation fieldPresentation

Represents the metadata for this field. The AdminPresentation properties will be used by the system to determine how this field should be treated in the admin tool (e.g. date fields get a date picker in the UI)

Returns:

the descriptive metadata for this field

targetClass

public abstract Class<?> targetClass

Optional - if the Map structure is using generics, then the system can usually infer the concrete type for the Map value. However, if not using generics for the Map, or if the value cannot be clearly inferred, you can explicitly set the Map structure value type here.

Returns:

the concrete type for the Map structure value

Default:

java.lang.Void.class