# SplitPinRule.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/SplitPinRule.kt+class:androidx.window.embedding.SplitPinRule.Builder) Added in [1.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

*** ** * ** ***


```
public final class SplitPinRule.Builder
```

<br />

*** ** * ** ***

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

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#Builder()()` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPinRule` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#build()()` Builds a `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule` instance. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule.Builder#minWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#minHeightDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#minSmallestWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#maxAspectRatioInPortrait()` and `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#maxAspectRatioInLandscape()` requirements. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#setSticky(kotlin.Boolean)(boolean isSticky)` Sets this rule to be sticky. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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/SplitPinRule`, which defaults to `null`. |

## Public constructors

### Builder

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

```
public Builder()
```

## Public methods

### build

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

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

Builds a `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule` instance.

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

### setDefaultSplitAttributes

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

```
public final @NonNull SplitPinRule.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/SplitPinRule.Builder#minWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#minHeightDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#minSmallestWidthDp()`, `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#maxAspectRatioInPortrait()` and `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.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. |

### setMaxAspectRatioInLandscape

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

```
public final @NonNull SplitPinRule.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.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

```
public final @NonNull SplitPinRule.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.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

```
public final @NonNull SplitPinRule.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/SplitPinRule`.

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.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

```
public final @NonNull SplitPinRule.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.4.0](https://developer.android.com/jetpack/androidx/releases/window#1.4.0)

```
public final @NonNull SplitPinRule.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. |

### setSticky

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

```
public final @NonNull SplitPinRule.Builder setSticky(boolean isSticky)
```

Sets this rule to be sticky.

| Parameters |
|---|---|
| `boolean isSticky` | whether to be a sticky rule. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder#setSticky(kotlin.Boolean)` |   |

### setTag

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

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

Sets a unique string to identify this `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule`, 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/SplitPinRule`. |