# SplitPinRule

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

*** ** * ** ***

<br />

```
public final class SplitPinRule extends SplitRule
```

<br />

|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||||
| ↳ | [androidx.window.embedding.EmbeddingRule](https://developer.android.com/reference/androidx/window/embedding/EmbeddingRule) |||
|   | ↳ | [androidx.window.embedding.SplitRule](https://developer.android.com/reference/androidx/window/embedding/SplitRule) ||
|   |   | ↳ | [androidx.window.embedding.SplitPinRule](https://developer.android.com/reference/androidx/window/embedding/SplitPinRule) |

*** ** * ** ***

Split configuration rules for pinning an `https://developer.android.com/reference/androidx/window/embedding/ActivityStack`. Define how the pinned `https://developer.android.com/reference/androidx/window/embedding/ActivityStack` should be displayed side-by-side with the other `https://developer.android.com/reference/androidx/window/embedding/ActivityStack`.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/window/embedding/SplitPinRule.Builder` Builder for `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule`. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `int` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule#hashCode()()` |
| `final boolean` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule#isSticky()()` Whether this rule should be sticky. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/window/embedding/SplitPinRule#toString()()` |

### Inherited methods

From [androidx.window.embedding.EmbeddingRule](https://developer.android.com/reference/androidx/window/embedding/EmbeddingRule) `final https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/window/embedding/EmbeddingRule#getTag()()`

A unique string to identify this `https://developer.android.com/reference/androidx/window/embedding/EmbeddingRule`, which defaults to `null`.
From [androidx.window.embedding.SplitRule](https://developer.android.com/reference/androidx/window/embedding/SplitRule) `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/SplitAttributes` `https://developer.android.com/reference/androidx/window/embedding/SplitRule#getDefaultSplitAttributes()()`

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/SplitRule#(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Int,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.SplitAttributes)`, `https://developer.android.com/reference/androidx/window/embedding/SplitRule#(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Int,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.SplitAttributes)`, `https://developer.android.com/reference/androidx/window/embedding/SplitRule#(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Int,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.SplitAttributes)`, `https://developer.android.com/reference/androidx/window/embedding/SplitRule#(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Int,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.SplitAttributes)` and `https://developer.android.com/reference/androidx/window/embedding/SplitRule#(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Int,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.EmbeddingAspectRatio,androidx.window.embedding.SplitAttributes)` requirements.
`final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/window/embedding/EmbeddingAspectRatio` `https://developer.android.com/reference/androidx/window/embedding/SplitRule#getMaxAspectRatioInLandscape()()`

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/EmbeddingAspectRatio` `https://developer.android.com/reference/androidx/window/embedding/SplitRule#getMaxAspectRatioInPortrait()()`

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 int` `https://developer.android.com/reference/androidx/window/embedding/SplitRule#getMinHeightDp()()`

The smallest value of height of the parent task window when the split should be used, in DP.
`final int` `https://developer.android.com/reference/androidx/window/embedding/SplitRule#getMinSmallestWidthDp()()`

The smallest value of the smallest possible width of the parent task window in any rotation when the split should be used, in DP.
`final int` `https://developer.android.com/reference/androidx/window/embedding/SplitRule#getMinWidthDp()()`

The smallest value of width of the parent task window when the split should be used, in DP.

## Public methods

### equals

```
public boolean equals(Object other)
```

### hashCode

```
public int hashCode()
```

### isSticky

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

```
public final boolean isSticky()
```

Whether this rule should be sticky. If the value is `false`, this rule be removed whenever the pinned `https://developer.android.com/reference/androidx/window/embedding/ActivityStack` is unpinned. Set to `true` if the rule should be applied whenever once again possible (e.g. the host Task bounds satisfies the size and aspect ratio requirements).

### toString

```
public @NonNull String toString()
```