Interface LayoutConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LayoutConfiguration.Builder,LayoutConfiguration>, SdkBuilder<LayoutConfiguration.Builder,LayoutConfiguration>, SdkPojo

Enclosing class:

LayoutConfiguration

@Mutable
@NotThreadSafe
public static interface LayoutConfiguration.Builder
extends SdkPojo, CopyableBuilder<LayoutConfiguration.Builder,LayoutConfiguration>

Method Summary

Modifier and Type	Method	Description
default LayoutConfiguration.Builder	freeFormLayout(Consumer<FreeFormLayoutConfiguration.Builder> freeFormLayout)	A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
LayoutConfiguration.Builder	freeFormLayout(FreeFormLayoutConfiguration freeFormLayout)	A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
default LayoutConfiguration.Builder	gridLayout(Consumer<GridLayoutConfiguration.Builder> gridLayout)	A type of layout that can be used on a sheet.
LayoutConfiguration.Builder	gridLayout(GridLayoutConfiguration gridLayout)	A type of layout that can be used on a sheet.
default LayoutConfiguration.Builder	sectionBasedLayout(Consumer<SectionBasedLayoutConfiguration.Builder> sectionBasedLayout)	A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
LayoutConfiguration.Builder	sectionBasedLayout(SectionBasedLayoutConfiguration sectionBasedLayout)	A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

gridLayout

LayoutConfiguration.Builder gridLayout(GridLayoutConfiguration gridLayout)

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

Parameters:

gridLayout - A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

Returns:

Returns a reference to this object so that method calls can be chained together.

gridLayout

default LayoutConfiguration.Builder gridLayout(Consumer<GridLayoutConfiguration.Builder> gridLayout)

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

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

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

Parameters:

gridLayout - a consumer that will call methods on GridLayoutConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• gridLayout(GridLayoutConfiguration)

freeFormLayout

LayoutConfiguration.Builder freeFormLayout(FreeFormLayoutConfiguration freeFormLayout)

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

Parameters:

freeFormLayout - A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

Returns:

Returns a reference to this object so that method calls can be chained together.

freeFormLayout

default LayoutConfiguration.Builder freeFormLayout(Consumer<FreeFormLayoutConfiguration.Builder> freeFormLayout)

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

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

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

Parameters:

freeFormLayout - a consumer that will call methods on FreeFormLayoutConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• freeFormLayout(FreeFormLayoutConfiguration)

sectionBasedLayout

LayoutConfiguration.Builder sectionBasedLayout(SectionBasedLayoutConfiguration sectionBasedLayout)

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

Parameters:

sectionBasedLayout - A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

Returns:

Returns a reference to this object so that method calls can be chained together.

sectionBasedLayout

default LayoutConfiguration.Builder sectionBasedLayout(Consumer<SectionBasedLayoutConfiguration.Builder> sectionBasedLayout)

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

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

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

Parameters:

sectionBasedLayout - a consumer that will call methods on SectionBasedLayoutConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sectionBasedLayout(SectionBasedLayoutConfiguration)