Interface FieldInputConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FieldInputConfig.Builder,FieldInputConfig>, SdkBuilder<FieldInputConfig.Builder,FieldInputConfig>, SdkPojo
Enclosing class:
FieldInputConfig
@Mutable @NotThreadSafe public static interface FieldInputConfig.Builder extends SdkPojo, CopyableBuilder<FieldInputConfig.Builder,FieldInputConfig>

  • Method Details

    • type

      FieldInputConfig.Builder type(String type)

      The input type for the field.

      Parameters:
      type - The input type for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • required

      FieldInputConfig.Builder required(Boolean required)

      Specifies a field that requires input.

      Parameters:
      required - Specifies a field that requires input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readOnly

      FieldInputConfig.Builder readOnly(Boolean readOnly)

      Specifies a read only field.

      Parameters:
      readOnly - Specifies a read only field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placeholder

      FieldInputConfig.Builder placeholder(String placeholder)

      The text to display as a placeholder for the field.

      Parameters:
      placeholder - The text to display as a placeholder for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultValue

      FieldInputConfig.Builder defaultValue(String defaultValue)

      The default value for the field.

      Parameters:
      defaultValue - The default value for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • descriptiveText

      FieldInputConfig.Builder descriptiveText(String descriptiveText)

      The text to display to describe the field.

      Parameters:
      descriptiveText - The text to display to describe the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultChecked

      FieldInputConfig.Builder defaultChecked(Boolean defaultChecked)

      Specifies whether a field has a default value.

      Parameters:
      defaultChecked - Specifies whether a field has a default value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultCountryCode

      FieldInputConfig.Builder defaultCountryCode(String defaultCountryCode)

      The default country code for a phone number.

      Parameters:
      defaultCountryCode - The default country code for a phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • valueMappings

      FieldInputConfig.Builder valueMappings(ValueMappings valueMappings)

      The information to use to customize the input fields with data at runtime.

      Parameters:
      valueMappings - The information to use to customize the input fields with data at runtime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • valueMappings

      default FieldInputConfig.Builder valueMappings(Consumer<ValueMappings.Builder> valueMappings)

      The information to use to customize the input fields with data at runtime.

      This is a convenience method that creates an instance of the ValueMappings.Builder avoiding the need to create one manually via ValueMappings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to valueMappings(ValueMappings).

      Parameters:
      valueMappings - a consumer that will call methods on ValueMappings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      FieldInputConfig.Builder name(String name)

      The name of the field.

      Parameters:
      name - The name of the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minValue

      FieldInputConfig.Builder minValue(Float minValue)

      The minimum value to display for the field.

      Parameters:
      minValue - The minimum value to display for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxValue

      FieldInputConfig.Builder maxValue(Float maxValue)

      The maximum value to display for the field.

      Parameters:
      maxValue - The maximum value to display for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • step

      FieldInputConfig.Builder step(Float step)

      The stepping increment for a numeric value in a field.

      Parameters:
      step - The stepping increment for a numeric value in a field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • value

      FieldInputConfig.Builder value(String value)

      The value for the field.

      Parameters:
      value - The value for the field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isArray

      FieldInputConfig.Builder isArray(Boolean isArray)

      Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.

      Parameters:
      isArray - Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileUploaderConfig

      FieldInputConfig.Builder fileUploaderConfig(FileUploaderFieldConfig fileUploaderConfig)

      The configuration for the file uploader field.

      Parameters:
      fileUploaderConfig - The configuration for the file uploader field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileUploaderConfig

      default FieldInputConfig.Builder fileUploaderConfig(Consumer<FileUploaderFieldConfig.Builder> fileUploaderConfig)

      The configuration for the file uploader field.

      This is a convenience method that creates an instance of the FileUploaderFieldConfig.Builder avoiding the need to create one manually via FileUploaderFieldConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fileUploaderConfig(FileUploaderFieldConfig).

      Parameters:
      fileUploaderConfig - a consumer that will call methods on FileUploaderFieldConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: