org.broadleafcommerce.common.presentation

Annotation Type AdminPresentationClass

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface AdminPresentationClass

Author:

jfischer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	ceilingDisplayEntity Specify the fully qualified class name of the ceiling entity for this inheritance hierarchy.
boolean	excludeFromPolymorphism Specify whether or not this class should be excluded from admin detection as a polymorphic type.
String	friendlyName The friendly name to present to a user for this field in a GUI.
AdminGroupPresentationOverride[]	groupOverrides These AdminGroupPresentationOverride items override a superclass' group information by targeting the superclass' tab, group, and the property to be overridden
PopulateToOneFieldsEnum	populateToOneFields Specify whether or not the open admin module persistence mechanism should traverse ManyToOne or OneToOne field boundaries in the entity when retrieving and populating field values.
AdminTabPresentationOverride[]	tabOverrides These AdminTabPresentationOverride items override a superclass' tab information by targeting the superclass' tab and the property to be overridden
AdminTabPresentation[]	tabs These AdminTabPresentation items define each tab that will be displayed in the entity's EntityForm.

Element Detail

populateToOneFields

public abstract PopulateToOneFieldsEnum populateToOneFields

Specify whether or not the open admin module persistence mechanism should traverse ManyToOne or OneToOne field boundaries in the entity when retrieving and populating field values.

Returns:

whether or not to populate ManyToOne or OneToOne fields

Default:

org.broadleafcommerce.common.presentation.PopulateToOneFieldsEnum.NOT_SPECIFIED

friendlyName

public abstract String friendlyName

The friendly name to present to a user for this field in a GUI. If supporting i18N, the friendly name may be a key to retrieve a localized friendly name using the GWT support for i18N. This name will be presented to users when they add a new entity in the GUI and select the polymorphic type for that new added entity.

Returns:

the friendly name

Default:

""

ceilingDisplayEntity

public abstract String ceilingDisplayEntity

Specify the fully qualified class name of the ceiling entity for this inheritance hierarchy. This value affects the list of polymorphic types presented to the administrative user in the admin UI. By specifying a class lower in the inheritance hierarchy, you can cause only a subset of the entire JPA inheritance hierarchy to be presented to the user as options when creating new entities. This value will override any previous settings for this inheritance hierarchy.

Returns:

the fully qualified classname of the new top-level member of this inheritance hierarchy to be displayed to the admin user

Default:

""

excludeFromPolymorphism

public abstract boolean excludeFromPolymorphism

Specify whether or not this class should be excluded from admin detection as a polymorphic type. This is useful if you have several entities that implement an interface, but you only want the admin to ignore one of the entities as a valid type for the interface.

Returns:

Whether or not the admin should ignore this entity as a valid polymorphic type

Default:

false

tabs

public abstract AdminTabPresentation[] tabs

These AdminTabPresentation items define each tab that will be displayed in the entity's EntityForm.

Returns:

the tabs for the entity's EntityForm

Default:

{}

tabOverrides

public abstract AdminTabPresentationOverride[] tabOverrides

These AdminTabPresentationOverride items override a superclass' tab information by targeting the superclass' tab and the property to be overridden

Returns:

the tab overrides for the entity's EntityForm

Default:

{}

groupOverrides

public abstract AdminGroupPresentationOverride[] groupOverrides

These AdminGroupPresentationOverride items override a superclass' group information by targeting the superclass' tab, group, and the property to be overridden

Returns:

the group overrides for the entity's EntityForm

Default:

{}