Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnForm.SectionalElementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnForm.SectionalElementProperty.Jsii$Proxy

Enclosing class:

CfnForm

@Stability(Stable)
public static interface CfnForm.SectionalElementProperty
extends software.amazon.jsii.JsiiSerializable

The SectionalElement property specifies 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplifyuibuilder.*;
 SectionalElementProperty sectionalElementProperty = SectionalElementProperty.builder()
         .type("type")
         // the properties below are optional
         .excluded(false)
         .level(123)
         .orientation("orientation")
         .position(FieldPositionProperty.builder()
                 .below("below")
                 .fixed("fixed")
                 .rightOf("rightOf")
                 .build())
         .text("text")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnForm.SectionalElementProperty.Builder	A builder for CfnForm.SectionalElementProperty
static final class	CfnForm.SectionalElementProperty.Jsii$Proxy	An implementation for CfnForm.SectionalElementProperty

Method Summary

Modifier and Type	Method	Description
static CfnForm.SectionalElementProperty.Builder	builder()
default Object	getExcluded()	Excludes a sectional element that was generated by default for a specified data model.
default Number	getLevel()	Specifies the size of the font for a Heading sectional element.
default String	getOrientation()	Specifies the orientation for a Divider sectional element.
default Object	getPosition()	Specifies the position of the text in a field for a Text sectional element.
default String	getText()	The text for a Text sectional element.
String	getType()	The type of sectional element.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of sectional element.

Valid values are Heading , Text , and Divider .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-type

getExcluded

@Stability(Stable)
@Nullable
default Object getExcluded()

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-excluded

getLevel

@Stability(Stable)
@Nullable
default Number getLevel()

Specifies the size of the font for a Heading sectional element.

Valid values are 1 | 2 | 3 | 4 | 5 | 6 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-level

getOrientation

@Stability(Stable)
@Nullable
default String getOrientation()

Specifies the orientation for a Divider sectional element.

Valid values are horizontal or vertical .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-orientation

getPosition

@Stability(Stable)
@Nullable
default Object getPosition()

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

Returns union: either IResolvable or CfnForm.FieldPositionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-position

getText

@Stability(Stable)
@Nullable
default String getText()

The text for a Text sectional element.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-text

builder

@Stability(Stable)
static CfnForm.SectionalElementProperty.Builder builder()

Returns:

a CfnForm.SectionalElementProperty.Builder of CfnForm.SectionalElementProperty