# SplitPairRule.Builder

Artifact: [androidx.window:window](https://developer.android.com/jetpack/androidx/releases/window) [View Source](https://cs.android.com/search?q=file:androidx/window/embedding/SplitPairRule.kt+class:androidx.window.embedding.SplitPairRule.Builder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

*** ** * ** ***


```
public final class SplitPairRule.Builder
```

<br />

*** ** * ** ***

Builder for `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#Builder(kotlin.collections.Set)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairFilter> filters)` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#build()()` Builds a `SplitPairRule` instance. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setClearTop(kotlin.Boolean)(boolean clearTop)` 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. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setDefaultSplitAttributes(androidx.window.embedding.SplitAttributes)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitAttributes defaultSplitAttributes )` Sets the default `https://developer.android.com/reference/androidx/window/embedding/SplitAttributes` to apply on the activity containers pair when the host task bounds satisfy `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#minWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#minHeightDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#minSmallestWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#maxAspectRatioInPortrait()` and `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#maxAspectRatioInLandscape()` requirements. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setFinishPrimaryWithSecondary(androidx.window.embedding.SplitRule.FinishBehavior)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior finishPrimaryWithSecondary )` Sets the behavior of the primary container when all activities are finished in the associated secondary container. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setFinishSecondaryWithPrimary(androidx.window.embedding.SplitRule.FinishBehavior)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior finishSecondaryWithPrimary )` Sets the behavior of the secondary container when all activities are finished in the associated primary container. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setMaxAspectRatioInLandscape(androidx.window.embedding.EmbeddingAspectRatio)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio aspectRatio)` 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. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setMaxAspectRatioInPortrait(androidx.window.embedding.EmbeddingAspectRatio)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio aspectRatio)` 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. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setMinHeightDp(kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int minHeightDp)` Sets the smallest value of height of the parent task window when the split should be used, in DP. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setMinSmallestWidthDp(kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int minSmallestWidthDp)` Sets the smallest value of the smallest possible width of the parent window in any rotation when the split should be used, in DP. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setMinWidthDp(kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int minWidthDp)` Sets the smallest value of width of the parent window when the split should be used, in DP. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#setTag(kotlin.String)(https://developer.android.com/reference/java/lang/String.html tag)` Sets a unique string to identify this `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule`, which defaults to `null`. |

## Public constructors

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public Builder(@NonNull Set<@NonNull SplitPairFilter> filters)
```

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairFilter> filters` | Filters used to choose when to apply this rule. The rule may be used if any one of the provided filters matches. |

## Public methods

### build

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule build()
```

Builds a `SplitPairRule` instance.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPairRule` | The new `SplitPairRule` instance. |

### setClearTop

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setClearTop(boolean clearTop)
```

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.

| Parameters |
|---|---|
| `boolean clearTop` | whether the existing secondary container on top and all activities in it should be destroyed when a new split is created using this rule. |

### setDefaultSplitAttributes

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setDefaultSplitAttributes(
    @NonNull SplitAttributes defaultSplitAttributes
)
```

Sets the default `https://developer.android.com/reference/androidx/window/embedding/SplitAttributes` to apply on the activity containers pair when the host task bounds satisfy `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#minWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#minHeightDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#minSmallestWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#maxAspectRatioInPortrait()` and `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule.Builder#maxAspectRatioInLandscape()` requirements.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitAttributes defaultSplitAttributes` | the default `https://developer.android.com/reference/androidx/window/embedding/SplitAttributes` to apply on the activity containers pair when the host task bounds satisfy all the rule requirements. |

### setFinishPrimaryWithSecondary

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setFinishPrimaryWithSecondary(
    @NonNull SplitRule.FinishBehavior finishPrimaryWithSecondary
)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior finishPrimaryWithSecondary` | the `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior` of the primary container when all activities are finished in the associated secondary container. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior#NEVER()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior#ALWAYS()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior#ADJACENT()` |   |

### setFinishSecondaryWithPrimary

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setFinishSecondaryWithPrimary(
    @NonNull SplitRule.FinishBehavior finishSecondaryWithPrimary
)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior finishSecondaryWithPrimary` | the `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior` of the secondary container when all activities are finished in the associated primary container. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior#NEVER()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior#ALWAYS()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/SplitRule.FinishBehavior#ADJACENT()` |   |

### setMaxAspectRatioInLandscape

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setMaxAspectRatioInLandscape(@NonNull EmbeddingAspectRatio aspectRatio)
```

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 `https://developer.android.com/reference/androidx/window/embedding/SplitRule#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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio aspectRatio` | 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 |
|---|---|
| `https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio#ratio(kotlin.Float)` |   |
| `https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio#ALWAYS_ALLOW()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio#ALWAYS_DISALLOW()` |   |

### setMaxAspectRatioInPortrait

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setMaxAspectRatioInPortrait(@NonNull EmbeddingAspectRatio aspectRatio)
```

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 `https://developer.android.com/reference/androidx/window/embedding/SplitRule#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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio aspectRatio` | 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 |
|---|---|
| `https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio#ratio(kotlin.Float)` |   |
| `https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio#ALWAYS_ALLOW()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio#ALWAYS_DISALLOW()` |   |

### setMinHeightDp

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setMinHeightDp(@IntRange(from = 0) int minHeightDp)
```

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 `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule`.

The default is `https://developer.android.com/reference/androidx/window/embedding/SplitRule#SPLIT_MIN_DIMENSION_DP_DEFAULT()` if the app doesn't set. `https://developer.android.com/reference/androidx/window/embedding/SplitRule#SPLIT_MIN_DIMENSION_ALWAYS_ALLOW()` means to always allow split.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int minHeightDp` | the smallest value of height of the parent task window when the split should be used, in DP. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/window/embedding/SplitAttributes.LayoutDirection#TOP_TO_BOTTOM()` |   |
| `https://developer.android.com/reference/androidx/window/embedding/SplitAttributes.LayoutDirection#BOTTOM_TO_TOP()` |   |

### setMinSmallestWidthDp

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setMinSmallestWidthDp(@IntRange(from = 0) int minSmallestWidthDp)
```

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 `https://developer.android.com/reference/androidx/window/embedding/SplitRule#SPLIT_MIN_DIMENSION_DP_DEFAULT()` if the app doesn't set. `https://developer.android.com/reference/androidx/window/embedding/SplitRule#SPLIT_MIN_DIMENSION_ALWAYS_ALLOW()` means to always allow split.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int minSmallestWidthDp` | 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.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setMinWidthDp(@IntRange(from = 0) int minWidthDp)
```

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 `https://developer.android.com/reference/androidx/window/embedding/SplitRule#SPLIT_MIN_DIMENSION_DP_DEFAULT()` if the app doesn't set. `https://developer.android.com/reference/androidx/window/embedding/SplitRule#SPLIT_MIN_DIMENSION_ALWAYS_ALLOW()` means to always allow split.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int minWidthDp` | the smallest value of width of the parent window when the split should be used, in DP. |

### setTag

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/window#1.1.0)

```
public final @NonNull SplitPairRule.Builder setTag(String tag)
```

Sets a unique string to identify this `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule`, which defaults to `null`. The suggested usage is to set the tag to be able to differentiate between different rules in the `https://developer.android.com/reference/androidx/window/embedding/SplitAttributesCalculatorParams#splitRuleTag()`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html tag` | unique string to identify this `https://developer.android.com/reference/androidx/window/embedding/SplitPairRule`. |