Package org.apache.ofbiz.widget.model

Class ModelForm

java.lang.Object
org.apache.ofbiz.widget.model.ModelWidget
org.apache.ofbiz.widget.model.ModelForm
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ModelGrid, ModelSingleForm
public abstract class ModelForm extends ModelWidget
Abstract base class for the <form> and <grid> elements.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getActions

      public List<ModelAction> getActions()
      Gets actions.
      Returns:
      the actions

    • getAltRowStyles

      public List<ModelForm.AltRowStyle> getAltRowStyles()
      Gets alt row styles.
      Returns:
      the alt row styles

    • getAltTargets

      public List<ModelForm.AltTarget> getAltTargets()
      Gets alt targets.
      Returns:
      the alt targets

    • getAutoFieldsEntities

      public List<ModelForm.AutoFieldsEntity> getAutoFieldsEntities()
      Gets auto fields entities.
      Returns:
      the auto fields entities

    • getAutoFieldsServices

      public List<ModelForm.AutoFieldsService> getAutoFieldsServices()
      Gets auto fields services.
      Returns:
      the auto fields services

    • getBoundaryCommentName

      public 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

    • getClientAutocompleteFields

      public boolean getClientAutocompleteFields()
      Gets client autocomplete fields.
      Returns:
      the client autocomplete fields

    • getContainerId

      public String getContainerId()
      Gets container id.
      Returns:
      the container id

    • getContainerStyle

      public String getContainerStyle()
      Gets container style.
      Returns:
      the container style

    • getDefaultEntityName

      public String getDefaultEntityName()
      Gets default entity name.
      Returns:
      the default entity name

    • getDefaultFieldGroup

      public ModelForm.FieldGroup getDefaultFieldGroup()
      Gets default field group.
      Returns:
      the default field group

    • getDefaultMap

      public Map<String,? extends Object> getDefaultMap(Map<String,? extends Object> context)
      Gets default map.
      Parameters:
      context - the context
      Returns:
      the default map

    • getDefaultMapName

      public String getDefaultMapName()
      Gets default map name.
      Returns:
      the default map name

    • getDefaultRequiredFieldStyle

      public String getDefaultRequiredFieldStyle()
      Gets default required field style.
      Returns:
      the default required field style

    • getDefaultServiceName

      public String getDefaultServiceName()
      Gets default service name.
      Returns:
      the default service name

    • getDefaultSortFieldAscStyle

      public String getDefaultSortFieldAscStyle()
      Gets default sort field asc style.
      Returns:
      the default sort field asc style

    • getDefaultSortFieldDescStyle

      public String getDefaultSortFieldDescStyle()
      Gets default sort field desc style.
      Returns:
      the default sort field desc style

    • getDefaultSortFieldStyle

      public String getDefaultSortFieldStyle()
      Gets default sort field style.
      Returns:
      the default sort field style

    • getDefaultTableStyle

      public String getDefaultTableStyle()
      Gets default table style.
      Returns:
      the default table style

    • getDefaultTitleAreaStyle

      public String getDefaultTitleAreaStyle()
      Gets default title area style.
      Returns:
      the default title area style

    • getDefaultTitleStyle

      public String getDefaultTitleStyle()
      Gets default title style.
      Returns:
      the default title style

    • getDefaultTooltipStyle

      public String getDefaultTooltipStyle()
      Gets default tooltip style.
      Returns:
      the default tooltip style

    • getDefaultViewSize

      public int getDefaultViewSize()
      Gets default view size.
      Returns:
      the default view size

    • getDefaultWidgetAreaStyle

      public String getDefaultWidgetAreaStyle()
      Gets default widget area style.
      Returns:
      the default widget area style

    • getDefaultWidgetStyle

      public String getDefaultWidgetStyle()
      Gets default widget style.
      Returns:
      the default widget style

    • getEvenRowStyle

      public String getEvenRowStyle()
      Gets even row style.
      Returns:
      the even row style

    • getFieldGroupList

      public List<ModelForm.FieldGroupBase> getFieldGroupList()
      Gets field group list.
      Returns:
      the field group list

    • getFieldGroupMap

      public Map<String,ModelForm.FieldGroupBase> getFieldGroupMap()
      Gets field group map.
      Returns:
      the field group map

    • getFieldList

      public List<ModelFormField> getFieldList()
      Gets field list.
      Returns:
      the field list

    • getFocusFieldName

      public String getFocusFieldName()
      Gets focus field name.
      Returns:
      the focus field name

    • getFormLocation

      public String getFormLocation()
      Gets form location.
      Returns:
      the form location

    • getFormTitleAreaStyle

      public String getFormTitleAreaStyle()
      Gets form title area style.
      Returns:
      the form title area style

    • getFormWidgetAreaStyle

      public String getFormWidgetAreaStyle()
      Gets form widget area style.
      Returns:
      the form widget area style

    • getHeaderRowStyle

      public String getHeaderRowStyle()
      Gets header row style.
      Returns:
      the header row style

    • getHideHeader

      public boolean getHideHeader()
      Gets hide header.
      Returns:
      the hide header

    • getItemIndexSeparator

      public String getItemIndexSeparator()
      Gets item index separator.
      Returns:
      the item index separator

    • getLastOrderFields

      public List<String> getLastOrderFields()
      Gets last order fields.
      Returns:
      the last order fields

    • getListEntryName

      public String getListEntryName()
      Gets list entry name.
      Returns:
      the list entry name

    • getListName

      public String getListName()
      Gets list name.
      Returns:
      the list name

    • getMultiPaginateIndexField

      public String getMultiPaginateIndexField(Map<String,Object> context)
      Gets multi paginate index field.
      Parameters:
      context - the context
      Returns:
      the multi paginate index field

    • getMultiPaginateSizeField

      public String getMultiPaginateSizeField(Map<String,Object> context)
      Gets multi paginate size field.
      Parameters:
      context - the context
      Returns:
      the multi paginate size field

    • getMultiSubmitFields

      public List<ModelFormField> getMultiSubmitFields()
      Gets multi submit fields.
      Returns:
      the multi submit fields

    • getOddRowStyle

      public String getOddRowStyle()
      Gets odd row style.
      Returns:
      the odd row style

    • getOnPaginateUpdateAreas

      public List<ModelForm.UpdateArea> getOnPaginateUpdateAreas()
      Gets on paginate update areas.
      Returns:
      the on paginate update areas

    • getOnSortColumnUpdateAreas

      public List<ModelForm.UpdateArea> getOnSortColumnUpdateAreas()
      Gets on sort column update areas.
      Returns:
      the on sort column update areas

    • getOnSubmitUpdateAreas

      public List<ModelForm.UpdateArea> getOnSubmitUpdateAreas()
      Returns the list of ModelForm.UpdateArea objects.

    • getOverrideListSize

      public String getOverrideListSize()
      Gets override list size.
      Returns:
      the override list size

    • getOverrideListSize

      public int getOverrideListSize(Map<String,Object> context)
      Gets override list size.
      Parameters:
      context - the context
      Returns:
      the override list size

    • getPaginate

      public String getPaginate()
      Gets paginate.
      Returns:
      the paginate

    • getPaginate

      public boolean getPaginate(Map<String,Object> context)
      Gets paginate.
      Parameters:
      context - the context
      Returns:
      the paginate

    • getPaginateFirstLabel

      public String getPaginateFirstLabel()
      Gets paginate first label.
      Returns:
      the paginate first label

    • getPaginateFirstLabel

      public String getPaginateFirstLabel(Map<String,Object> context)
      Gets paginate first label.
      Parameters:
      context - the context
      Returns:
      the paginate first label

    • getPaginateFirstStyle

      public String getPaginateFirstStyle()
      Gets paginate first style.
      Returns:
      the paginate first style

    • getPaginateIndexField

      public String getPaginateIndexField()
      Gets paginate index field.
      Returns:
      the paginate index field

    • getPaginateIndexField

      public String getPaginateIndexField(Map<String,Object> context)
      Gets paginate index field.
      Parameters:
      context - the context
      Returns:
      the paginate index field

    • getPaginateLastLabel

      public String getPaginateLastLabel()
      Gets paginate last label.
      Returns:
      the paginate last label

    • getPaginateLastLabel

      public String getPaginateLastLabel(Map<String,Object> context)
      Gets paginate last label.
      Parameters:
      context - the context
      Returns:
      the paginate last label

    • getPaginateLastStyle

      public String getPaginateLastStyle()
      Gets paginate last style.
      Returns:
      the paginate last style

    • getPaginateNextLabel

      public String getPaginateNextLabel()
      Gets paginate next label.
      Returns:
      the paginate next label

    • getPaginateNextLabel

      public String getPaginateNextLabel(Map<String,Object> context)
      Gets paginate next label.
      Parameters:
      context - the context
      Returns:
      the paginate next label

    • getPaginateNextStyle

      public String getPaginateNextStyle()
      Gets paginate next style.
      Returns:
      the paginate next style

    • getPaginatePreviousLabel

      public String getPaginatePreviousLabel()
      Gets paginate previous label.
      Returns:
      the paginate previous label

    • getPaginatePreviousLabel

      public String getPaginatePreviousLabel(Map<String,Object> context)
      Gets paginate previous label.
      Parameters:
      context - the context
      Returns:
      the paginate previous label

    • getPaginatePreviousStyle

      public String getPaginatePreviousStyle()
      Gets paginate previous style.
      Returns:
      the paginate previous style

    • getPaginateSizeField

      public String getPaginateSizeField()
      Gets paginate size field.
      Returns:
      the paginate size field

    • getPaginateSizeField

      public String getPaginateSizeField(Map<String,Object> context)
      Gets paginate size field.
      Parameters:
      context - the context
      Returns:
      the paginate size field

    • getPaginateStyle

      public String getPaginateStyle()
      Gets paginate style.
      Returns:
      the paginate style

    • getPaginateTarget

      public String getPaginateTarget()
      Gets paginate target.
      Returns:
      the paginate target

    • getPaginateTarget

      public String getPaginateTarget(Map<String,Object> context)
      Gets paginate target.
      Parameters:
      context - the context
      Returns:
      the paginate target

    • getPaginateTargetAnchor

      public String getPaginateTargetAnchor()
      Gets paginate target anchor.
      Returns:
      the paginate target anchor

    • getPaginateViewSizeLabel

      public String getPaginateViewSizeLabel()
      Gets paginate view size label.
      Returns:
      the paginate view size label

    • getPaginateViewSizeLabel

      public String getPaginateViewSizeLabel(Map<String,Object> context)
      Gets paginate view size label.
      Parameters:
      context - the context
      Returns:
      the paginate view size label

    • getParentModel

      protected abstract ModelForm getParentModel(Element formElement, ModelReader entityModelReader, VisualTheme visualTheme, DispatchContext dispatchContext)

    • getParentFormLocation

      public String getParentFormLocation()
      Gets parent form location.
      Returns:
      the parent form location

    • getParentFormName

      public String getParentFormName()
      Gets parent form name.
      Returns:
      the parent form name

    • getParentModelForm

      public ModelForm getParentModelForm()
      Gets parent model form.
      Returns:
      the parent model form

    • getPassedRowCount

      public String getPassedRowCount(Map<String,Object> context)
      Gets passed row count.
      Parameters:
      context - the context
      Returns:
      the passed row count

    • getRowActions

      public List<ModelAction> getRowActions()
      Gets row actions.
      Returns:
      the row actions

    • getRowCount

      public String getRowCount()
      Gets row count.
      Returns:
      the row count

    • getSeparateColumns

      public boolean getSeparateColumns()
      Gets separate columns.
      Returns:
      the separate columns

    • getSkipEnd

      public boolean getSkipEnd()
      Gets skip end.
      Returns:
      the skip end

    • getSkipStart

      public boolean getSkipStart()
      Gets skip start.
      Returns:
      the skip start

    • getSortField

      public String getSortField(Map<String,Object> context)
      Gets sort field.
      Parameters:
      context - the context
      Returns:
      the sort field

    • getSortFieldParameterName

      public String getSortFieldParameterName()
      Gets sort field parameter name.
      Returns:
      the sort field parameter name

    • getSortOrderFields

      public List<ModelForm.SortField> getSortOrderFields()
      Gets sort order fields.
      Returns:
      the sort order fields

    • getStyleAltRowStyle

      public String getStyleAltRowStyle(Map<String,Object> context)
      iterate through alt-row-styles list to see if should be used, then add style
      Returns:
      The style for item row

    • getTarget

      public String getTarget()
      Gets target.
      Returns:
      the target

    • getTarget

      public String getTarget(Map<String,Object> context, String targetType)
      iterate through altTargets list to see if any should be used, if not return original target
      Returns:
      The target for this Form

    • getTargetType

      public String getTargetType()
      Gets target type.
      Returns:
      the target type

    • getTargetWindow

      public String getTargetWindow()
      Gets target window.
      Returns:
      the target window

    • getTargetWindow

      public String getTargetWindow(Map<String,Object> context)
      Gets target window.
      Parameters:
      context - the context
      Returns:
      the target window

    • getTitle

      public String getTitle()
      Gets title.
      Returns:
      the title

    • getEmptyFormDataMessage

      public String getEmptyFormDataMessage(Map<String,Object> context)
      Gets empty form data message.
      Parameters:
      context - the context
      Returns:
      the empty form data message

    • getTooltip

      public String getTooltip()
      Gets tooltip.
      Returns:
      the tooltip

    • getType

      public String getType()
      Gets type.
      Returns:
      the type

    • getUseRowSubmit

      public boolean getUseRowSubmit()
      Gets use row submit.
      Returns:
      the use row submit

    • getUseWhenFields

      public Set<String> getUseWhenFields()
      Gets use when fields.
      Returns:
      the use when fields

    • getGroupColumns

      public boolean getGroupColumns()
      Gets group columns.
      Returns:
      the group columns

    • isOverridenListSize

      public boolean isOverridenListSize()
      Is overriden list size boolean.
      Returns:
      the boolean

    • runFormActions

      public void runFormActions(Map<String,Object> context)
      Run form actions.
      Parameters:
      context - the context