Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.ofbiz.widget.form
Class ModelForm

java.lang.Object
  extended by org.ofbiz.widget.ModelWidget
      extended by org.ofbiz.widget.form.ModelForm
All Implemented Interfaces:
java.io.Serializable
public class ModelForm
extends ModelWidget

Widget Library - Form model class

See Also:
Serialized Form

Nested Class Summary
static class ModelForm.AltRowStyle
           
static class ModelForm.AltTarget
           
static class ModelForm.AutoFieldsEntity
           
static class ModelForm.AutoFieldsService
           
static class ModelForm.Banner
           
static class ModelForm.FieldGroup
           
static interface ModelForm.FieldGroupBase
           
static class ModelForm.UpdateArea
          The UpdateArea class implements the <on-event-update-area> elements used in form widgets.
 
Field Summary
protected  java.util.List<ModelFormAction> actions
           
protected  java.util.List<ModelForm.AltRowStyle> altRowStyles
           
protected  java.util.List<ModelForm.AltTarget> altTargets
           
protected  java.util.List<ModelForm.AutoFieldsEntity> autoFieldsEntities
           
protected  java.util.List<ModelForm.AutoFieldsService> autoFieldsServices
           
protected  boolean clientAutocompleteFields
           
protected  java.lang.String containerId
           
protected  java.lang.String containerStyle
           
static java.lang.String DEFAULT_FORM_RESULT_LIST_NAME
           
static java.lang.String DEFAULT_PAG_FIRST_STYLE
           
static java.lang.String DEFAULT_PAG_INDEX_FIELD
           
static java.lang.String DEFAULT_PAG_LAST_STYLE
           
static java.lang.String DEFAULT_PAG_NEXT_STYLE
           
static java.lang.String DEFAULT_PAG_PREV_STYLE
           
static java.lang.String DEFAULT_PAG_SIZE_FIELD
           
static java.lang.String DEFAULT_PAG_STYLE
           
static int DEFAULT_PAGE_SIZE
          Pagination settings and defaults.
static java.lang.String DEFAULT_SORT_FIELD_ASC_STYLE
           
static java.lang.String DEFAULT_SORT_FIELD_DESC_STYLE
           
static java.lang.String DEFAULT_SORT_FIELD_STYLE
          Sort field default styles.
static java.lang.String DEFAULT_TARGET_TYPE
          Default hyperlink target.
protected  java.lang.String defaultEntityName
           
protected  ModelForm.FieldGroup defaultFieldGroup
          This field group will be the "catch-all" group for fields that are not included in an explicit field-group.
protected  FlexibleMapAccessor<java.util.Map<java.lang.String,? extends java.lang.Object>> defaultMapName
           
protected  java.lang.String defaultRequiredFieldStyle
           
protected  java.lang.String defaultServiceName
           
protected  java.lang.String defaultSortFieldAscStyle
           
protected  java.lang.String defaultSortFieldDescStyle
           
protected  java.lang.String defaultSortFieldStyle
           
protected  java.lang.String defaultTableStyle
           
protected  java.lang.String defaultTitleAreaStyle
           
protected  java.lang.String defaultTitleStyle
           
protected  java.lang.String defaultTooltipStyle
           
protected  int defaultViewSize
           
protected  java.lang.String defaultWidgetAreaStyle
           
protected  java.lang.String defaultWidgetStyle
           
protected  DispatchContext dispatchContext
           
protected  ModelReader entityModelReader
           
protected  java.lang.String evenRowStyle
           
protected  java.util.List<ModelForm.FieldGroupBase> fieldGroupList
          This is a list of FieldGroups in the order they were created.
protected  java.util.Map<java.lang.String,ModelForm.FieldGroupBase> fieldGroupMap
          This Map is keyed with the field name and has a FieldGroup for the value.
protected  java.util.List<ModelFormField> fieldList
          This List will contain one copy of each field for each field name in the order they were encountered in the service, entity, or form definition; field definitions with constraints will also be in this list but may appear multiple times for the same field name.
protected  java.util.Map<java.lang.String,ModelFormField> fieldMap
          This Map is keyed with the field name and has a ModelFormField for the value.
protected  java.lang.String focusFieldName
           
protected  java.lang.String formLocation
           
protected  java.lang.String formTitleAreaStyle
           
protected  java.lang.String formWidgetAreaStyle
           
protected  java.lang.String headerRowStyle
           
protected  boolean hideHeader
           
protected  java.lang.String itemIndexSeparator
           
protected  java.lang.String listEntryName
           
protected  java.lang.String listName
           
static java.lang.String module
           
protected  java.util.List<ModelFormField> multiSubmitFields
           
protected  java.lang.String oddRowStyle
           
protected  java.util.List<ModelForm.UpdateArea> onPaginateUpdateAreas
          On Paginate areas to be updated.
