Interface SectionalElement.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SectionalElement.Builder,SectionalElement>, SdkBuilder<SectionalElement.Builder,SectionalElement>, SdkPojo
Enclosing class:
SectionalElement
public static interface SectionalElement.Builder extends SdkPojo, CopyableBuilder<SectionalElement.Builder,SectionalElement>

  • Method Details

    • type

      SectionalElement.Builder type(String type)

      The type of sectional element. Valid values are Heading, Text, and Divider.

      Parameters:
      type - The type of sectional element. Valid values are Heading, Text, and Divider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • position

      SectionalElement.Builder position(FieldPosition position)

      Specifies the position of the text in a field for a Text sectional element.

      Parameters:
      position - Specifies the position of the text in a field for a Text sectional element.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • position

      default SectionalElement.Builder position(Consumer<FieldPosition.Builder> position)

      Specifies the position of the text in a field for a Text sectional element.

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

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

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

    • text

      SectionalElement.Builder text(String text)

      The text for a Text sectional element.

      Parameters:
      text - The text for a Text sectional element.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • level

      SectionalElement.Builder level(Integer level)

      Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.

      Parameters:
      level - Specifies the size of the font for a Heading sectional element. Valid values are 1 | 2 | 3 | 4 | 5 | 6.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • orientation

      SectionalElement.Builder orientation(String orientation)

      Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.

      Parameters:
      orientation - Specifies the orientation for a Divider sectional element. Valid values are horizontal or vertical.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excluded

      SectionalElement.Builder excluded(Boolean excluded)

      Excludes a sectional element that was generated by default for a specified data model.

      Parameters:
      excluded - Excludes a sectional element that was generated by default for a specified data model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.