org.broadleafcommerce.openadmin.web.form.entity

Class Field

java.lang.Object

org.broadleafcommerce.openadmin.web.form.entity.Field

Direct Known Subclasses:

ComboField, MediaField, RuleBuilderField

public class Field
extends java.lang.Object

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALTERNATE_ORDERING
protected java.lang.String	columnWidth
protected java.lang.String	displayValue
protected java.lang.String	fieldType
protected java.lang.String	foreignKeyClass
protected java.lang.String	foreignKeyDisplayValueProperty
protected java.lang.String	friendlyName
protected java.lang.String	idOverride
protected java.lang.Boolean	isAlternateOrdering
protected java.lang.Boolean	isDerived
protected java.lang.Boolean	isFilterSortDisabled
protected java.lang.Boolean	isMainEntityLink
protected java.lang.Boolean	isReadOnly
protected java.lang.Boolean	isTranslatable
protected java.lang.Boolean	isVisible
protected java.lang.String	name
protected java.lang.String	onChangeTrigger
protected java.lang.Integer	order
protected java.lang.String	owningEntityClass
protected java.lang.Boolean	required
protected java.lang.String	value

Constructor Summary

Constructors

Constructor and Description
Field()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAlternateOrdering()
boolean	getCanLinkToExternalEntity() Used for linking in toOneLookup fields as well as linking to the entity via a 'name' field
java.lang.String	getColumnWidth()
java.lang.String	getDisplayValue()
java.lang.String	getEntityViewPath() Used to build a link for this particular field value to be displayed in a modal.
java.lang.String	getFieldType()
java.lang.Boolean	getFilterSortDisabled()
java.lang.String	getForeignKeyClass()
java.lang.String	getForeignKeyDisplayValueProperty()
java.lang.String	getFriendlyName()
java.lang.String	getIdOverride()
java.lang.Boolean	getIsDerived()
java.lang.Boolean	getIsVisible()
java.lang.Boolean	getMainEntityLink()
java.lang.String	getName()
java.lang.String	getOnChangeTrigger()
java.lang.Integer	getOrder()
java.lang.String	getOwningEntityClass()
java.lang.Boolean	getReadOnly()
java.lang.Boolean	getRequired()
java.lang.Boolean	getTranslatable()
java.lang.String	getValue()
void	setAlternateOrdering(java.lang.Boolean alternateOrdering)
void	setColumnWidth(java.lang.String columnWidth)
void	setDerived(java.lang.Boolean isDerived)
void	setDisplayValue(java.lang.String displayValue)
void	setFieldType(java.lang.String fieldType)
void	setFilterSortDisabled(java.lang.Boolean isFilterSortDisabled)
void	setForeignKeyClass(java.lang.String foreignKeyClass)
void	setForeignKeyDisplayValueProperty(java.lang.String foreignKeyDisplayValueProperty)
void	setFriendlyName(java.lang.String friendlyName)
void	setIdOverride(java.lang.String idOverride)
void	setIsVisible(java.lang.Boolean isVisible)
void	setMainEntityLink(java.lang.Boolean isMainEntityLink)
void	setName(java.lang.String name)
void	setOnChangeTrigger(java.lang.String onChangeTrigger)
void	setOrder(java.lang.Integer order)
void	setOwningEntityClass(java.lang.String owningEntityClass)
void	setReadOnly(java.lang.Boolean readOnly)
void	setRequired(java.lang.Boolean required)
void	setTranslatable(java.lang.Boolean translatable)
void	setValue(java.lang.String value)
Field	withAlternateOrdering(java.lang.Boolean alternateOrdering)
Field	withColumnWidth(java.lang.String columnWidth)
Field	withDerived(java.lang.Boolean isDerived)
Field	withDisplayValue(java.lang.String displayValue)
Field	withFieldType(java.lang.String fieldType)
Field	withFilterSortDisabled(java.lang.Boolean isFilterSortDisabled)
Field	withForeignKeyClass(java.lang.String foreignKeyClass)
Field	withForeignKeyDisplayValueProperty(java.lang.String foreignKeyDisplayValueProperty)
Field	withFriendlyName(java.lang.String friendlyName)
Field	withIdOverride(java.lang.String idOverride)
Field	withMainEntityLink(java.lang.Boolean isMainEntityLink)
Field	withName(java.lang.String name)
Field	withOrder(java.lang.Integer order)
Field	withOwningEntityClass(java.lang.String owningEntityClass)
Field	withReadOnly(java.lang.Boolean isReadOnly)
Field	withRequired(java.lang.Boolean required)
Field	withTranslatable(java.lang.Boolean isTranslatable)
Field	withValue(java.lang.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 java.lang.String ALTERNATE_ORDERING

See Also:

Constant Field Values

name

protected java.lang.String name

friendlyName

protected java.lang.String friendlyName

fieldType

protected java.lang.String fieldType

value

protected java.lang.String value

displayValue

protected java.lang.String displayValue

foreignKeyDisplayValueProperty

protected java.lang.String foreignKeyDisplayValueProperty

foreignKeyClass

protected java.lang.String foreignKeyClass

owningEntityClass

protected java.lang.String owningEntityClass

idOverride

protected java.lang.String idOverride

order

protected java.lang.Integer order

onChangeTrigger

protected java.lang.String onChangeTrigger

required

protected java.lang.Boolean required

columnWidth

protected java.lang.String columnWidth

isVisible

protected java.lang.Boolean isVisible

isAlternateOrdering

protected java.lang.Boolean isAlternateOrdering

isReadOnly

protected java.lang.Boolean isReadOnly

isTranslatable

protected java.lang.Boolean isTranslatable

isMainEntityLink

protected java.lang.Boolean isMainEntityLink

isFilterSortDisabled

protected java.lang.Boolean isFilterSortDisabled

isDerived

protected java.lang.Boolean isDerived

Constructor Detail

Field

public Field()

Method Detail

withName

public Field withName(java.lang.String name)

withFriendlyName

public Field withFriendlyName(java.lang.String friendlyName)

withFieldType

public Field withFieldType(java.lang.String fieldType)

withValue

public Field withValue(java.lang.String value)

withDisplayValue

public Field withDisplayValue(java.lang.String displayValue)

withForeignKeyDisplayValueProperty

public Field withForeignKeyDisplayValueProperty(java.lang.String foreignKeyDisplayValueProperty)

withForeignKeyClass

public Field withForeignKeyClass(java.lang.String foreignKeyClass)

withOwningEntityClass

public Field withOwningEntityClass(java.lang.String owningEntityClass)

withIdOverride

public Field withIdOverride(java.lang.String idOverride)

withOrder

public Field withOrder(java.lang.Integer order)

withAlternateOrdering

public Field withAlternateOrdering(java.lang.Boolean alternateOrdering)

withRequired

public Field withRequired(java.lang.Boolean required)

withColumnWidth

public Field withColumnWidth(java.lang.String columnWidth)

withReadOnly

public Field withReadOnly(java.lang.Boolean isReadOnly)

withTranslatable

public Field withTranslatable(java.lang.Boolean isTranslatable)

withMainEntityLink

public Field withMainEntityLink(java.lang.Boolean isMainEntityLink)

withFilterSortDisabled

public Field withFilterSortDisabled(java.lang.Boolean isFilterSortDisabled)

withDerived

public Field withDerived(java.lang.Boolean isDerived)

getIsVisible

public java.lang.Boolean getIsVisible()

setColumnWidth

public void setColumnWidth(java.lang.String columnWidth)

getDisplayValue

public java.lang.String getDisplayValue()

getEntityViewPath

public java.lang.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 java.lang.Boolean getReadOnly()

getAlternateOrdering

public java.lang.Boolean getAlternateOrdering()

getTranslatable

public java.lang.Boolean getTranslatable()

getMainEntityLink

public java.lang.Boolean getMainEntityLink()

getFilterSortDisabled

public java.lang.Boolean getFilterSortDisabled()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getFriendlyName

public java.lang.String getFriendlyName()

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

getFieldType

public java.lang.String getFieldType()

setFieldType

public void setFieldType(java.lang.String fieldType)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

setDisplayValue

public void setDisplayValue(java.lang.String displayValue)

getForeignKeyDisplayValueProperty

public java.lang.String getForeignKeyDisplayValueProperty()

setForeignKeyDisplayValueProperty

public void setForeignKeyDisplayValueProperty(java.lang.String foreignKeyDisplayValueProperty)

getIdOverride

public java.lang.String getIdOverride()

setIdOverride

public void setIdOverride(java.lang.String idOverride)

getOrder

public java.lang.Integer getOrder()

setOrder

public void setOrder(java.lang.Integer order)

getOnChangeTrigger

public java.lang.String getOnChangeTrigger()

setOnChangeTrigger

public void setOnChangeTrigger(java.lang.String onChangeTrigger)

getRequired

public java.lang.Boolean getRequired()

setRequired

public void setRequired(java.lang.Boolean required)

getColumnWidth

public java.lang.String getColumnWidth()

setIsVisible

public void setIsVisible(java.lang.Boolean isVisible)

setAlternateOrdering

public void setAlternateOrdering(java.lang.Boolean alternateOrdering)

setReadOnly

public void setReadOnly(java.lang.Boolean readOnly)

setTranslatable

public void setTranslatable(java.lang.Boolean translatable)

getForeignKeyClass

public java.lang.String getForeignKeyClass()

setForeignKeyClass

public void setForeignKeyClass(java.lang.String foreignKeyClass)

getOwningEntityClass

public java.lang.String getOwningEntityClass()

setOwningEntityClass

public void setOwningEntityClass(java.lang.String owningEntityClass)

setMainEntityLink

public void setMainEntityLink(java.lang.Boolean isMainEntityLink)

setFilterSortDisabled

public void setFilterSortDisabled(java.lang.Boolean isFilterSortDisabled)

getIsDerived

public java.lang.Boolean getIsDerived()

setDerived

public void setDerived(java.lang.Boolean isDerived)