protected  java.util.List<ModelForm.UpdateArea> onSubmitUpdateAreas
          On Submit areas to be updated.
protected  FlexibleStringExpander overrideListSize
           
protected  boolean overridenListSize
           
protected  boolean paginate
           
protected  FlexibleStringExpander paginateFirstLabel
           
protected  FlexibleStringExpander paginateIndexField
           
protected  FlexibleStringExpander paginateLastLabel
           
protected  FlexibleStringExpander paginateNextLabel
           
protected  FlexibleStringExpander paginatePreviousLabel
           
protected  FlexibleStringExpander paginateSizeField
           
protected  java.lang.String paginateStyle
           
protected  FlexibleStringExpander paginateTarget
           
protected  java.lang.String paginateTargetAnchor
           
protected  java.lang.String parentFormLocation
           
protected  java.lang.String parentFormName
           
protected  java.util.List<ModelFormAction> rowActions
           
protected  int rowCount
           
protected  FlexibleStringExpander rowCountExdr
           
protected  boolean separateColumns
           
protected  boolean skipEnd
           
protected  boolean skipStart
           
protected  java.util.List<java.lang.String> sortOrderFields
           
protected  FlexibleStringExpander target
           
protected  java.lang.String targetType
           
protected  FlexibleStringExpander targetWindowExdr
           
protected  java.lang.String title
           
protected  java.lang.String tooltip
           
protected  java.lang.String type
           
protected  boolean useRowSubmit
           
protected  java.util.Set<java.lang.String> useWhenFields
          Keeps track of conditional fields to help ensure that only one is rendered
 
Fields inherited from class org.ofbiz.widget.ModelWidget
enableBoundaryCommentsParam, enableWidgetBoundaryComments, name
 
Constructor Summary
ModelForm()
          Default Constructor
ModelForm(org.w3c.dom.Element formElement)
           
ModelForm(org.w3c.dom.Element formElement, ModelReader entityModelReader, DispatchContext dispatchContext)
          XML Constructor
 
Method Summary
 void addAltTarget(ModelForm.AltTarget altTarget)
           
 void addAutoFieldsFromEntity(ModelForm.AutoFieldsEntity autoFieldsEntity)
           
 void addAutoFieldsFromService(ModelForm.AutoFieldsService autoFieldsService)
           
 ModelFormField addFieldFromEntityField(ModelEntity modelEntity, ModelField modelField, java.lang.String defaultFieldType, int defaultPosition)
           
 ModelFormField addFieldFromServiceParam(ModelService modelService, ModelParam modelParam, java.lang.String defaultFieldType, int defaultPosition)
           
 void addOnEventUpdateArea(ModelForm.UpdateArea updateArea)
           
protected  void addOnPaginateUpdateArea(ModelForm.UpdateArea updateArea)
           
