PrimaryLayout.Builder
public final class PrimaryLayout.Builder
Builder class for PrimaryLayout.
Summary
Public constructors |
|---|
Builder(Creates a builder for the |
Public methods |
|
|---|---|
@NonNull PrimaryLayout |
build()Constructs and returns |
@NonNull PrimaryLayout.Builder |
Sets the additional content to this layout, above the primary chip. |
@NonNull PrimaryLayout.Builder |
setPrimaryChipContent(Sets the element which is in the slot at the bottom of the layout. |
@NonNull PrimaryLayout.Builder |
setPrimaryLabelTextContent(Sets the content in the primary label slot which will be above the main content. |
@NonNull PrimaryLayout.Builder |
setResponsiveContentInsetEnabled(boolean enabled)Changes this |
@NonNull PrimaryLayout.Builder |
setSecondaryLabelTextContent(Sets the content in the primary label slot which will be below the main content. |
@NonNull PrimaryLayout.Builder |
setVerticalSpacerHeight(@Dimension(unit = 0) float height)Sets the vertical spacer height which is used as a space between main content and secondary label if there is any. |
Public constructors
Builder
public Builder(
@NonNull DeviceParametersBuilders.DeviceParameters deviceParameters
)
Creates a builder for the PrimaryLayout from the given content. Content inside of it can later be set with setContent, setPrimaryChipContent, setPrimaryLabelTextContent and setSecondaryLabelTextContent.
For optimal layouts across different screen sizes, it is highly recommended to call setResponsiveContentInsetEnabled.
Public methods
build
public @NonNull PrimaryLayout build()
Constructs and returns PrimaryLayout with the provided content and look.
setContent
public @NonNull PrimaryLayout.Builder setContent(@NonNull LayoutElementBuilders.LayoutElement content)
Sets the additional content to this layout, above the primary chip.
The content slot will wrap the elements' height, so the height of the given content must be fixed or set to wrap (expand can't be used).
This layout has built-in horizontal margins, so the given content should have width set to expand to use all the available space, rather than an explicit width which may lead to clipping.
setPrimaryChipContent
public @NonNull PrimaryLayout.Builder setPrimaryChipContent(
@NonNull LayoutElementBuilders.LayoutElement compactChip
)
Sets the element which is in the slot at the bottom of the layout. Note that it is accepted to pass in any LayoutElement, but it is strongly recommended to add a CompactChip as the layout is optimized for it.
setPrimaryLabelTextContent
public @NonNull PrimaryLayout.Builder setPrimaryLabelTextContent(
@NonNull LayoutElementBuilders.LayoutElement primaryLabelText
)
Sets the content in the primary label slot which will be above the main content.
setResponsiveContentInsetEnabled
public @NonNull PrimaryLayout.Builder setResponsiveContentInsetEnabled(boolean enabled)
Changes this PrimaryLayout to use responsive insets for its content (primary label, secondary label and primary bottom chip) by adding an additional space on the side of this element to avoid that content going off the screen edge.
It is highly recommended to call this method with true when using this layout to optimize it for different screen sizes.
setSecondaryLabelTextContent
public @NonNull PrimaryLayout.Builder setSecondaryLabelTextContent(
@NonNull LayoutElementBuilders.LayoutElement secondaryLabelText
)
Sets the content in the primary label slot which will be below the main content. It is highly recommended to have primary label set when having secondary label.
setVerticalSpacerHeight
public @NonNull PrimaryLayout.Builder setVerticalSpacerHeight(@Dimension(unit = 0) float height)
Sets the vertical spacer height which is used as a space between main content and secondary label if there is any. If not set, DEFAULT_VERTICAL_SPACER_HEIGHT will be used.