Field (BroadleafCommerce Open Admin Platform 4.1.3-GA API)

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

Direct Known Subclasses:

CodeField, ComboField, MediaField, RuleBuilderField
```
public class Field
extends Object
```
Author:

Andre Azzolini (apazzolini)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALTERNATE_ORDERING`
`protected Map<String,Object>`	`attributes`
`protected String`	`columnWidth`
`protected String`	`displayValue`
`protected String`	`fieldComponentRenderer`
`protected String`	`fieldType`
`protected String`	`foreignKeyClass`
`protected String`	`foreignKeyDisplayValueProperty`
`protected String`	`friendlyName`
`protected String`	`help`
`protected String`	`hint`
`protected String`	`idOverride`
`protected Boolean`	`isAlternateOrdering`
`protected Boolean`	`isDerived`
`protected Boolean`	`isDirty`
`protected Boolean`	`isDisabled`
`protected Boolean`	`isFilterSortDisabled`
`protected Boolean`	`isLargeEntry`
`protected Boolean`	`isMainEntityLink`
`protected Boolean`	`isReadOnly`
`protected Boolean`	`isResizeDisabled`
`protected Boolean`	`isTranslatable`
`protected Boolean`	`isTypeaheadEnabled`
`protected Boolean`	`isVisible`
`protected String`	`name`
`protected String`	`onChangeTrigger`
`protected Integer`	`order`
`protected String`	`owningEntityClass`
`protected Boolean`	`required`
`protected String`	`tooltip`
`protected String`	`translationFieldName`
`protected String`	`value`

Constructor Summary

Constructors
Constructor and Description

Field()

Constructors
Constructor and Description
`Field()`

Method Summary

Methods
Modifier and Type	Method and Description
`Boolean`	`getAlternateOrdering()`
`Object`	`getAttribute(String key)`
`Map<String,Object>`	`getAttributes()`
`boolean`	`getCanLinkToExternalEntity()` Used for linking in toOneLookup fields as well as linking to the entity via a 'name' field
`String`	`getColumnWidth()`
`Boolean`	`getDisabled()`
`String`	`getDisplayValue()`
`String`	`getEntityViewPath()` Used to build a link for this particular field value to be displayed in a modal.
`String`	`getFieldComponentRenderer()` Returns the component renderer for the field.
`String`	`getFieldType()`
`Boolean`	`getFilterSortDisabled()`
`String`	`getForeignKeyClass()`
`String`	`getForeignKeyDisplayValueProperty()`
`String`	`getFriendlyName()`
`String`	`getHelp()`
`String`	`getHint()`
`String`	`getIdOverride()`
`Boolean`	`getIsDerived()`
`Boolean`	`getIsDirty()`
`Boolean`	`getIsLargeEntry()`
`Boolean`	`getIsTypeaheadEnabled()`
`Boolean`	`getIsVisible()`
`Boolean`	`getMainEntityLink()`
`String`	`getName()`
`String`	`getOnChangeTrigger()`
`Integer`	`getOrder()`
`String`	`getOwningEntityClass()`
`String`	`getRawDisplayValue()`
`Boolean`	`getReadOnly()`
`Boolean`	`getRequired()`
`Boolean`	`getResizeDisabled()`
`String`	`getTooltip()`
`Boolean`	`getTranslatable()`
`String`	`getTranslationFieldName()`
`String`	`getValue()`
`boolean`	`isMasterField()`
`void`	`setAlternateOrdering(Boolean alternateOrdering)`
`void`	`setAttributes(Map<String,Object> attributes)`
`void`	`setColumnWidth(String columnWidth)`
`void`	`setDerived(Boolean isDerived)`
`void`	`setDirty(Boolean isDirty)`
`void`	`setDisabled(Boolean isDisabled)`
`void`	`setDisplayValue(String displayValue)`
`void`	`setFieldComponentRenderer(String fieldComponentRenderer)`
`void`	`setFieldType(String fieldType)`
`void`	`setFilterSortDisabled(Boolean isFilterSortDisabled)`
`void`	`setForeignKeyClass(String foreignKeyClass)`
`void`	`setForeignKeyDisplayValueProperty(String foreignKeyDisplayValueProperty)`
`void`	`setFriendlyName(String friendlyName)`
`void`	`setHelp(String help)`
`void`	`setHint(String hint)`
`void`	`setIdOverride(String idOverride)`
`void`	`setIsTypeaheadEnabled(Boolean isTypeaheadEnabled)`
`void`	`setIsVisible(Boolean isVisible)`
`void`	`setLargeEntry(Boolean isLargeEntry)`
`void`	`setMainEntityLink(Boolean isMainEntityLink)`
`void`	`setName(String name)`
`void`	`setOnChangeTrigger(String onChangeTrigger)`
`void`	`setOrder(Integer order)`
`void`	`setOwningEntityClass(String owningEntityClass)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setRequired(Boolean required)`
`void`	`setResizeDisabled(Boolean isResizeDisabled)`
`void`	`setTooltip(String tooltip)`
`void`	`setTranslatable(Boolean translatable)`
`void`	`setTranslationFieldName(String translationFieldName)`
`void`	`setValue(String value)`
`Field`	`withAlternateOrdering(Boolean alternateOrdering)`
`Field`	`withAttribute(String key, Object value)`
`Field`	`withColumnWidth(String columnWidth)`
`Field`	`withDerived(Boolean isDerived)`
`Field`	`withDisabled(Boolean isDisabled)`
`Field`	`withDisplayValue(String displayValue)`
`Field`	`withFieldComponentRenderer(String fieldComponentRenderer)`
`Field`	`withFieldType(String fieldType)`
`Field`	`withFilterSortDisabled(Boolean isFilterSortDisabled)`
`Field`	`withForeignKeyClass(String foreignKeyClass)`
`Field`	`withForeignKeyDisplayValueProperty(String foreignKeyDisplayValueProperty)`
`Field`	`withFriendlyName(String friendlyName)`
`Field`	`withHelp(String help)`
`Field`	`withHint(String hint)`
`Field`	`withIdOverride(String idOverride)`
`Field`	`withLargeEntry(Boolean isLargeEntry)`
`Field`	`withMainEntityLink(Boolean isMainEntityLink)`
`Field`	`withName(String name)`
`Field`	`withOrder(Integer order)`
`Field`	`withOwningEntityClass(String owningEntityClass)`
`Field`	`withReadOnly(Boolean isReadOnly)`
`Field`	`withRequired(Boolean required)`
`Field`	`withTooltip(String tooltip)`
`Field`	`withTranslatable(Boolean isTranslatable)`
`Field`	`withTranslationFieldName(String translationFieldName)`
`Field`	`withTypeaheadEnabled(Boolean isTypeaheadEnabled)`
`Field`	`withValue(String value)`

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

Field Detail

ALTERNATE_ORDERING

public static final String ALTERNATE_ORDERING

See Also:: Constant Field Values

name
```
protected String name
```

friendlyName
```
protected String friendlyName
```

fieldType
```
protected String fieldType
```

value
```
protected String value
```

displayValue
```
protected String displayValue
```

fieldComponentRenderer

protected String fieldComponentRenderer

foreignKeyDisplayValueProperty

protected String foreignKeyDisplayValueProperty

foreignKeyClass
```
protected String foreignKeyClass
```

owningEntityClass
```
protected String owningEntityClass
```

idOverride
```
protected String idOverride
```

order
```
protected Integer order
```

onChangeTrigger
```
protected String onChangeTrigger
```

required
```
protected Boolean required
```

columnWidth
```
protected String columnWidth
```

isVisible
```
protected Boolean isVisible
```

isAlternateOrdering
```
protected Boolean isAlternateOrdering
```

isReadOnly
```
protected Boolean isReadOnly
```

isDisabled
```
protected Boolean isDisabled
```

isTranslatable
```
protected Boolean isTranslatable
```

isMainEntityLink
```
protected Boolean isMainEntityLink
```

isFilterSortDisabled
```
protected Boolean isFilterSortDisabled
```

isResizeDisabled
```
protected Boolean isResizeDisabled
```

isDerived
```
protected Boolean isDerived
```

isLargeEntry
```
protected Boolean isLargeEntry
```

isDirty
```
protected Boolean isDirty
```

isTypeaheadEnabled
```
protected Boolean isTypeaheadEnabled
```

hint
```
protected String hint
```

tooltip
```
protected String tooltip
```

help
```
protected String help
```

translationFieldName
```
protected String translationFieldName
```

attributes

protected Map<String,Object> attributes

Constructor Detail
- Field
```
public Field()
```

Method Detail

withName
```
public Field withName(String name)
```

withFriendlyName

public Field withFriendlyName(String friendlyName)

withFieldType

public Field withFieldType(String fieldType)

withFieldComponentRenderer

public Field withFieldComponentRenderer(String fieldComponentRenderer)

withValue
```
public Field withValue(String value)
```

withDisplayValue

public Field withDisplayValue(String displayValue)

withForeignKeyDisplayValueProperty

public Field withForeignKeyDisplayValueProperty(String foreignKeyDisplayValueProperty)

withForeignKeyClass

public Field withForeignKeyClass(String foreignKeyClass)

withOwningEntityClass

public Field withOwningEntityClass(String owningEntityClass)

withIdOverride

public Field withIdOverride(String idOverride)

withOrder

public Field withOrder(Integer order)

withAlternateOrdering

public Field withAlternateOrdering(Boolean alternateOrdering)

withRequired

public Field withRequired(Boolean required)

withColumnWidth

public Field withColumnWidth(String columnWidth)

withReadOnly

public Field withReadOnly(Boolean isReadOnly)

withDisabled

public Field withDisabled(Boolean isDisabled)

withTranslatable

public Field withTranslatable(Boolean isTranslatable)

withMainEntityLink

public Field withMainEntityLink(Boolean isMainEntityLink)

withFilterSortDisabled

public Field withFilterSortDisabled(Boolean isFilterSortDisabled)

withDerived

public Field withDerived(Boolean isDerived)

withLargeEntry

public Field withLargeEntry(Boolean isLargeEntry)

withHint
```
public Field withHint(String hint)
```

withHelp
```
public Field withHelp(String help)
```

withTooltip

public Field withTooltip(String tooltip)

withAttribute

public Field withAttribute(String key,
                  Object value)

withTypeaheadEnabled

public Field withTypeaheadEnabled(Boolean isTypeaheadEnabled)

withTranslationFieldName

public Field withTranslationFieldName(String translationFieldName)

getIsVisible
```
public Boolean getIsVisible()
```

setColumnWidth

public void setColumnWidth(String columnWidth)

getDisplayValue
```
public String getDisplayValue()
```

getRawDisplayValue
```
public String getRawDisplayValue()
```

getEntityViewPath
```
public String getEntityViewPath()
```
Used to build a link for this particular field value to be displayed in a modal. This is used to build the link for a 'to-one-lookup' field.

getCanLinkToExternalEntity
```
public boolean getCanLinkToExternalEntity()
```
Used for linking in toOneLookup fields as well as linking to the entity via a 'name' field

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

getDisabled
```
public Boolean getDisabled()
```

getAlternateOrdering
```
public Boolean getAlternateOrdering()
```

getTranslatable
```
public Boolean getTranslatable()
```

getMainEntityLink
```
public Boolean getMainEntityLink()
```

getFilterSortDisabled

public Boolean getFilterSortDisabled()

getResizeDisabled
```
public Boolean getResizeDisabled()
```

getAttribute

public Object getAttribute(String key)

getIsTypeaheadEnabled

public Boolean getIsTypeaheadEnabled()

getTranslationFieldName

public String getTranslationFieldName()

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getFriendlyName
```
public String getFriendlyName()
```

setFriendlyName

public void setFriendlyName(String friendlyName)

getFieldType
```
public String getFieldType()
```

setFieldType

public void setFieldType(String fieldType)

getFieldComponentRenderer
```
public String getFieldComponentRenderer()
```
Returns the component renderer for the field. Defaults to the fieldType unless otherwise set.

Returns:
String

setFieldComponentRenderer

public void setFieldComponentRenderer(String fieldComponentRenderer)

getValue
```
public String getValue()
```

setValue
```
public void setValue(String value)
```

setDisplayValue

public void setDisplayValue(String displayValue)

getForeignKeyDisplayValueProperty

public String getForeignKeyDisplayValueProperty()

setForeignKeyDisplayValueProperty

public void setForeignKeyDisplayValueProperty(String foreignKeyDisplayValueProperty)

getIdOverride
```
public String getIdOverride()
```

setIdOverride

public void setIdOverride(String idOverride)

getOrder
```
public Integer getOrder()
```

setOrder
```
public void setOrder(Integer order)
```

getOnChangeTrigger
```
public String getOnChangeTrigger()
```

setOnChangeTrigger

public void setOnChangeTrigger(String onChangeTrigger)

getRequired
```
public Boolean getRequired()
```

setRequired

public void setRequired(Boolean required)

getColumnWidth
```
public String getColumnWidth()
```

setIsVisible

public void setIsVisible(Boolean isVisible)

setAlternateOrdering

public void setAlternateOrdering(Boolean alternateOrdering)

setReadOnly

public void setReadOnly(Boolean readOnly)

setDisabled

public void setDisabled(Boolean isDisabled)

setTranslatable

public void setTranslatable(Boolean translatable)

getForeignKeyClass
```
public String getForeignKeyClass()
```

setForeignKeyClass

public void setForeignKeyClass(String foreignKeyClass)

getOwningEntityClass
```
public String getOwningEntityClass()
```

setOwningEntityClass

public void setOwningEntityClass(String owningEntityClass)

setMainEntityLink

public void setMainEntityLink(Boolean isMainEntityLink)

setFilterSortDisabled

public void setFilterSortDisabled(Boolean isFilterSortDisabled)

setResizeDisabled

public void setResizeDisabled(Boolean isResizeDisabled)

getIsDerived
```
public Boolean getIsDerived()
```

setDerived

public void setDerived(Boolean isDerived)

getIsLargeEntry
```
public Boolean getIsLargeEntry()
```

setLargeEntry

public void setLargeEntry(Boolean isLargeEntry)

getIsDirty
```
public Boolean getIsDirty()
```

setDirty

public void setDirty(Boolean isDirty)

getHint
```
public String getHint()
```

setHint
```
public void setHint(String hint)
```

getTooltip
```
public String getTooltip()
```

setTooltip

public void setTooltip(String tooltip)

getHelp
```
public String getHelp()
```

setHelp
```
public void setHelp(String help)
```

getAttributes

public Map<String,Object> getAttributes()

setAttributes

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

setIsTypeaheadEnabled

public void setIsTypeaheadEnabled(Boolean isTypeaheadEnabled)

setTranslationFieldName

public void setTranslationFieldName(String translationFieldName)

isMasterField
```
public boolean isMasterField()
```

Class Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALTERNATE_ORDERING

name

friendlyName

fieldType

value

displayValue

fieldComponentRenderer

foreignKeyDisplayValueProperty

foreignKeyClass

owningEntityClass

idOverride

order

onChangeTrigger

required

columnWidth

isVisible

isAlternateOrdering

isReadOnly

isDisabled

isTranslatable

isMainEntityLink

isFilterSortDisabled

isResizeDisabled

isDerived

isLargeEntry

isDirty

isTypeaheadEnabled

hint

tooltip

help

translationFieldName

attributes

Constructor Detail

Field

Method Detail

withName

withFriendlyName

withFieldType

withFieldComponentRenderer

withValue

withDisplayValue

withForeignKeyDisplayValueProperty

withForeignKeyClass

withOwningEntityClass

withIdOverride

withOrder

withAlternateOrdering

withRequired

withColumnWidth

withReadOnly

withDisabled

withTranslatable

withMainEntityLink

withFilterSortDisabled

withDerived

withLargeEntry

withHint

withHelp

withTooltip

withAttribute

withTypeaheadEnabled

withTranslationFieldName

getIsVisible

setColumnWidth

getDisplayValue

getRawDisplayValue

getEntityViewPath

getCanLinkToExternalEntity

getReadOnly

getDisabled

getAlternateOrdering

getTranslatable

getMainEntityLink

getFilterSortDisabled