EntityForm (BroadleafCommerce Open Admin Platform 5.2.9-GA API)

java.lang.Object
- org.broadleafcommerce.openadmin.web.form.entity.EntityForm

```
public class EntityForm
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<EntityFormAction>`	`actions`
`protected Map<String,Object>`	`attributes`
`protected String`	`ceilingEntityClassname`
`static Integer`	`DEFAULT_COLUMN`
`static String`	`DEFAULT_GROUP_NAME`
`static Integer`	`DEFAULT_GROUP_ORDER`
`static String`	`DEFAULT_TAB_NAME`
`static Integer`	`DEFAULT_TAB_ORDER`
`protected Map<String,DynamicEntityFormInfo>`	`dynamicFormInfos`
`protected Map<String,EntityForm>`	`dynamicForms`
`protected String`	`encType`
`protected String`	`entityType`
`protected Map<String,Field>`	`fields`
`static String`	`HIDDEN_GROUP`
`protected String`	`id`
`protected String`	`idProperty`
`protected String`	`jsErrorMap` a string representation of a Javascript object containing a map of fields => errors Useful when filling a translation form, as the (only) way to determine to which fields error messaging needs to be attached
`protected static org.apache.commons.logging.Log`	`LOG`
`protected String`	`mainEntityName`
`static String`	`MAP_KEY_GROUP`
`protected String`	`parentId`
`protected Boolean`	`preventSubmit` special member used for only for a Translation entity form.
`protected Boolean`	`readOnly`
`protected List<SectionCrumb>`	`sectionCrumbs`
`protected String`	`sectionKey`
`protected TreeSet<Tab>`	`tabs`
`protected String`	`translationCeilingEntity`
`protected String`	`translationId`

Constructor Summary

Constructors
Constructor and Description

EntityForm()

