org.broadleafcommerce.common.presentation

Annotation Type AdminPresentationMapFields

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface AdminPresentationMapFields

This annotation is used to describe an array of map fields that allow map members to be displayed as regular fields in the admin tool.

Author:

Jeff Fischer

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
AdminPresentationMapField[]	mapDisplayFields Members of this map can be displayed as form fields, rather than in a standard grid.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	toOneParentProperty Optional - if the intended map value is actually buried inside of a modelled join entity, specify the the path to that parent here.
String	toOneTargetProperty Optional - if the intended map value is actually buried inside of a modelled join entity, specify the the path to that value here.

Element Detail

mapDisplayFields

public abstract AdminPresentationMapField[] mapDisplayFields

Members of this map can be displayed as form fields, rather than in a standard grid. When populated, mapDisplayFields informs the form building process to create the fields described here and persist those fields in this map structure.

Returns:

the fields to display that represent the members of this map

toOneTargetProperty

public abstract String toOneTargetProperty

Optional - if the intended map value is actually buried inside of a modelled join entity, specify the the path to that value here. For example, SkuImpl.skuMedia uses SkuMediaXrefImpl, but the intended value is Media, so the toOneTargetProperty annotation param is "media". Note - only declare here if the field does not also have an AdminPresentationMap annotation already, which is the preferred location for declaring this value.

Returns:

the path to the intended map value field in the join entity

Default:

""

toOneParentProperty

public abstract String toOneParentProperty

Optional - if the intended map value is actually buried inside of a modelled join entity, specify the the path to that parent here. For example, SkuImpl.skuMedia uses SkuMediaXrefImpl, and the parent reference inside SkuMediaXrefImpl is to Sku, so the toOneParentProperty annotation param is "sku". Note - only declare here if the field does not also have an AdminPresentationMap annotation already, which is the preferred location for declaring this value.

Returns:

the path to the parent in the join entity

Default:

""