Class SectionalElement

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.SectionalElement
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SectionalElement.Builder,SectionalElement>
@Generated("software.amazon.awssdk:codegen") public final class SectionalElement extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SectionalElement.Builder,SectionalElement>

Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.

See Also:

  • Method Details

    • type

      public final String type()

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

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

    • position

      public final FieldPosition position()

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

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

    • text

      public final String text()

      The text for a Text sectional element.

      Returns:
      The text for a Text sectional element.

    • level

      public final Integer level()

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

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

    • orientation

      public final String orientation()

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

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

    • excluded

      public final Boolean excluded()

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

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

    • toBuilder

      public SectionalElement.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SectionalElement.Builder,SectionalElement>
      Returns:
      a builder for type T

    • builder

      public static SectionalElement.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SectionalElement.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.