Constructors
Constructor and Description
`EntityForm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(EntityFormAction action)`
`void`	`addAction(int position, EntityFormAction action)` Uses a zero based position.
`void`	`addField(ClassMetadata cmd, Field field)`
`void`	`addField(ClassMetadata cmd, Field field, String groupName, Integer groupOrder, String tabName, Integer tabOrder)`
`void`	`addGroupFromGroupMetadata(GroupMetadata groupMetadata, String unprocessedTabName)`
`void`	`addHiddenField(ClassMetadata cmd, Field field)`
`void`	`addListGrid(ClassMetadata cmd, ListGrid listGrid, String tabName, Integer tabOrder, String groupName, boolean isTabPresent)`
`void`	`addMapKeyField(ClassMetadata cmd, Field field)`
`String`	`addTabFromTabMetadata(TabMetadata tabMetadata)`
`void`	`clearFieldsMap()` Clears out the cached 'fields' variable which is used to render the form on the frontend.
`FieldGroup`	`collapseToOneFieldGroup()`
`EntityFormAction`	`findActionById(String id)`
`Field`	`findField(String fieldName)`
`FieldGroup`	`findGroup(String groupName)`
`ListGrid`	`findListGrid(String collectionFieldName)` Convenience method for grabbing a grid by its collection field name.
`Tab`	`findTab(String tabKey)`
`Tab`	`findTabForField(String fieldName)`
`List<EntityFormAction>`	`getActions()`
`List<ListGrid>`	`getAllListGrids()`
`Map<String,Object>`	`getAttributes()`
`String`	`getCeilingEntityClassname()`
`EntityForm`	`getDynamicForm(String name)`
`DynamicEntityFormInfo`	`getDynamicFormInfo(String name)`
`Map<String,DynamicEntityFormInfo>`	`getDynamicFormInfos()`
`Map<String,EntityForm>`	`getDynamicForms()`
`String`	`getEncType()`
`String`	`getEntityType()`
`Map<String,Field>`	`getFields()`
`String`	`getId()`
`String`	`getIdProperty()`
`String`	`getJsErrorMap()`
`String`	`getMainEntityName()`
`String`	`getParentId()`
`Boolean`	`getPreventSubmit()`
`Boolean`	`getReadOnly()`
`String`	`getSectionCrumbs()`
`List<SectionCrumb>`	`getSectionCrumbsImpl()`
`String`	`getSectionKey()`
`Set<Tab>`	`getTabs()`
`String`	`getTranslationCeilingEntity()`
`String`	`getTranslationId()`
`void`	`putDynamicForm(String name, EntityForm ef)`
`void`	`putDynamicFormInfo(String name, DynamicEntityFormInfo info)`
`void`	`removeAction(EntityFormAction action)`
`void`	`removeAllActions()`
`Field`	`removeField(String fieldName)`
`void`	`removeGroup(FieldGroup group)`
`ListGrid`	`removeListGrid(String subCollectionFieldName)`
`void`	`removeTab(String tabName)`
`void`	`removeTab(Tab tab)`
`String`	`sanitizeFieldName(String fieldName)` Since this field name could come from the frontend (where all fields are referenced like fields[name].value, we need to strip that part out to look up the real field name in this entity
`void`	`setActions(List<EntityFormAction> actions)`
`void`	`setAttributes(Map<String,Object> attributes)`
`void`	`setCeilingEntityClassname(String ceilingEntityClassname)`
`void`	`setDynamicFormInfos(Map<String,DynamicEntityFormInfo> dynamicFormInfos)`
`void`	`setDynamicForms(Map<String,EntityForm> dynamicForms)`
`void`	`setEncType(String encType)` Changes the encoding type on the built `<form>`
`void`	`setEntityType(String entityType)`
`void`	`setId(String id)`
`void`	`setIdProperty(String idProperty)`
`void`	`setJsErrorMap(String jsErrorMap)`
`void`	`setMainEntityName(String mainEntityName)`
`void`	`setParentId(String parentId)`
`void`	`setPreventSubmit()`
`void`	`setReadOnly()`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setSectionCrumbsImpl(List<SectionCrumb> sectionCrumbs)`
`void`	`setSectionKey(String sectionKey)`
`void`	`setTabs(Set<Tab> tabs)`
`void`	`setTranslationCeilingEntity(String translationCeilingEntity)`
`void`	`setTranslationId(String translationId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

HIDDEN_GROUP

public static final String HIDDEN_GROUP

See Also:: Constant Field Values

MAP_KEY_GROUP

public static final String MAP_KEY_GROUP

See Also:: Constant Field Values

DEFAULT_GROUP_NAME

public static final String DEFAULT_GROUP_NAME

See Also:: Constant Field Values

DEFAULT_GROUP_ORDER

public static final Integer DEFAULT_GROUP_ORDER

DEFAULT_COLUMN

public static final Integer DEFAULT_COLUMN

DEFAULT_TAB_NAME

public static final String DEFAULT_TAB_NAME

See Also:: Constant Field Values

DEFAULT_TAB_ORDER

public static final Integer DEFAULT_TAB_ORDER

id
```
protected String id
```

parentId
```
protected String parentId
```

idProperty
```
protected String idProperty
```

ceilingEntityClassname

protected String ceilingEntityClassname

entityType
```
protected String entityType
```

mainEntityName
```
protected String mainEntityName
```

sectionKey
```
protected String sectionKey
```

encType
```
protected String encType
```

readOnly
```
protected Boolean readOnly
```

preventSubmit
```
protected Boolean preventSubmit
```
special member used for only for a Translation entity form. Set at the controller, in order to populate a hidden field in the form indicating that there were errors and the form should not be allowed to submit.

jsErrorMap
```
protected String jsErrorMap
```
a string representation of a Javascript object containing a map of fields => errors Useful when filling a translation form, as the (only) way to determine to which fields error messaging needs to be attached

translationCeilingEntity

protected String translationCeilingEntity

translationId
```
protected String translationId
```

tabs
```
protected TreeSet<Tab> tabs
```

sectionCrumbs

protected List<SectionCrumb> sectionCrumbs

fields
```
protected Map<String,Field> fields
```

dynamicForms

protected Map<String,EntityForm> dynamicForms

dynamicFormInfos

protected Map<String,DynamicEntityFormInfo> dynamicFormInfos

actions

protected List<EntityFormAction> actions

attributes

protected Map<String,Object> attributes

Constructor Detail
- EntityForm
```
public EntityForm()
```

Method Detail

getFields
```
public Map<String,Field> getFields()
```
Returns:

a flattened, field name keyed representation of all of the fields in all of the groups for this form. This set will also includes all of the dynamic form fields. Note that if there collisions between the dynamic form fields and the fields on this form (meaning that they have the same name), then the dynamic form field will be excluded from the map and the preference will be given to first-level entities

See Also:

#getFields(boolean)}

clearFieldsMap
```
public void clearFieldsMap()
```
Clears out the cached 'fields' variable which is used to render the form on the frontend. Use this method if you want to force the entityForm to rebuild itself based on the tabs and groups that have been assigned and populated

getAllListGrids

public List<ListGrid> getAllListGrids()

findListGrid
```
public ListGrid findListGrid(String collectionFieldName)
```
Convenience method for grabbing a grid by its collection field name. This is very similar to findField(String) but differs in that this only searches through the sub collections for the current entity

Parameters:

collectionFieldName - the field name of the collection on the top-level entity

Returns:

findGroup

public FieldGroup findGroup(String groupName)

findTab
```
public Tab findTab(String tabKey)
```

findTabForField

public Tab findTabForField(String fieldName)

findField

public Field findField(String fieldName)

sanitizeFieldName
```
public String sanitizeFieldName(String fieldName)
```
Since this field name could come from the frontend (where all fields are referenced like fields[name].value, we need to strip that part out to look up the real field name in this entity

Parameters:

fieldName -

Returns:

removeField

public Field removeField(String fieldName)

removeGroup

public void removeGroup(FieldGroup group)

removeTab
```
public void removeTab(Tab tab)
```

removeTab

public void removeTab(String tabName)

removeListGrid

public ListGrid removeListGrid(String subCollectionFieldName)

addHiddenField

public void addHiddenField(ClassMetadata cmd,
                           Field field)

addField

public void addField(ClassMetadata cmd,
                     Field field)

addMapKeyField

public void addMapKeyField(ClassMetadata cmd,
                           Field field)

addField

public void addField(ClassMetadata cmd,
                     Field field,
                     String groupName,
                     Integer groupOrder,
                     String tabName,
                     Integer tabOrder)

addListGrid

public void addListGrid(ClassMetadata cmd,
                        ListGrid listGrid,
                        String tabName,
                        Integer tabOrder,
                        String groupName,
                        boolean isTabPresent)

addAction

public void addAction(int position,
                      EntityFormAction action)

Uses a zero based position. Use 0 to add to the top of the list.

Parameters:: position -; action -

addAction

public void addAction(EntityFormAction action)

removeAction

public void removeAction(EntityFormAction action)

removeAllActions
```
public void removeAllActions()
```

getDynamicForm

public EntityForm getDynamicForm(String name)

putDynamicForm

public void putDynamicForm(String name,
                           EntityForm ef)

getDynamicFormInfo

public DynamicEntityFormInfo getDynamicFormInfo(String name)

putDynamicFormInfo

public void putDynamicFormInfo(String name,
                               DynamicEntityFormInfo info)

getReadOnly
```
public Boolean getReadOnly()
```

getPreventSubmit
```
public Boolean getPreventSubmit()
```

setPreventSubmit
```
public void setPreventSubmit()
```

setReadOnly
```
public void setReadOnly()
```

setReadOnly

public void setReadOnly(boolean readOnly)

getActions

public List<EntityFormAction> getActions()

findActionById

public EntityFormAction findActionById(String id)

collapseToOneFieldGroup

public FieldGroup collapseToOneFieldGroup()

getTranslationCeilingEntity

public String getTranslationCeilingEntity()

setTranslationCeilingEntity

public void setTranslationCeilingEntity(String translationCeilingEntity)

getTranslationId
```
public String getTranslationId()
```

setTranslationId

public void setTranslationId(String translationId)

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getParentId
```
public String getParentId()
```

setParentId

public void setParentId(String parentId)

getIdProperty
```
public String getIdProperty()
```

setIdProperty

public void setIdProperty(String idProperty)

getCeilingEntityClassname

public String getCeilingEntityClassname()

setCeilingEntityClassname

public void setCeilingEntityClassname(String ceilingEntityClassname)

getEntityType
```
public String getEntityType()
```

setEntityType

public void setEntityType(String entityType)

getMainEntityName
```
public String getMainEntityName()
```

setMainEntityName

public void setMainEntityName(String mainEntityName)

getEncType
```
public String getEncType()
```

setEncType
```
public void setEncType(String encType)
```
Changes the encoding type on the built <form>

getSectionKey
```
public String getSectionKey()
```

setSectionKey

public void setSectionKey(String sectionKey)

getTabs
```
public Set<Tab> getTabs()
```

setTabs
```
public void setTabs(Set<Tab> tabs)
```

getDynamicForms

public Map<String,EntityForm> getDynamicForms()

setDynamicForms

public void setDynamicForms(Map<String,EntityForm> dynamicForms)

getDynamicFormInfos

public Map<String,DynamicEntityFormInfo> getDynamicFormInfos()

setDynamicFormInfos

public void setDynamicFormInfos(Map<String,DynamicEntityFormInfo> dynamicFormInfos)

setActions

public void setActions(List<EntityFormAction> actions)

getSectionCrumbsImpl

public List<SectionCrumb> getSectionCrumbsImpl()

setSectionCrumbsImpl

public void setSectionCrumbsImpl(List<SectionCrumb> sectionCrumbs)

getSectionCrumbs
```
public String getSectionCrumbs()
```

getAttributes

public Map<String,Object> getAttributes()

setAttributes

public void setAttributes(Map<String,Object> attributes)

getJsErrorMap
```
public String getJsErrorMap()
```

setJsErrorMap

public void setJsErrorMap(String jsErrorMap)

addTabFromTabMetadata

public String addTabFromTabMetadata(TabMetadata tabMetadata)

addGroupFromGroupMetadata

public void addGroupFromGroupMetadata(GroupMetadata groupMetadata,
                                      String unprocessedTabName)

Class EntityForm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

HIDDEN_GROUP

MAP_KEY_GROUP

DEFAULT_GROUP_NAME

DEFAULT_GROUP_ORDER

DEFAULT_COLUMN

DEFAULT_TAB_NAME

DEFAULT_TAB_ORDER

id

parentId

idProperty

ceilingEntityClassname

entityType

mainEntityName

sectionKey

encType

readOnly

preventSubmit

jsErrorMap

translationCeilingEntity

translationId

tabs

sectionCrumbs

fields

dynamicForms

dynamicFormInfos

actions

attributes

Constructor Detail

EntityForm

Method Detail

getFields

clearFieldsMap

getAllListGrids

findListGrid

findGroup

findTab

findTabForField

findField

sanitizeFieldName

removeField

removeGroup

removeTab

removeTab

removeListGrid

addHiddenField

addField

addMapKeyField

addField

addListGrid

addAction

addAction

removeAction

removeAllActions

getDynamicForm

putDynamicForm

getDynamicFormInfo

putDynamicFormInfo

getReadOnly

getPreventSubmit

setPreventSubmit

setReadOnly

setReadOnly

getActions

findActionById

collapseToOneFieldGroup

getTranslationCeilingEntity

setTranslationCeilingEntity

getTranslationId

setTranslationId

getId

setId

getParentId

setParentId