SplitPairRule.Builder

fun build(): SplitPairRule

Builds a SplitPairRule instance.

fun setClearTop(clearTop: Boolean): SplitPairRule.Builder

Sets whether the existing secondary container on top and all activities in it should be destroyed when a new split is created using this rule. Otherwise the new secondary will appear on top by default.

fun setDefaultSplitAttributes(defaultSplitAttributes: SplitAttributes): SplitPairRule.Builder

Sets the default SplitAttributes to apply on the activity containers pair when the host task bounds satisfy minWidthDp, minHeightDp, minSmallestWidthDp, maxAspectRatioInPortrait and maxAspectRatioInLandscape requirements.

fun setFinishPrimaryWithSecondary(
    finishPrimaryWithSecondary: SplitRule.FinishBehavior
): SplitPairRule.Builder

Sets the behavior of the primary container when all activities are finished in the associated secondary container.

fun setFinishSecondaryWithPrimary(
    finishSecondaryWithPrimary: SplitRule.FinishBehavior
): SplitPairRule.Builder

Sets the behavior of the secondary container when all activities are finished in the associated primary container.

fun setMaxAspectRatioInLandscape(aspectRatio: EmbeddingAspectRatio): SplitPairRule.Builder

Sets the largest value of the aspect ratio, expressed as width / height in decimal form, of the parent window bounds in landscape when the split should be used. When the window aspect ratio is greater than requested here, activities in the secondary container will be stacked on top of the activities in the primary one, completely overlapping them.

This value is only used when the parent window is in landscape (width height).

The default is SPLIT_MAX_ASPECT_RATIO_LANDSCAPE_DEFAULT if the app doesn't set, which is the recommend value to always allow split when the parent window is in landscape.

fun setMaxAspectRatioInPortrait(aspectRatio: EmbeddingAspectRatio): SplitPairRule.Builder

Sets the largest value of the aspect ratio, expressed as height / width in decimal form, of the parent window bounds in portrait when the split should be used. When the window aspect ratio is greater than requested here, activities in the secondary container will be stacked on top of the activities in the primary one, completely overlapping them.

This value is only used when the parent window is in portrait (height >= width).

The default is SPLIT_MAX_ASPECT_RATIO_PORTRAIT_DEFAULT if the app doesn't set, which is the recommend value to only allow split when the parent window is not too stretched in portrait.

fun setMinHeightDp(minHeightDp: @IntRange(from = 0) Int): SplitPairRule.Builder

Sets the smallest value of height of the parent task window when the split should be used, in DP. When the window size is smaller than requested here, activities in the secondary container will be stacked on top of the activities in the primary one, completely overlapping them.

It is useful if it's necessary to split the parent window horizontally for this SplitPairRule.

The default is SPLIT_MIN_DIMENSION_DP_DEFAULT if the app doesn't set. SPLIT_MIN_DIMENSION_ALWAYS_ALLOW means to always allow split.

fun setMinSmallestWidthDp(minSmallestWidthDp: @IntRange(from = 0) Int): SplitPairRule.Builder

Sets the smallest value of the smallest possible width of the parent window in any rotation when the split should be used, in DP. When the window size is smaller than requested here, activities in the secondary container will be stacked on top of the activities in the primary one, completely overlapping them.

The default is SPLIT_MIN_DIMENSION_DP_DEFAULT if the app doesn't set. SPLIT_MIN_DIMENSION_ALWAYS_ALLOW means to always allow split.

fun setMinWidthDp(minWidthDp: @IntRange(from = 0) Int): SplitPairRule.Builder

Sets the smallest value of width of the parent window when the split should be used, in DP. When the window size is smaller than requested here, activities in the secondary container will be stacked on top of the activities in the primary one, completely overlapping them.

The default is SPLIT_MIN_DIMENSION_DP_DEFAULT if the app doesn't set. SPLIT_MIN_DIMENSION_ALWAYS_ALLOW means to always allow split.

fun setTag(tag: String?): SplitPairRule.Builder

Sets a unique string to identify this SplitPairRule, which defaults to null. The suggested usage is to set the tag to be able to differentiate between different rules in the SplitAttributesCalculatorParams.splitRuleTag.