Class ModelFormFieldBuilder

java.lang.Object
org.apache.ofbiz.widget.model.ModelFormFieldBuilder

public class ModelFormFieldBuilder extends Object
A ModelFormField builder.
  • Field Details

    • NUMERIC_FIELD_TYPES

      protected static final List<String> NUMERIC_FIELD_TYPES
    • TEXT_FIELD_TYPES

      protected static final List<String> TEXT_FIELD_TYPES
    • TEXT_SIZE_BY_FIELD_TYPES

      protected static final Map<String,Integer> TEXT_SIZE_BY_FIELD_TYPES
    • TEXT_MAX_SIZE_BY_FIELD_TYPES

      protected static final Map<String,Integer> TEXT_MAX_SIZE_BY_FIELD_TYPES
    • DATA_FIELD_TYPES

      protected static final List<String> DATA_FIELD_TYPES
  • Constructor Details

    • ModelFormFieldBuilder

      public ModelFormFieldBuilder()
    • ModelFormFieldBuilder

      public ModelFormFieldBuilder(Element fieldElement, ModelForm modelForm, ModelReader entityModelReader, DispatchContext dispatchContext)
      XML Constructor
    • ModelFormFieldBuilder

      public ModelFormFieldBuilder(ModelFormField modelFormField)
    • ModelFormFieldBuilder

      public ModelFormFieldBuilder(ModelFormFieldBuilder builder)
  • Method Details

    • addOnChangeUpdateArea

      public ModelFormFieldBuilder addOnChangeUpdateArea(ModelForm.UpdateArea onChangeUpdateArea)
      Add on change update area model form field builder.*
      Parameters:
      onChangeUpdateArea - the on change update area
      Returns:
      the model form field builder
    • addOnClickUpdateArea

      public ModelFormFieldBuilder addOnClickUpdateArea(ModelForm.UpdateArea onClickUpdateArea)
      Add on click update area model form field builder.*
      Parameters:
      onClickUpdateArea - the on click update area
      Returns:
      the model form field builder
    • build

      public ModelFormField build()
      Build model form field.*
      Returns:
      the model form field
    • getAction

      public FlexibleStringExpander getAction()
      Gets action.*
      Returns:
      the action
    • getAttributeName

      public String getAttributeName()
      Gets attribute name.*
      Returns:
      the attribute name
    • getEncodeOutput

      public boolean getEncodeOutput()
      Gets encode output.*
      Returns:
      the encode output
    • getEntityName

      public String getEntityName()
      Gets entity name.*
      Returns:
      the entity name
    • getEntryAcsr

      public FlexibleMapAccessor<Object> getEntryAcsr()
      Gets entry acsr.*
      Returns:
      the entry acsr
    • getEvent

      public String getEvent()
      Gets event.*
      Returns:
      the event
    • getFieldInfo

      public FieldInfo getFieldInfo()
      Gets field info.*
      Returns:
      the field info
    • getFieldName

      public String getFieldName()
      Gets field name.*
      Returns:
      the field name
    • getFieldType

      public String getFieldType()
      Gets field type.*
      Returns:
      the field type
    • getHeaderLink

      public String getHeaderLink()
      Gets header link.*
      Returns:
      the header link
    • getHeaderLinkStyle

      public String getHeaderLinkStyle()
      Gets header link style.*
      Returns:
      the header link style
    • getIdName

      public String getIdName()
      Gets id name.*
      Returns:
      the id name
    • getMapAcsr

      public FlexibleMapAccessor<Map<String,? extends Object>> getMapAcsr()
      Gets map acsr.*
      Returns:
      the map acsr
    • getModelForm

      public ModelForm getModelForm()
      Gets model form.*
      Returns:
      the model form
    • getName

      public String getName()
      Gets name.*
      Returns:
      the name
    • getOnChangeUpdateAreas

      public List<ModelForm.UpdateArea> getOnChangeUpdateAreas()
      Gets on change update areas.*
      Returns:
      the on change update areas
    • getOnClickUpdateAreas

      public List<ModelForm.UpdateArea> getOnClickUpdateAreas()
      Gets on click update areas.*
      Returns:
      the on click update areas
    • getParameterName

      public FlexibleStringExpander getParameterName()
      Gets parameter name.*
      Returns:
      the parameter name
    • getPosition

      public Integer getPosition()
      Gets position.*
      Returns:
      the position
    • getRedWhen

      public String getRedWhen()
      Gets red when.*
      Returns:
      the red when
    • getRequiredField

      public Boolean getRequiredField()
      Gets required field.*
      Returns:
      the required field
    • getRequiredFieldStyle

      public String getRequiredFieldStyle()
      Gets required field style.*
      Returns:
      the required field style
    • getSeparateColumn

      public boolean getSeparateColumn()
      Gets separate column.*
      Returns:
      the separate column
    • getServiceName

      public String getServiceName()
      Gets service name.*
      Returns:
      the service name
    • getSortField

      public Boolean getSortField()
      Gets sort field.*
      Returns:
      the sort field
    • getSortFieldAscStyle

      public String getSortFieldAscStyle()
      Gets sort field asc style.*
      Returns:
      the sort field asc style
    • getSortFieldDescStyle

      public String getSortFieldDescStyle()
      Gets sort field desc style.*
      Returns:
      the sort field desc style
    • getSortFieldHelpText

      public String getSortFieldHelpText()
      Gets sort field help text.*
      Returns:
      the sort field help text
    • getSortFieldStyle

      public String getSortFieldStyle()
      Gets sort field style.*
      Returns:
      the sort field style
    • getTitle

      public FlexibleStringExpander getTitle()
      Gets title.*
      Returns:
      the title
    • getTitleAreaStyle

      public String getTitleAreaStyle()
      Gets title area style.*
      Returns:
      the title area style
    • getTitleStyle

      public String getTitleStyle()
      Gets title style.*
      Returns:
      the title style
    • getTooltip

      public FlexibleStringExpander getTooltip()
      Gets tooltip.*
      Returns:
      the tooltip
    • getTooltipStyle

      public String getTooltipStyle()
      Gets tooltip style.*
      Returns:
      the tooltip style
    • getUseWhen

      public FlexibleStringExpander getUseWhen()
      Gets use when.*
      Returns:
      the use when
    • getIgnoreWhen

      public FlexibleStringExpander getIgnoreWhen()
      Gets ignore when.*
      Returns:
      the ignore when
    • getWidgetAreaStyle

      public String getWidgetAreaStyle()
      Gets widget area style.*
      Returns:
      the widget area style
    • getWidgetStyle

      public String getWidgetStyle()
      Gets widget style.*
      Returns:
      the widget style
    • getParentFormName

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

      public String getTabindex()
      Gets tabindex.*
      Returns:
      the tabindex
    • getConditionGroup

      public String getConditionGroup()
      Gets condition group.*
      Returns:
      the condition group
    • getDisabledSpec

      public FlexibleStringExpander getDisabledSpec()
      Gets disabled.*
      Returns:
      the disabled
    • induceFieldInfoFromEntityField

      public boolean induceFieldInfoFromEntityField(ModelEntity modelEntity, ModelField modelField, String defaultFieldType)
      Induce field info from entity field boolean.
      Parameters:
      modelEntity - the model entity
      modelField - the model field
      defaultFieldType - the default field type
      Returns:
      the boolean
    • induceFieldInfoFromServiceParam

      public boolean induceFieldInfoFromServiceParam(ModelService modelService, ModelParam modelParam, String defaultFieldType)
      Induce field info from service param boolean.
      Parameters:
      modelService - the model service
      modelParam - the model param
      defaultFieldType - the default field type
      Returns:
      the boolean
    • mergeOverrideModelFormField

      public void mergeOverrideModelFormField(ModelFormFieldBuilder builder)
      Merge override model form field.
      Parameters:
      builder - the builder
    • setAction

      public ModelFormFieldBuilder setAction(String action)
      Sets action.*
      Parameters:
      action - the action
      Returns:
      the action
    • setAttributeName

      public ModelFormFieldBuilder setAttributeName(String attributeName)
      Sets attribute name.*
      Parameters:
      attributeName - the attribute name
      Returns:
      the attribute name
    • setEncodeOutput

      public ModelFormFieldBuilder setEncodeOutput(boolean encodeOutput)
      Sets encode output.*
      Parameters:
      encodeOutput - the encode output
      Returns:
      the encode output
    • setEntityName

      public ModelFormFieldBuilder setEntityName(String entityName)
      Sets entity name.*
      Parameters:
      entityName - the entity name
      Returns:
      the entity name
    • setEntryName

      public ModelFormFieldBuilder setEntryName(String entryName)
      Sets entry name.*
      Parameters:
      entryName - the entry name
      Returns:
      the entry name
    • setEvent

      public ModelFormFieldBuilder setEvent(String event)
      Sets event.*
      Parameters:
      event - the event
      Returns:
      the event
    • setFieldInfo

      public ModelFormFieldBuilder setFieldInfo(FieldInfo fieldInfo)
      Sets field info.*
      Parameters:
      fieldInfo - the field info
      Returns:
      the field info
    • setFieldName

      public ModelFormFieldBuilder setFieldName(String fieldName)
      Sets field name.*
      Parameters:
      fieldName - the field name
      Returns:
      the field name
    • setFieldType

      public ModelFormFieldBuilder setFieldType(String fieldType)
      Sets field type.*
      Parameters:
      fieldType - the field type
      Returns:
      the field type
    • setHeaderLink

      public ModelFormFieldBuilder setHeaderLink(String headerLink)
      Sets header link.*
      Parameters:
      headerLink - the header link
      Returns:
      the header link
    • setHeaderLinkStyle

      public ModelFormFieldBuilder setHeaderLinkStyle(String headerLinkStyle)
      Sets header link style.*
      Parameters:
      headerLinkStyle - the header link style
      Returns:
      the header link style
    • setIdName

      public ModelFormFieldBuilder setIdName(String idName)
      Sets id name.*
      Parameters:
      idName - the id name
      Returns:
      the id name
    • setMapName

      public ModelFormFieldBuilder setMapName(String mapName)
      Sets map name.*
      Parameters:
      mapName - the map name
      Returns:
      the map name
    • setModelForm

      public ModelFormFieldBuilder setModelForm(ModelForm modelForm)
      Sets model form.*
      Parameters:
      modelForm - the model form
      Returns:
      the model form
    • setName

      public ModelFormFieldBuilder setName(String name)
      Sets name.*
      Parameters:
      name - the name
      Returns:
      the name
    • setParameterName

      public ModelFormFieldBuilder setParameterName(String parameterName)
      Sets parameter name.*
      Parameters:
      parameterName - the parameter name
      Returns:
      the parameter name
    • setPosition

      public ModelFormFieldBuilder setPosition(Integer position)
      Sets position.*
      Parameters:
      position - the position
      Returns:
      the position
    • setRedWhen

      public ModelFormFieldBuilder setRedWhen(String redWhen)
      Sets red when.*
      Parameters:
      redWhen - the red when
      Returns:
      the red when
    • setRequiredField

      public ModelFormFieldBuilder setRequiredField(Boolean requiredField)
      Sets required field.*
      Parameters:
      requiredField - the required field
      Returns:
      the required field
    • setRequiredFieldStyle

      public ModelFormFieldBuilder setRequiredFieldStyle(String requiredFieldStyle)
      Sets required field style.*
      Parameters:
      requiredFieldStyle - the required field style
      Returns:
      the required field style
    • setSeparateColumn

      public ModelFormFieldBuilder setSeparateColumn(boolean separateColumn)
      Sets separate column.*
      Parameters:
      separateColumn - the separate column
      Returns:
      the separate column
    • setServiceName

      public ModelFormFieldBuilder setServiceName(String serviceName)
      Sets service name.*
      Parameters:
      serviceName - the service name
      Returns:
      the service name
    • setSortField

      public ModelFormFieldBuilder setSortField(Boolean sortField)
      Sets sort field.*
      Parameters:
      sortField - the sort field
      Returns:
      the sort field
    • setSortFieldAscStyle

      public ModelFormFieldBuilder setSortFieldAscStyle(String sortFieldAscStyle)
      Sets sort field asc style.*
      Parameters:
      sortFieldAscStyle - the sort field asc style
      Returns:
      the sort field asc style
    • setSortFieldDescStyle

      public ModelFormFieldBuilder setSortFieldDescStyle(String sortFieldDescStyle)
      Sets sort field desc style.*
      Parameters:
      sortFieldDescStyle - the sort field desc style
      Returns:
      the sort field desc style
    • setSortFieldHelpText

      public ModelFormFieldBuilder setSortFieldHelpText(String sortFieldHelpText)
      Sets sort field help text.*
      Parameters:
      sortFieldHelpText - the sort field help text
      Returns:
      the sort field help text
    • setSortFieldStyle

      public ModelFormFieldBuilder setSortFieldStyle(String sortFieldStyle)
      Sets sort field style.*
      Parameters:
      sortFieldStyle - the sort field style
      Returns:
      the sort field style
    • setTitle

      public ModelFormFieldBuilder setTitle(String title)
      Sets title.*
      Parameters:
      title - the title
      Returns:
      the title
    • setTitleAreaStyle

      public ModelFormFieldBuilder setTitleAreaStyle(String titleAreaStyle)
      Sets title area style.*
      Parameters:
      titleAreaStyle - the title area style
      Returns:
      the title area style
    • setTitleStyle

      public ModelFormFieldBuilder setTitleStyle(String titleStyle)
      Sets title style.*
      Parameters:
      titleStyle - the title style
      Returns:
      the title style
    • setTooltip

      public ModelFormFieldBuilder setTooltip(String tooltip)
      Sets tooltip.*
      Parameters:
      tooltip - the tooltip
      Returns:
      the tooltip
    • setTooltipStyle

      public ModelFormFieldBuilder setTooltipStyle(String tooltipStyle)
      Sets tooltip style.*
      Parameters:
      tooltipStyle - the tooltip style
      Returns:
      the tooltip style
    • setUseWhen

      public ModelFormFieldBuilder setUseWhen(String useWhen)
      Sets use when.*
      Parameters:
      useWhen - the use when
      Returns:
      the use when
    • setWidgetAreaStyle

      public ModelFormFieldBuilder setWidgetAreaStyle(String widgetAreaStyle)
      Sets widget area style.*
      Parameters:
      widgetAreaStyle - the widget area style
      Returns:
      the widget area style
    • setWidgetStyle

      public ModelFormFieldBuilder setWidgetStyle(String widgetStyle)
      Sets widget style.*
      Parameters:
      widgetStyle - the widget style
      Returns:
      the widget style
    • setParentFormName

      public ModelFormFieldBuilder setParentFormName(String parentFormName)
      Sets parent form name.*
      Parameters:
      parentFormName - the parent form name
      Returns:
      the parent form name
    • setTabindex

      public ModelFormFieldBuilder setTabindex(String tabindex)
      Sets tabindex.*
      Parameters:
      tabindex - the tabindex
      Returns:
      the tabindex
    • setConditionGroup

      public ModelFormFieldBuilder setConditionGroup(String conditionGroup)
      Sets condition group.*
      Parameters:
      conditionGroup - the condition group
      Returns:
      the condition group