org.broadleafcommerce.common.presentation
Annotation Type AdminPresentation

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

Author:

jfischer

Optional Element Summary

String	broadleafEnumeration For fields with a SupportedFieldType of BROADLEAF_ENUMERATION, you must specify the fully qualified class name of the Broadleaf Enumeration here.
String	columnWidth Specify the column space this field will occupy in grid widgets.
boolean	excluded Specify if this field should be excluded from inclusion in the admin presentation layer
SupportedFieldType	fieldType Explicity specify the type the GUI should consider this field Specifying UNKNOWN will cause the system to make its best guess
String	friendlyName The friendly name to present to a user for this field in a GUI.
String	group Specify a GUI grouping for this field Fields in the same group will be visually grouped together in the GUI
boolean	groupCollapsed Specify whether a group is collapsed by default in the admin UI.
int	groupOrder Specify an order for this group.
boolean	largeEntry If the field is a string, specify that the GUI provide a text area
int	order The order in which this field will appear in a GUI relative to other fields from the same class
boolean	prominent Provide a hint to the GUI about the prominence of this field.
boolean	readOnly Explicityly specify whether or not this field is mutable.
RequiredOverride	requiredOverride Specify whether you would like the admin to require this field, even if it is not required by the ORM.
String	securityLevel If a security level is specified, it is registered with org.broadleafcommerce.openadmin.client.security.SecurityManager The SecurityManager checks the permission of the current user to determine if this field should be disabled based on the specified level.
ValidationConfiguration[]	validationConfigurations Specify the validation to use for this field in the admin, if any
VisibilityEnum	visibility Describes how the field is shown in admin GUI.

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.

Returns:

the friendly name

Default:

""

securityLevel

public abstract String securityLevel

If a security level is specified, it is registered with org.broadleafcommerce.openadmin.client.security.SecurityManager The SecurityManager checks the permission of the current user to determine if this field should be disabled based on the specified level.

Returns:

the security level

Default:

""

order

public abstract int order

The order in which this field will appear in a GUI relative to other fields from the same class

Returns:

the display order

Default:

99999

visibility

public abstract VisibilityEnum visibility

Describes how the field is shown in admin GUI.

Returns:

whether or not to hide the form field.

Default:

org.broadleafcommerce.common.presentation.client.VisibilityEnum.VISIBLE_ALL

fieldType

public abstract SupportedFieldType fieldType

Explicity specify the type the GUI should consider this field Specifying UNKNOWN will cause the system to make its best guess

Returns:

the field type

Default:

org.broadleafcommerce.common.presentation.client.SupportedFieldType.UNKNOWN

group

public abstract String group

Specify a GUI grouping for this field Fields in the same group will be visually grouped together in the GUI

Returns:

the group for this field

Default:

"General"

groupOrder

public abstract int groupOrder

Specify an order for this group. Groups will be sorted in the resulting form in ascending order based on this parameter.

Returns:

the order for this group

Default:

99999

groupCollapsed

public abstract boolean groupCollapsed

Specify whether a group is collapsed by default in the admin UI.

Returns:

whether or not the group is collapsed by default

Default:

false

largeEntry

public abstract boolean largeEntry

If the field is a string, specify that the GUI provide a text area

Returns:

is a text area field

Default:

false

prominent

public abstract boolean prominent

Provide a hint to the GUI about the prominence of this field. For example, prominent fields will show up as a column in any list grid in the admin that displays this entity.

Returns:

whether or not this is a prominent field

Default:

false

columnWidth

public abstract String columnWidth

Specify the column space this field will occupy in grid widgets. This value can be an absolute integer or a percentage. A value of "*" will make this field use up equally distributed space.

Returns:

the space utilized in grids for this field

Default:

"*"

broadleafEnumeration

public abstract String broadleafEnumeration

For fields with a SupportedFieldType of BROADLEAF_ENUMERATION, you must specify the fully qualified class name of the Broadleaf Enumeration here.

Returns:

Broadleaf enumeration class name

Default:

""

readOnly

public abstract boolean readOnly

Explicityly specify whether or not this field is mutable.

Returns:

whether or not this field is read only

Default:

false

validationConfigurations

public abstract ValidationConfiguration[] validationConfigurations

Specify the validation to use for this field in the admin, if any

Returns:

the configuration for the validation

Default:

{}

requiredOverride

public abstract RequiredOverride requiredOverride

Specify whether you would like the admin to require this field, even if it is not required by the ORM.

Returns:

the required override enumeration

Default:

org.broadleafcommerce.common.presentation.RequiredOverride.IGNORED

excluded

public abstract boolean excluded

Specify if this field should be excluded from inclusion in the admin presentation layer

Returns:

whether or not the field should be excluded

Default:

false