protected  void addOnSubmitUpdateArea(ModelForm.UpdateArea updateArea)
           
 ModelFormField addUpdateField(ModelFormField modelFormField)
          add/override modelFormField using the fieldList and fieldMap
 int getActualPageSize(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.util.Set<java.lang.String> getAllEntityNamesUsed()
           
 java.util.Set<java.lang.String> getAllServiceNamesUsed()
           
 java.lang.String getBoundaryCommentName()
          Returns the widget's name to be used in boundary comments.
 Interpreter getBshInterpreter(java.util.Map<java.lang.String,java.lang.Object> context)
           
 boolean getClientAutocompleteFields()
           
 java.lang.String getContainerId()
           
 java.lang.String getContainerStyle()
           
 java.lang.String getCurrentFormName(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getDefaultEntityName()
           
 java.util.Map<java.lang.String,? extends java.lang.Object> getDefaultMap(java.util.Map<java.lang.String,? extends java.lang.Object> context)
           
 java.lang.String getDefaultMapName()
           
 java.lang.String getDefaultRequiredFieldStyle()
           
 java.lang.String getDefaultServiceName()
           
 java.lang.String getDefaultSortFieldAscStyle()
           
 java.lang.String getDefaultSortFieldDescStyle()
           
 java.lang.String getDefaultSortFieldStyle()
           
 java.lang.String getDefaultTableStyle()
           
 java.lang.String getDefaultTitleAreaStyle()
           
 java.lang.String getDefaultTitleStyle()
           
 java.lang.String getDefaultTooltipStyle()
           
 java.lang.String getDefaultWidgetAreaStyle()
           
 java.lang.String getDefaultWidgetStyle()
           
 GenericDelegator getDelegator(java.util.Map<java.lang.String,java.lang.Object> context)
           
 LocalDispatcher getDispatcher(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getEvenRowStyle()
           
 java.util.List<ModelFormField> getFieldList()
           
 java.util.List getFieldListByPosition(java.util.List<ModelFormField> modelFormFieldList, int position)
           
 java.util.Collection getFieldListsByPosition(java.util.List<ModelFormField> modelFormFieldList)
           
 java.lang.String getfocusFieldName()
           
 java.lang.String getFormLocation()
           
 java.lang.String getFormTitleAreaStyle()
           
 java.lang.String getFormWidgetAreaStyle()
           
 java.lang.String getHeaderRowStyle()
           
 java.util.List getHiddenIgnoredFields(java.util.Map<java.lang.String,java.lang.Object> context, java.util.Set<java.lang.String> alreadyRendered, java.util.List fieldList, int position)
           
 boolean getHideHeader()
           
 int getHighIndex(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.util.List<java.lang.Object> getInbetweenList(ModelForm.FieldGroup startFieldGroup, ModelForm.FieldGroup endFieldGroup)
           
 java.lang.String getItemIndexSeparator()
           
 java.util.Set<java.lang.String> getLinkedRequestsLocationAndUri()
           
 java.lang.String getListEntryName()
           
 void getListLimits(java.util.Map<java.lang.String,java.lang.Object> context, java.lang.Object entryList)
           
 java.lang.String getListName()
           
 int getListSize(java.util.Map<java.lang.String,java.lang.Object> context)
           
 int getLowIndex(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getMultiPaginateIndexField(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getMultiPaginateSizeField(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.util.List<ModelFormField> getMultiSubmitFields()
           
 java.lang.String getName()
          Returns the widget's name.
 java.lang.String getOddRowStyle()
           
 java.util.List<ModelForm.UpdateArea> getOnPaginateUpdateAreas()
           
 java.util.List<ModelForm.UpdateArea> getOnSubmitUpdateAreas()
           
 boolean getPaginate()
           
 java.lang.String getPaginateFirstLabel(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateFirstStyle()
           
 int getPaginateIndex(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateIndexField(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateLastLabel(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateLastStyle()
           
 java.lang.String getPaginateNextLabel(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateNextStyle()
           
 java.lang.String getPaginatePreviousLabel(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginatePreviousStyle()
           
 int getPaginateSize(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateSizeField(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateStyle()
           
 java.lang.String getPaginateTarget(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getPaginateTargetAnchor()
           
 java.lang.String getParentFormLocation()
           
 java.lang.String getParentFormName()
           
 java.lang.String getPassedRowCount(java.util.Map<java.lang.String,java.lang.Object> context)
           
 int getRowCount()
           
 boolean getSeparateColumns()
           
 boolean getSkipEnd()
           
 boolean getSkipStart()
           
 java.lang.String getSortField(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getStyleAltRowStyle(java.util.Map<java.lang.String,java.lang.Object> context)
          iterate through alt-row-styles list to see if should be used, then add style
 java.lang.String getTarget(java.util.Map<java.lang.String,java.lang.Object> context, java.lang.String targetType)
          iterate through altTargets list to see if any should be used, if not return original target
 java.util.Set<java.lang.String> getTargetedRequestsLocationAndUri()
           
 java.lang.String getTargetType()
           
 java.lang.String getTargetWindow(java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.String getTitle()
           
 java.lang.String getTooltip()
           
 java.lang.String getType()
           
 boolean getUseRowSubmit()
           
 int getViewIndex(java.util.Map<java.lang.String,java.lang.Object> context)
           
 int getViewSize(java.util.Map<java.lang.String,java.lang.Object> context)
           
 void initForm(org.w3c.dom.Element formElement)
           
 boolean isOverridenListSize()
           
 void preparePager(java.util.Map<java.lang.String,java.lang.Object> context)
           
 void renderFormString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer)
          Renders this form to a String, i.e.
 int renderHeaderRow(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer)
           
 void renderHiddenIgnoredFields(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer, java.util.List fieldList)
           
 void renderItemRow(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> localContext, FormStringRenderer formStringRenderer, boolean formPerItem, java.util.List hiddenIgnoredFieldList, java.util.List innerDisplayHyperlinkFieldsBegin, java.util.List innerFormFields, java.util.List innerDisplayHyperlinkFieldsEnd, int position, int numOfColumns)
           
 void renderItemRows(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer, boolean formPerItem, int numOfColumns)
           
 void renderListFormString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer, int positions)
           
 void renderMultiFormString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer, int positions)
           
 void renderSingleFormString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, FormStringRenderer formStringRenderer, int positions)
           
 void resetBshInterpreter(java.util.Map<java.lang.String,java.lang.Object> context)
           
 void runFormActions(java.util.Map<java.lang.String,java.lang.Object> context)
           
protected  java.lang.Object safeNext(java.util.Iterator iterator)
           
 void setContainerId(java.lang.String string)
           
 void setDefaultEntityName(java.lang.String string)
           
 void setDefaultMapName(java.lang.String string)
           
 void setDefaultServiceName(java.lang.String string)
           
 void setDefaultTableStyle(java.lang.String string)
           
 void setDefaultTitleAreaStyle(java.lang.String string)
           
 void setDefaultTitleStyle(java.lang.String string)
           
 void setDefaultTooltipStyle(java.lang.String string)
           
 void setDefaultViewSize(int val)
           
 void setDefaultViewSize(java.lang.String val)
           
 void setDefaultWidgetAreaStyle(java.lang.String string)
           
 void setDefaultWidgetStyle(java.lang.String string)
           
 void setEvenRowStyle(java.lang.String string)
           
 void setfocusFieldName(java.lang.String string)
           
 void setFormLocation(java.lang.String formLocation)
           
 void setFormTitleAreaStyle(java.lang.String string)
           
 void setFormWidgetAreaStyle(java.lang.String string)
           
 void setHeaderRowStyle(java.lang.String string)
           
 void setItemIndexSeparator(java.lang.String string)
           
 void setListEntryName(java.lang.String string)
           
 void setListName(java.lang.String string)
           
 void setName(java.lang.String string)
           
 void setOddRowStyle(java.lang.String string)
           
 void setOverridenListSize(boolean overridenListSize)
           
 void setPaginate(boolean val)
           
 void setPaginateIndexField(java.lang.String string)
           
 void setPaginateSizeField(java.lang.String string)
           
 void setPaginateStyle(java.lang.String string)
           
 void setPaginateTarget(java.lang.String string)
           
 void setSkipEnd(boolean val)
           
 void setSkipStart(boolean val)
           
 void setTarget(java.lang.String string)
           
 void setTargetWindow(java.lang.String val)
           
 void setTitle(java.lang.String string)
           
 void setTooltip(java.lang.String string)
           
 void setType(java.lang.String string)
           
 
Methods inherited from class org.ofbiz.widget.ModelWidget
boundaryCommentsEnabled, getPaginatorNumber, incrementPaginatorNumber, setWidgetBoundaryComments, widgetBoundaryCommentsEnabled
 
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

DEFAULT_FORM_RESULT_LIST_NAME

public static final java.lang.String DEFAULT_FORM_RESULT_LIST_NAME
See Also:
Constant Field Values

entityModelReader

protected ModelReader entityModelReader

dispatchContext

protected DispatchContext dispatchContext

formLocation

protected java.lang.String formLocation

parentFormName

protected java.lang.String parentFormName

parentFormLocation

protected java.lang.String parentFormLocation

type

protected java.lang.String type

target

protected FlexibleStringExpander target

targetType

protected java.lang.String targetType

containerId

protected java.lang.String containerId

containerStyle

protected java.lang.String containerStyle

focusFieldName

protected java.lang.String focusFieldName

title

protected java.lang.String title

tooltip

protected java.lang.String tooltip

listName

protected java.lang.String listName

listEntryName

protected java.lang.String listEntryName

defaultMapName

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

defaultEntityName

protected java.lang.String defaultEntityName

defaultServiceName

protected java.lang.String defaultServiceName

formTitleAreaStyle

protected java.lang.String formTitleAreaStyle

formWidgetAreaStyle

protected java.lang.String formWidgetAreaStyle

defaultTitleAreaStyle

protected java.lang.String defaultTitleAreaStyle

defaultWidgetAreaStyle

protected java.lang.String defaultWidgetAreaStyle

defaultTitleStyle

protected java.lang.String defaultTitleStyle

defaultWidgetStyle

protected java.lang.String defaultWidgetStyle

defaultTooltipStyle

protected java.lang.String defaultTooltipStyle

itemIndexSeparator

protected java.lang.String itemIndexSeparator

paginateTarget

protected FlexibleStringExpander paginateTarget

paginateIndexField

protected FlexibleStringExpander paginateIndexField

paginateSizeField

protected FlexibleStringExpander paginateSizeField

overrideListSize

protected FlexibleStringExpander overrideListSize

paginateFirstLabel

protected FlexibleStringExpander paginateFirstLabel

paginatePreviousLabel

protected FlexibleStringExpander paginatePreviousLabel

paginateNextLabel

protected FlexibleStringExpander paginateNextLabel

paginateLastLabel

protected FlexibleStringExpander paginateLastLabel

paginateTargetAnchor

protected java.lang.String paginateTargetAnchor

paginateStyle

protected java.lang.String paginateStyle

separateColumns

protected boolean separateColumns

paginate

protected boolean paginate

useRowSubmit

protected boolean useRowSubmit

targetWindowExdr

protected FlexibleStringExpander targetWindowExdr

defaultRequiredFieldStyle

protected java.lang.String defaultRequiredFieldStyle

defaultSortFieldStyle

protected java.lang.String defaultSortFieldStyle

defaultSortFieldAscStyle

protected java.lang.String defaultSortFieldAscStyle

defaultSortFieldDescStyle

protected java.lang.String defaultSortFieldDescStyle

oddRowStyle

protected java.lang.String oddRowStyle

evenRowStyle

protected java.lang.String evenRowStyle

defaultTableStyle

protected java.lang.String defaultTableStyle

headerRowStyle

protected java.lang.String headerRowStyle

skipStart

protected boolean skipStart

skipEnd

protected boolean skipEnd

hideHeader

protected boolean hideHeader

overridenListSize

protected boolean overridenListSize

clientAutocompleteFields

protected boolean clientAutocompleteFields

altTargets

protected java.util.List<ModelForm.AltTarget> altTargets

autoFieldsServices

protected java.util.List<ModelForm.AutoFieldsService> autoFieldsServices

autoFieldsEntities

protected java.util.List<ModelForm.AutoFieldsEntity> autoFieldsEntities

sortOrderFields

protected java.util.List<java.lang.String> sortOrderFields

altRowStyles

protected java.util.List<ModelForm.AltRowStyle> altRowStyles

fieldList

protected java.util.List<ModelFormField> fieldList
This List will contain one copy of each field for each field name in the order they were encountered in the service, entity, or form definition; field definitions with constraints will also be in this list but may appear multiple times for the same field name. When rendering the form the order in this list should be following and it should not be necessary to use the Map. The Map is used when loading the form definition to keep the list clean and implement the override features for field definitions.

fieldMap

protected java.util.Map<java.lang.String,ModelFormField> fieldMap
This Map is keyed with the field name and has a ModelFormField for the value.

useWhenFields

protected java.util.Set<java.lang.String> useWhenFields
Keeps track of conditional fields to help ensure that only one is rendered

fieldGroupList

protected java.util.List<ModelForm.FieldGroupBase> fieldGroupList
This is a list of FieldGroups in the order they were created. Can also include Banner objects.

fieldGroupMap

protected java.util.Map<java.lang.String,ModelForm.FieldGroupBase> fieldGroupMap
This Map is keyed with the field name and has a FieldGroup for the value. Can also include Banner objects.

defaultFieldGroup

protected ModelForm.FieldGroup defaultFieldGroup
This field group will be the "catch-all" group for fields that are not included in an explicit field-group.

DEFAULT_TARGET_TYPE

public static java.lang.String DEFAULT_TARGET_TYPE
Default hyperlink target.

DEFAULT_PAGE_SIZE

public static int DEFAULT_PAGE_SIZE
Pagination settings and defaults.

defaultViewSize

protected int defaultViewSize

DEFAULT_PAG_INDEX_FIELD

public static java.lang.String DEFAULT_PAG_INDEX_FIELD

DEFAULT_PAG_SIZE_FIELD

public static java.lang.String DEFAULT_PAG_SIZE_FIELD

DEFAULT_PAG_STYLE

public static java.lang.String DEFAULT_PAG_STYLE

DEFAULT_PAG_FIRST_STYLE

public static java.lang.String DEFAULT_PAG_FIRST_STYLE

DEFAULT_PAG_PREV_STYLE

public static java.lang.String DEFAULT_PAG_PREV_STYLE

DEFAULT_PAG_NEXT_STYLE

public static java.lang.String DEFAULT_PAG_NEXT_STYLE

DEFAULT_PAG_LAST_STYLE

public static java.lang.String DEFAULT_PAG_LAST_STYLE

DEFAULT_SORT_FIELD_STYLE

public static java.lang.String DEFAULT_SORT_FIELD_STYLE
Sort field default styles.

DEFAULT_SORT_FIELD_ASC_STYLE

public static java.lang.String DEFAULT_SORT_FIELD_ASC_STYLE

DEFAULT_SORT_FIELD_DESC_STYLE

public static java.lang.String DEFAULT_SORT_FIELD_DESC_STYLE

actions

protected java.util.List<ModelFormAction> actions

rowActions

protected java.util.List<ModelFormAction> rowActions

rowCountExdr

protected FlexibleStringExpander rowCountExdr

multiSubmitFields

protected java.util.List<ModelFormField> multiSubmitFields

rowCount

protected int rowCount

onSubmitUpdateAreas

protected java.util.List<ModelForm.UpdateArea> onSubmitUpdateAreas
On Submit areas to be updated.

onPaginateUpdateAreas

protected java.util.List<ModelForm.UpdateArea> onPaginateUpdateAreas
On Paginate areas to be updated.

Constructor Detail

ModelForm

public ModelForm()
Default Constructor

ModelForm

public ModelForm(org.w3c.dom.Element formElement,
                 ModelReader entityModelReader,
                 DispatchContext dispatchContext)
XML Constructor

ModelForm

public ModelForm(org.w3c.dom.Element formElement)
Method Detail

initForm

public void initForm(org.w3c.dom.Element formElement)

addUpdateField

public ModelFormField addUpdateField(ModelFormField modelFormField)
add/override modelFormField using the fieldList and fieldMap

Returns:
The same ModelFormField, or if merged with an existing field, the existing field.

addAltTarget

public void addAltTarget(ModelForm.AltTarget altTarget)

addOnEventUpdateArea

public void addOnEventUpdateArea(ModelForm.UpdateArea updateArea)

addOnSubmitUpdateArea

protected void addOnSubmitUpdateArea(ModelForm.UpdateArea updateArea)

addOnPaginateUpdateArea

protected void addOnPaginateUpdateArea(ModelForm.UpdateArea updateArea)

addAutoFieldsFromService

public void addAutoFieldsFromService(ModelForm.AutoFieldsService autoFieldsService)

addFieldFromServiceParam

public ModelFormField addFieldFromServiceParam(ModelService modelService,
                                               ModelParam modelParam,
                                               java.lang.String defaultFieldType,
                                               int defaultPosition)

addAutoFieldsFromEntity

public void addAutoFieldsFromEntity(ModelForm.AutoFieldsEntity autoFieldsEntity)

addFieldFromEntityField

public ModelFormField addFieldFromEntityField(ModelEntity modelEntity,
                                              ModelField modelField,
                                              java.lang.String defaultFieldType,
                                              int defaultPosition)

runFormActions

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

renderFormString

public void renderFormString(java.lang.Appendable writer,
                             java.util.Map<java.lang.String,java.lang.Object> context,
                             FormStringRenderer formStringRenderer)
                      throws java.io.IOException
Renders this form to a String, i.e. in a text format, as defined with the FormStringRenderer implementation.

Parameters:
writer - The Writer that the form text will be written to
context - Map containing the form context; the following are reserved words in this context: parameters (Map), isError (Boolean), itemIndex (Integer, for lists only, otherwise null), bshInterpreter, formName (String, optional alternate name for form, defaults to the value of the name attribute)
formStringRenderer - An implementation of the FormStringRenderer interface that is responsible for the actual text generation for different form elements; implementing your own makes it possible to use the same form definitions for many types of form UIs
Throws:
java.io.IOException

renderSingleFormString

public void renderSingleFormString(java.lang.Appendable writer,
                                   java.util.Map<java.lang.String,java.lang.Object> context,
                                   FormStringRenderer formStringRenderer,
                                   int positions)
                            throws java.io.IOException
Throws:
java.io.IOException

renderListFormString

public void renderListFormString(java.lang.Appendable writer,
                                 java.util.Map<java.lang.String,java.lang.Object> context,
                                 FormStringRenderer formStringRenderer,
                                 int positions)
                          throws java.io.IOException
Throws:
java.io.IOException

renderMultiFormString

public void renderMultiFormString(java.lang.Appendable writer,
                                  java.util.Map<java.lang.String,java.lang.Object> context,
                                  FormStringRenderer formStringRenderer,
                                  int positions)
                           throws java.io.IOException
Throws:
java.io.IOException

renderHeaderRow

public int renderHeaderRow(java.lang.Appendable writer,
                           java.util.Map<java.lang.String,java.lang.Object> context,
                           FormStringRenderer formStringRenderer)
                    throws java.io.IOException
Throws:
java.io.IOException

safeNext

protected java.lang.Object safeNext(java.util.Iterator iterator)

preparePager

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

renderItemRows

public void renderItemRows(java.lang.Appendable writer,
                           java.util.Map<java.lang.String,java.lang.Object> context,
                           FormStringRenderer formStringRenderer,
                           boolean formPerItem,
                           int numOfColumns)
                    throws java.io.IOException
Throws:
java.io.IOException

renderItemRow

public void renderItemRow(java.lang.Appendable writer,
                          java.util.Map<java.lang.String,java.lang.Object> localContext,
                          FormStringRenderer formStringRenderer,
                          boolean formPerItem,
                          java.util.List hiddenIgnoredFieldList,
                          java.util.List innerDisplayHyperlinkFieldsBegin,
                          java.util.List innerFormFields,
                          java.util.List innerDisplayHyperlinkFieldsEnd,
                          int position,
                          int numOfColumns)
                   throws java.io.IOException
Throws:
java.io.IOException

getHiddenIgnoredFields

public java.util.List getHiddenIgnoredFields(java.util.Map<java.lang.String,java.lang.Object> context,
                                             java.util.Set<java.lang.String> alreadyRendered,
                                             java.util.List fieldList,
                                             int position)

renderHiddenIgnoredFields

public void renderHiddenIgnoredFields(java.lang.Appendable writer,
                                      java.util.Map<java.lang.String,java.lang.Object> context,
                                      FormStringRenderer formStringRenderer,
                                      java.util.List fieldList)
                               throws java.io.IOException
Throws:
java.io.IOException

getFieldListsByPosition

public java.util.Collection getFieldListsByPosition(java.util.List<ModelFormField> modelFormFieldList)

getFieldListByPosition

public java.util.List getFieldListByPosition(java.util.List<ModelFormField> modelFormFieldList,
                                             int position)

getDispatcher

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

getDelegator

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

getTargetType

public java.lang.String getTargetType()

getParentFormName

public java.lang.String getParentFormName()

getParentFormLocation

public java.lang.String getParentFormLocation()

getDefaultEntityName

public java.lang.String getDefaultEntityName()

getDefaultMapName

public java.lang.String getDefaultMapName()

getDefaultMap

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

getDefaultRequiredFieldStyle

public java.lang.String getDefaultRequiredFieldStyle()

getDefaultSortFieldStyle

public java.lang.String getDefaultSortFieldStyle()

getDefaultSortFieldAscStyle

public java.lang.String getDefaultSortFieldAscStyle()

getDefaultSortFieldDescStyle

public java.lang.String getDefaultSortFieldDescStyle()

getDefaultServiceName

public java.lang.String getDefaultServiceName()

getFormTitleAreaStyle

public java.lang.String getFormTitleAreaStyle()

getFormWidgetAreaStyle

public java.lang.String getFormWidgetAreaStyle()

getDefaultTitleAreaStyle

public java.lang.String getDefaultTitleAreaStyle()

getDefaultWidgetAreaStyle

public java.lang.String getDefaultWidgetAreaStyle()

getOddRowStyle

public java.lang.String getOddRowStyle()

getEvenRowStyle

public java.lang.String getEvenRowStyle()

getDefaultTableStyle

public java.lang.String getDefaultTableStyle()

getHeaderRowStyle

public java.lang.String getHeaderRowStyle()

getDefaultTitleStyle

public java.lang.String getDefaultTitleStyle()

getDefaultWidgetStyle

public java.lang.String getDefaultWidgetStyle()

getDefaultTooltipStyle

public java.lang.String getDefaultTooltipStyle()

getItemIndexSeparator

public java.lang.String getItemIndexSeparator()

getListEntryName

public java.lang.String getListEntryName()

getListName

public java.lang.String getListName()

getName

public java.lang.String getName()
Description copied from class: ModelWidget
Returns the widget's name.

Overrides:
getName in class ModelWidget
Returns:
Widget's name

getCurrentFormName

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

getTarget

public java.lang.String getTarget(java.util.Map<java.lang.String,java.lang.Object> context,
                                  java.lang.String targetType)
iterate through altTargets list to see if any should be used, if not return original target

Returns:
The target for this Form

getContainerId

public java.lang.String getContainerId()

getContainerStyle

public java.lang.String getContainerStyle()

getfocusFieldName

public java.lang.String getfocusFieldName()

getTitle

public java.lang.String getTitle()

getTooltip

public java.lang.String getTooltip()

getType

public java.lang.String getType()

getBoundaryCommentName

public java.lang.String getBoundaryCommentName()
Description copied from class: ModelWidget
Returns the widget's name to be used in boundary comments. The default action is to return the widget's name. Derived classes can override this method to return a customized name.

Overrides:
getBoundaryCommentName in class ModelWidget
Returns:
Name to be used in boundary comments

resetBshInterpreter

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

getBshInterpreter

public Interpreter getBshInterpreter(java.util.Map<java.lang.String,java.lang.Object> context)
                              throws EvalError
Throws:
EvalError

setDefaultEntityName

public void setDefaultEntityName(java.lang.String string)
Parameters:
string -

setDefaultMapName

public void setDefaultMapName(java.lang.String string)
Parameters:
string -

setDefaultServiceName

public void setDefaultServiceName(java.lang.String string)
Parameters:
string -

setFormTitleAreaStyle

public void setFormTitleAreaStyle(java.lang.String string)
Parameters:
string -

setFormWidgetAreaStyle

public void setFormWidgetAreaStyle(java.lang.String string)
Parameters:
string -

setDefaultTitleAreaStyle

public void setDefaultTitleAreaStyle(java.lang.String string)
Parameters:
string -

setDefaultWidgetAreaStyle

public void setDefaultWidgetAreaStyle(java.lang.String string)
Parameters:
string -

setOddRowStyle

public void setOddRowStyle(java.lang.String string)
Parameters:
string -

setEvenRowStyle

public void setEvenRowStyle(java.lang.String string)
Parameters:
string -

setDefaultTableStyle

public void setDefaultTableStyle(java.lang.String string)
Parameters:
string -

setHeaderRowStyle

public void setHeaderRowStyle(java.lang.String string)
Parameters:
string -

setDefaultTitleStyle

public void setDefaultTitleStyle(java.lang.String string)
Parameters:
string -

setDefaultWidgetStyle

public void setDefaultWidgetStyle(java.lang.String string)
Parameters:
string -

setDefaultTooltipStyle

public void setDefaultTooltipStyle(java.lang.String string)
Parameters:
string -

setItemIndexSeparator

public void setItemIndexSeparator(java.lang.String string)
Parameters:
string -

setFormLocation

public void setFormLocation(java.lang.String formLocation)
Parameters:
string - Form's location

getFormLocation

public java.lang.String getFormLocation()

setListEntryName

public void setListEntryName(java.lang.String string)
Parameters:
string -

setListName

public void setListName(java.lang.String string)
Parameters:
string -

setName

public void setName(java.lang.String string)
Parameters:
string -

setTarget

public void setTarget(java.lang.String string)
Parameters:
string -

setContainerId

public void setContainerId(java.lang.String string)
Parameters:
string -

setfocusFieldName

public void setfocusFieldName(java.lang.String string)
Parameters:
string -

setTitle

public void setTitle(java.lang.String string)
Parameters:
string -

setTooltip

public void setTooltip(java.lang.String string)
Parameters:
string -

setType

public void setType(java.lang.String string)
Parameters:
string -

getOnPaginateUpdateAreas

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

getPaginateTarget

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

getPaginateTargetAnchor

public java.lang.String getPaginateTargetAnchor()

getPaginateIndexField

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

getMultiPaginateIndexField

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

getPaginateIndex

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

getPaginateSizeField

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

getMultiPaginateSizeField

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

getPaginateSize

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

getPaginateFirstLabel

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

getPaginatePreviousLabel

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

getPaginateNextLabel

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

getPaginateLastLabel

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

getPaginateStyle

public java.lang.String getPaginateStyle()

getPaginateFirstStyle

public java.lang.String getPaginateFirstStyle()

getPaginatePreviousStyle

public java.lang.String getPaginatePreviousStyle()

getPaginateNextStyle

public java.lang.String getPaginateNextStyle()

getPaginateLastStyle

public java.lang.String getPaginateLastStyle()

getTargetWindow

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

setTargetWindow

public void setTargetWindow(java.lang.String val)

getSeparateColumns

public boolean getSeparateColumns()

getPaginate

public boolean getPaginate()

getSkipStart

public boolean getSkipStart()

getSkipEnd

public boolean getSkipEnd()

isOverridenListSize

public boolean isOverridenListSize()

setSkipStart

public void setSkipStart(boolean val)

setSkipEnd

public void setSkipEnd(boolean val)

getHideHeader

public boolean getHideHeader()

getClientAutocompleteFields

public boolean getClientAutocompleteFields()

setPaginate

public void setPaginate(boolean val)

setOverridenListSize

public void setOverridenListSize(boolean overridenListSize)

setPaginateTarget

public void setPaginateTarget(java.lang.String string)

setPaginateIndexField

public void setPaginateIndexField(java.lang.String string)

setPaginateSizeField

public void setPaginateSizeField(java.lang.String string)

setPaginateStyle

public void setPaginateStyle(java.lang.String string)

setDefaultViewSize

public void setDefaultViewSize(int val)

setDefaultViewSize

public void setDefaultViewSize(java.lang.String val)

getListSize

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

getViewIndex

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

getViewSize

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

getLowIndex

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

getHighIndex

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

getActualPageSize

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

getFieldList

public java.util.List<ModelFormField> getFieldList()

getListLimits

public void getListLimits(java.util.Map<java.lang.String,java.lang.Object> context,
                          java.lang.Object entryList)

getPassedRowCount

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

getRowCount

public int getRowCount()

getUseRowSubmit

public boolean getUseRowSubmit()

getMultiSubmitFields

public java.util.List<ModelFormField> getMultiSubmitFields()

getInbetweenList

public java.util.List<java.lang.Object> getInbetweenList(ModelForm.FieldGroup startFieldGroup,
                                                         ModelForm.FieldGroup endFieldGroup)

getSortField

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

getOnSubmitUpdateAreas

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

getStyleAltRowStyle

public java.lang.String getStyleAltRowStyle(java.util.Map<java.lang.String,java.lang.Object> context)
iterate through alt-row-styles list to see if should be used, then add style

Returns:
The style for item row

getAllEntityNamesUsed

public java.util.Set<java.lang.String> getAllEntityNamesUsed()

getAllServiceNamesUsed

public java.util.Set<java.lang.String> getAllServiceNamesUsed()

getLinkedRequestsLocationAndUri

public java.util.Set<java.lang.String> getLinkedRequestsLocationAndUri()
                                                                throws GeneralException
Throws:
GeneralException

getTargetedRequestsLocationAndUri

public java.util.Set<java.lang.String> getTargetedRequestsLocationAndUri()
                                                                  throws GeneralException
Throws:
GeneralException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD