org.ofbiz.widget.form
Class ModelFormField

java.lang.Object
  org.ofbiz.widget.form.ModelFormField

public class ModelFormField
extends java.lang.Object

Widget Library - Form model class

Nested Class Summary

static class	ModelFormField.AutoComplete
static class	ModelFormField.CheckField
static class	ModelFormField.DateFindField
static class	ModelFormField.DateTimeField
static class	ModelFormField.DisplayEntityField
static class	ModelFormField.DisplayField
static class	ModelFormField.DropDownField
static class	ModelFormField.EntityOptions
static class	ModelFormField.FieldInfo
static class	ModelFormField.FieldInfoWithOptions
static class	ModelFormField.FileField
static class	ModelFormField.HiddenField
static class	ModelFormField.HyperlinkField
static class	ModelFormField.IgnoredField
static class	ModelFormField.ImageField
static class	ModelFormField.InPlaceEditor
static class	ModelFormField.ListOptions
static class	ModelFormField.LookupField
static class	ModelFormField.OptionSource
static class	ModelFormField.OptionValue
static class	ModelFormField.PasswordField
static class	ModelFormField.RadioField
static class	ModelFormField.RangeFindField
static class	ModelFormField.ResetField
static class	ModelFormField.SingleOption
static class	ModelFormField.SubHyperlink
static class	ModelFormField.SubmitField
static class	ModelFormField.TextareaField
static class	ModelFormField.TextField
static class	ModelFormField.TextFindField

Field Summary

protected FlexibleStringExpander	action
protected java.lang.String	attributeName
protected boolean	encodeOutput
protected java.lang.String	entityName
protected FlexibleMapAccessor<java.lang.Object>	entryAcsr
protected java.lang.String	event
protected ModelFormField.FieldInfo	fieldInfo
protected java.lang.String	fieldName
protected java.lang.String	headerLink
protected java.lang.String	headerLinkStyle
protected java.lang.String	idName
protected FlexibleMapAccessor<java.util.Map<java.lang.String,? extends java.lang.Object>>	mapAcsr
protected ModelForm	modelForm
static java.lang.String	module
protected java.lang.String	name
protected java.util.List<ModelForm.UpdateArea>	onChangeUpdateAreas On Change Event areas to be updated.
protected java.util.List<ModelForm.UpdateArea>	onClickUpdateAreas On Click Event areas to be updated.
protected java.lang.String	parameterName
protected java.lang.Integer	position
protected java.lang.String	redWhen
protected java.lang.Boolean	requiredField
protected java.lang.String	requiredFieldStyle
protected boolean	separateColumn
protected java.lang.String	serviceName
protected java.lang.Boolean	sortField
protected java.lang.String	sortFieldAscStyle
protected java.lang.String	sortFieldDescStyle
protected java.lang.String	sortFieldStyle
protected FlexibleStringExpander	title
protected java.lang.String	titleAreaStyle
protected java.lang.String	titleStyle
protected FlexibleStringExpander	tooltip
protected java.lang.String	tooltipStyle
protected FlexibleStringExpander	useWhen
protected java.lang.String	widgetAreaStyle
protected java.lang.String	widgetStyle

Constructor Summary

ModelFormField(org.w3c.dom.Element fieldElement, ModelForm modelForm)
XML Constructor

ModelFormField(ModelForm modelForm)
Default Constructor

Method Summary

protected void	addOnChangeUpdateArea(ModelForm.UpdateArea updateArea)
protected void	addOnClickUpdateArea(ModelForm.UpdateArea updateArea)
void	addOnEventUpdateArea(ModelForm.UpdateArea updateArea)
java.lang.String	getAction(java.util.Map<java.lang.String,java.lang.Object> context)
java.lang.String	getAttributeName() Gets the name of the Service Attribute (aka Parameter) that corresponds with this field.
boolean	getEncodeOutput()
java.lang.String	getEntityName()
java.lang.String	getEntry(java.util.Map<java.lang.String,java.lang.Object> context) Gets the entry from the context that corresponds to this field; if this form is being rendered in an error condition (ie isError in the context is true) then the value will be retreived from the parameters Map in the context.
java.lang.String	getEntry(java.util.Map<java.lang.String,java.lang.Object> context, java.lang.String defaultValue)
java.lang.String	getEntry(java.util.Map<java.lang.String,java.lang.Object> context, java.lang.String defaultValue, java.lang.String subControlName) Gets the entry from the context that corresponds to this field; if this form is being rendered in an error condition (ie isError in the context is true) then the value will be retrieved from the parameters Map in the context.
java.lang.String	getEntryName()
java.lang.String	getEvent()
ModelFormField.FieldInfo	getFieldInfo()
java.lang.String	getFieldName() Gets the name of the Entity Field that corresponds with this field.
java.lang.String	getHeaderLink()
java.lang.String	getHeaderLinkStyle()
java.lang.String	getIdName()
java.util.Map<java.lang.String,? extends java.lang.Object>	getMap(java.util.Map<java.lang.String,? extends java.lang.Object> context)
java.lang.String	getMapName() Get the name of the Map in the form context that contains the entry, available from the getEntryName() method.
ModelForm	getModelForm()
java.lang.String	getName()
java.util.List<ModelForm.UpdateArea>	getOnChangeUpdateAreas()
java.util.List<ModelForm.UpdateArea>	getOnClickUpdateAreas()
java.lang.String	getParameterName(java.util.Map<java.lang.String,java.lang.Object> context) Get the name to use for the parameter for this field in the form interpreter.
int	getPosition()
java.lang.String	getRedWhen()
boolean	getRequiredField()
java.lang.String	getRequiredFieldStyle()
boolean	getSeparateColumn()
java.lang.String	getServiceName()
java.lang.String	getSortFieldStyle()
java.lang.String	getSortFieldStyleAsc()
java.lang.String	getSortFieldStyleDesc()
java.lang.String	getTitle(java.util.Map<java.lang.String,java.lang.Object> context)
java.lang.String	getTitleAreaStyle()
java.lang.String	getTitleStyle()
java.lang.String	getTooltip(java.util.Map<java.lang.String,java.lang.Object> context)
java.lang.String	getTooltipStyle()
java.lang.String	getUseWhen(java.util.Map<java.lang.String,java.lang.Object> context)
java.lang.String	getWidgetAreaStyle()
java.lang.String	getWidgetStyle()
boolean	induceFieldInfo(java.lang.String defaultFieldType)
boolean	induceFieldInfoFromEntityField(ModelEntity modelEntity, ModelField modelField, java.lang.String defaultFieldType)
boolean	induceFieldInfoFromEntityField(java.lang.String defaultFieldType)
boolean	induceFieldInfoFromServiceParam(ModelService modelService, ModelParam modelParam, java.lang.String defaultFieldType)
boolean	induceFieldInfoFromServiceParam(java.lang.String defaultFieldType)
boolean	isRowSubmit() Checks if field is a row submit field.
boolean	isSortField()
boolean	isUseWhenEmpty()
void	mergeOverrideModelFormField(ModelFormField overrideFormField)
void	renderFieldString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer)
void	setAction(java.lang.String string)
void	setAttributeName(java.lang.String string)
void	setEncodeOutput(boolean encodeOutput)
void	setEntityName(java.lang.String string)
void	setEntryName(java.lang.String string)
void	setEvent(java.lang.String string)
void	setFieldInfo(ModelFormField.FieldInfo fieldInfo)
void	setFieldName(java.lang.String string)
void	setHeaderLink(java.lang.String string)
void	setHeaderLinkStyle(java.lang.String string)
void	setIdName(java.lang.String string)
void	setMapName(java.lang.String string)
void	setModelForm(ModelForm modelForm)
void	setName(java.lang.String string)
void	setParameterName(java.lang.String string)
void	setPosition(int i)
void	setRedWhen(java.lang.String string)
void	setRequiredField(boolean required)
void	setServiceName(java.lang.String string)
void	setSortField(boolean sort)
void	setTitle(java.lang.String string)
void	setTitleAreaStyle(java.lang.String string)
void	setTitleStyle(java.lang.String string)
void	setTooltip(java.lang.String string)
void	setTooltipStyle(java.lang.String string)
void	setUseWhen(java.lang.String string)
void	setWidgetAreaStyle(java.lang.String string)
void	setWidgetStyle(java.lang.String string)
boolean	shouldBeRed(java.util.Map<java.lang.String,java.lang.Object> context) the widget/interaction part will be red if the date value is before-now (for ex.
boolean	shouldUse(java.util.Map<java.lang.String,java.lang.Object> context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

public static final java.lang.String module

modelForm

protected ModelForm modelForm

name

protected java.lang.String name

mapAcsr

protected FlexibleMapAccessor<java.util.Map<java.lang.String,? extends java.lang.Object>> mapAcsr

entityName

protected java.lang.String entityName

serviceName

protected java.lang.String serviceName

entryAcsr

protected FlexibleMapAccessor<java.lang.Object> entryAcsr

parameterName

protected java.lang.String parameterName

fieldName

protected java.lang.String fieldName

attributeName

protected java.lang.String attributeName

title

protected FlexibleStringExpander title

tooltip

protected FlexibleStringExpander tooltip

titleAreaStyle

protected java.lang.String titleAreaStyle

widgetAreaStyle

protected java.lang.String widgetAreaStyle

titleStyle

protected java.lang.String titleStyle

widgetStyle

protected java.lang.String widgetStyle

tooltipStyle

protected java.lang.String tooltipStyle

requiredFieldStyle

protected java.lang.String requiredFieldStyle

sortFieldStyle

protected java.lang.String sortFieldStyle

sortFieldAscStyle

protected java.lang.String sortFieldAscStyle

sortFieldDescStyle

protected java.lang.String sortFieldDescStyle

position

protected java.lang.Integer position

redWhen

protected java.lang.String redWhen

useWhen

protected FlexibleStringExpander useWhen

encodeOutput

protected boolean encodeOutput

event

protected java.lang.String event

action

protected FlexibleStringExpander action

fieldInfo

protected ModelFormField.FieldInfo fieldInfo

idName

protected java.lang.String idName

separateColumn

protected boolean separateColumn

requiredField

protected java.lang.Boolean requiredField

sortField

protected java.lang.Boolean sortField

headerLink

protected java.lang.String headerLink

headerLinkStyle

protected java.lang.String headerLinkStyle

onChangeUpdateAreas

protected java.util.List<ModelForm.UpdateArea> onChangeUpdateAreas

On Change Event areas to be updated.

onClickUpdateAreas

protected java.util.List<ModelForm.UpdateArea> onClickUpdateAreas

On Click Event areas to be updated.

Constructor Detail

ModelFormField

public ModelFormField(ModelForm modelForm)

Default Constructor

ModelFormField

public ModelFormField(org.w3c.dom.Element fieldElement,
                      ModelForm modelForm)

XML Constructor

Method Detail

addOnEventUpdateArea

public void addOnEventUpdateArea(ModelForm.UpdateArea updateArea)

addOnChangeUpdateArea

protected void addOnChangeUpdateArea(ModelForm.UpdateArea updateArea)

addOnClickUpdateArea

protected void addOnClickUpdateArea(ModelForm.UpdateArea updateArea)

mergeOverrideModelFormField

public void mergeOverrideModelFormField(ModelFormField overrideFormField)

induceFieldInfo

public boolean induceFieldInfo(java.lang.String defaultFieldType)

induceFieldInfoFromServiceParam

public boolean induceFieldInfoFromServiceParam(java.lang.String defaultFieldType)

induceFieldInfoFromServiceParam

public boolean induceFieldInfoFromServiceParam(ModelService modelService,
                                               ModelParam modelParam,
                                               java.lang.String defaultFieldType)

induceFieldInfoFromEntityField

public boolean induceFieldInfoFromEntityField(java.lang.String defaultFieldType)

induceFieldInfoFromEntityField

public boolean induceFieldInfoFromEntityField(ModelEntity modelEntity,
                                              ModelField modelField,
                                              java.lang.String defaultFieldType)

renderFieldString

public void renderFieldString(java.lang.Appendable writer,
                              java.util.Map<java.lang.String,java.lang.Object> context,
                              FormStringRenderer formStringRenderer)
                       throws java.io.IOException

Throws:

java.io.IOException

getOnChangeUpdateAreas

public java.util.List<ModelForm.UpdateArea> getOnChangeUpdateAreas()

getOnClickUpdateAreas

public java.util.List<ModelForm.UpdateArea> getOnClickUpdateAreas()

getFieldInfo

public ModelFormField.FieldInfo getFieldInfo()

getModelForm

public ModelForm getModelForm()

setFieldInfo

public void setFieldInfo(ModelFormField.FieldInfo fieldInfo)

Parameters:

fieldInfo -

getAttributeName

public java.lang.String getAttributeName()

Gets the name of the Service Attribute (aka Parameter) that corresponds with this field. This can be used to get additional information about the field. Use the getServiceName() method to get the Entity name that the field is in.

Returns:

getEntityName

public java.lang.String getEntityName()

getEntryName

public java.lang.String getEntryName()

getEntry

public java.lang.String getEntry(java.util.Map<java.lang.String,java.lang.Object> context)

Gets the entry from the context that corresponds to this field; if this form is being rendered in an error condition (ie isError in the context is true) then the value will be retreived from the parameters Map in the context.

Parameters:

context -

encoder -

Returns:

getEntry

public java.lang.String getEntry(java.util.Map<java.lang.String,java.lang.Object> context,
                                 java.lang.String defaultValue)

getEntry

public java.lang.String getEntry(java.util.Map<java.lang.String,java.lang.Object> context,
                                 java.lang.String defaultValue,
                                 java.lang.String subControlName)

Gets the entry from the context that corresponds to this field; if this form is being rendered in an error condition (ie isError in the context is true) then the value will be retrieved from the parameters Map in the context.

Parameters:

context - a Map value

defaultValue - a String value

subControlName - a String value

Returns:

a String value

getMap

public java.util.Map<java.lang.String,? extends java.lang.Object> getMap(java.util.Map<java.lang.String,? extends java.lang.Object> context)

getFieldName

public java.lang.String getFieldName()

Gets the name of the Entity Field that corresponds with this field. This can be used to get additional information about the field. Use the getEntityName() method to get the Entity name that the field is in.

Returns:

getMapName

public java.lang.String getMapName()

Get the name of the Map in the form context that contains the entry, available from the getEntryName() method. This entry is used to pre-populate the field widget when not in an error condition. In an error condition the parameter name is used to get the value from the parameters Map.

Returns:

getName

public java.lang.String getName()

getParameterName

public java.lang.String getParameterName(java.util.Map<java.lang.String,java.lang.Object> context)

Get the name to use for the parameter for this field in the form interpreter. For HTML forms this is the request parameter name.

Returns:

getPosition

public int getPosition()

getRedWhen

public java.lang.String getRedWhen()

getEvent

public java.lang.String getEvent()

getAction

public java.lang.String getAction(java.util.Map<java.lang.String,java.lang.Object> context)

shouldBeRed

public boolean shouldBeRed(java.util.Map<java.lang.String,java.lang.Object> context)

the widget/interaction part will be red if the date value is before-now (for ex. thruDate), after-now (for ex. fromDate), or by-name (if the field's name or entry-name or fromDate or thruDate the corresponding action will be done); only applicable when the field is a timestamp

Parameters:

context -

Returns:

getServiceName

public java.lang.String getServiceName()

getTitle

public java.lang.String getTitle(java.util.Map<java.lang.String,java.lang.Object> context)

getTitleAreaStyle

public java.lang.String getTitleAreaStyle()

getTitleStyle

public java.lang.String getTitleStyle()

getRequiredFieldStyle

public java.lang.String getRequiredFieldStyle()

getSortFieldStyle

public java.lang.String getSortFieldStyle()

getSortFieldStyleAsc

public java.lang.String getSortFieldStyleAsc()

getSortFieldStyleDesc

public java.lang.String getSortFieldStyleDesc()

getTooltip

public java.lang.String getTooltip(java.util.Map<java.lang.String,java.lang.Object> context)

getUseWhen

public java.lang.String getUseWhen(java.util.Map<java.lang.String,java.lang.Object> context)

getEncodeOutput

public boolean getEncodeOutput()

getIdName

public java.lang.String getIdName()

getHeaderLink

public java.lang.String getHeaderLink()

getHeaderLinkStyle

public java.lang.String getHeaderLinkStyle()

setIdName

public void setIdName(java.lang.String string)

Parameters:

string -

isUseWhenEmpty

public boolean isUseWhenEmpty()

shouldUse

public boolean shouldUse(java.util.Map<java.lang.String,java.lang.Object> context)

isRowSubmit

public boolean isRowSubmit()

Checks if field is a row submit field.

getWidgetAreaStyle

public java.lang.String getWidgetAreaStyle()

getWidgetStyle

public java.lang.String getWidgetStyle()

getTooltipStyle

public java.lang.String getTooltipStyle()

setAttributeName

public void setAttributeName(java.lang.String string)

Parameters:

string -

setEntityName

public void setEntityName(java.lang.String string)

Parameters:

string -

setEntryName

public void setEntryName(java.lang.String string)

Parameters:

string -

setFieldName

public void setFieldName(java.lang.String string)

Parameters:

string -

setMapName

public void setMapName(java.lang.String string)

Parameters:

string -

setName

public void setName(java.lang.String string)

Parameters:

string -

setParameterName

public void setParameterName(java.lang.String string)

Parameters:

string -

setPosition

public void setPosition(int i)

Parameters:

i -

setRedWhen

public void setRedWhen(java.lang.String string)

Parameters:

string -

setEvent

public void setEvent(java.lang.String string)

Parameters:

string -

setAction

public void setAction(java.lang.String string)

Parameters:

string -

setServiceName

public void setServiceName(java.lang.String string)

Parameters:

string -

setTitle

public void setTitle(java.lang.String string)

Parameters:

string -

setTitleAreaStyle

public void setTitleAreaStyle(java.lang.String string)

Parameters:

string -

setTitleStyle

public void setTitleStyle(java.lang.String string)

Parameters:

string -

setTooltip

public void setTooltip(java.lang.String string)

Parameters:

string -

setUseWhen

public void setUseWhen(java.lang.String string)

Parameters:

string -

setEncodeOutput

public void setEncodeOutput(boolean encodeOutput)

setWidgetAreaStyle

public void setWidgetAreaStyle(java.lang.String string)

Parameters:

string -

setWidgetStyle

public void setWidgetStyle(java.lang.String string)

Parameters:

string -

setTooltipStyle

public void setTooltipStyle(java.lang.String string)

Parameters:

string -

getSeparateColumn

public boolean getSeparateColumn()

setHeaderLink

public void setHeaderLink(java.lang.String string)

Parameters:

string -

setHeaderLinkStyle

public void setHeaderLinkStyle(java.lang.String string)

Parameters:

string -

getRequiredField

public boolean getRequiredField()

setRequiredField

public void setRequiredField(boolean required)

Parameters:

boolean -

isSortField

public boolean isSortField()

setSortField

public void setSortField(boolean sort)

Parameters:

boolean -

setModelForm

public void setModelForm(ModelForm modelForm)

Parameters:

ModelForm -