SplitPinRule.Builder

Kotlin |Java

class SplitPinRule.Builder

Builder for SplitPinRule.

Summary

Public constructors
`Builder()`

Public functions
`SplitPinRule`	`build()` Builds a `SplitPinRule` instance.
`SplitPinRule.Builder`	`setDefaultSplitAttributes(defaultSplitAttributes: SplitAttributes)` Sets the default `SplitAttributes` to apply on the activity containers pair when the host task bounds satisfy `minWidthDp`, `minHeightDp`, `minSmallestWidthDp`, `maxAspectRatioInPortrait` and `maxAspectRatioInLandscape` requirements.
`SplitPinRule.Builder`	`setMaxAspectRatioInLandscape(aspectRatio: EmbeddingAspectRatio)` 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.
`SplitPinRule.Builder`	`setMaxAspectRatioInPortrait(aspectRatio: EmbeddingAspectRatio)` 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.
`SplitPinRule.Builder`	`setMinHeightDp(minHeightDp: @IntRange(from = 0) Int)` Sets the smallest value of height of the parent task window when the split should be used, in DP.
`SplitPinRule.Builder`	`setMinSmallestWidthDp(minSmallestWidthDp: @IntRange(from = 0) Int)` Sets the smallest value of the smallest possible width of the parent window in any rotation when the split should be used, in DP.
`SplitPinRule.Builder`	`setMinWidthDp(minWidthDp: @IntRange(from = 0) Int)` Sets the smallest value of width of the parent window when the split should be used, in DP.
`SplitPinRule.Builder`	`setSticky(isSticky: Boolean)` Sets this rule to be sticky.
`SplitPinRule.Builder`	`setTag(tag: String?)` Sets a unique string to identify this `SplitPinRule`, which defaults to `null`.

Public constructors

Builder

Added in 1.4.0-alpha05

Builder()

Public functions

build

Added in 1.4.0-alpha05

fun build(): SplitPinRule

Builds a SplitPinRule instance.

Returns
`SplitPinRule`	The new `SplitPinRule` instance.

setDefaultSplitAttributes

Added in 1.4.0-alpha05

fun setDefaultSplitAttributes(defaultSplitAttributes: SplitAttributes): SplitPinRule.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.

Parameters
`defaultSplitAttributes: SplitAttributes`	the default `SplitAttributes` to apply on the activity containers pair when the host task bounds satisfy all the rule requirements.

setMaxAspectRatioInLandscape

Added in 1.4.0-alpha05

fun setMaxAspectRatioInLandscape(aspectRatio: EmbeddingAspectRatio): SplitPinRule.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.

Parameters
`aspectRatio: EmbeddingAspectRatio`	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.

See also
`ratio`
`ALWAYS_ALLOW`
`ALWAYS_DISALLOW`

setMaxAspectRatioInPortrait

Added in 1.4.0-alpha05

fun setMaxAspectRatioInPortrait(aspectRatio: EmbeddingAspectRatio): SplitPinRule.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.

Parameters
`aspectRatio: EmbeddingAspectRatio`	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.

See also
`ratio`
`ALWAYS_ALLOW`
`ALWAYS_DISALLOW`

setMinHeightDp

Added in 1.4.0-alpha05

fun setMinHeightDp(minHeightDp: @IntRange(from = 0) Int): SplitPinRule.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 SplitPinRule.

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

Parameters
`minHeightDp: @IntRange(from = 0) Int`	the smallest value of height of the parent task window when the split should be used, in DP.

See also
`TOP_TO_BOTTOM`
`BOTTOM_TO_TOP`

setMinSmallestWidthDp

Added in 1.4.0-alpha05

fun setMinSmallestWidthDp(minSmallestWidthDp: @IntRange(from = 0) Int): SplitPinRule.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.

Parameters
`minSmallestWidthDp: @IntRange(from = 0) Int`	the smallest value of the smallest possible width of the parent window in any rotation when the split should be used, in DP.

setMinWidthDp

Added in 1.4.0-alpha05

fun setMinWidthDp(minWidthDp: @IntRange(from = 0) Int): SplitPinRule.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.

Parameters
`minWidthDp: @IntRange(from = 0) Int`	the smallest value of width of the parent window when the split should be used, in DP.

setSticky

Added in 1.4.0-alpha05

fun setSticky(isSticky: Boolean): SplitPinRule.Builder

Sets this rule to be sticky.

Parameters
`isSticky: Boolean`	whether to be a sticky rule.

See also
`setSticky`

setTag

Added in 1.4.0-alpha05

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

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

Parameters
`tag: String?`	unique string to identify this `SplitPinRule`.