# SplitPlaceholderRule

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

*** ** * ** ***

<br />

```
class SplitPlaceholderRule : SplitRule
```

<br />

|---|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) ||||
| ↳ | [androidx.window.embedding.EmbeddingRule](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingRule) |||
|   | ↳ | [androidx.window.embedding.SplitRule](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule) ||
|   |   | ↳ | [androidx.window.embedding.SplitPlaceholderRule](https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule) |

*** ** * ** ***

Configuration rules for split placeholders.

A placeholder activity is usually a mostly empty activity that temporarily occupies the secondary container of a split. The placeholder is intended to be replaced when another activity with content is launched in a dedicated `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPairRule`. The placeholder activity is then occluded by the newly launched activity. The placeholder can provide some optional features but must not host important UI elements exclusively, since the placeholder is not shown on some devices and screen configurations, such as devices with small screens.

Configuration rules can be added using `https://developer.android.com/reference/kotlin/androidx/window/embedding/RuleController#addRule(androidx.window.embedding.EmbeddingRule)` or `https://developer.android.com/reference/kotlin/androidx/window/embedding/RuleController#setRules(kotlin.collections.Set)`.

See [Activity embedding](https://developer.android.com/guide/topics/large-screens/activity-embedding#placeholders) for more information.

## Summary

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

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://developer.android.com/reference/kotlin/androidx/window/embedding/ActivityFilter>` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#filters()` Filters used to choose when to apply this rule. |
| `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule.FinishBehavior` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#finishPrimaryWithPlaceholder()` Determines what happens with the primary container when all activities are finished in the associated placeholder container. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#isSticky()` Determines whether the placeholder will show on top in a smaller window size after it first appeared in a split with sufficient minimum width. |
| `https://developer.android.com/reference/android/content/Intent.html` | `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitPlaceholderRule#placeholderIntent()` Intent to launch the placeholder activity. |

### Inherited properties

From [androidx.window.embedding.EmbeddingRule](https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingRule) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` `https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingRule#tag()`

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

The default `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitAttributes` to apply on the activity containers pair when the host task bounds satisfy `https://developer.android.com/reference/kotlin/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/kotlin/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/kotlin/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/kotlin/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/kotlin/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.
`https://developer.android.com/reference/kotlin/androidx/window/embedding/EmbeddingAspectRatio` `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule#maxAspectRatioInLandscape()`

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

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.
`@https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule#minHeightDp()`

The smallest value of height of the parent task window when the split should be used, in DP.
`@https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule#minSmallestWidthDp()`

The smallest value of the smallest possible width of the parent task window in any rotation when the split should be used, in DP.
`@https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule#minWidthDp()`

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

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### filters

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

```
val filters: Set<ActivityFilter>
```

Filters used to choose when to apply this rule. The rule may be used if any one of the provided filters matches.

### finishPrimaryWithPlaceholder

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

```
val finishPrimaryWithPlaceholder: SplitRule.FinishBehavior
```

Determines what happens with the primary container when all activities are finished in the associated placeholder container.

**Note** that it is not valid to set `https://developer.android.com/reference/kotlin/androidx/window/embedding/SplitRule.FinishBehavior#NEVER()`

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

### isSticky

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

```
val isSticky: Boolean
```

Determines whether the placeholder will show on top in a smaller window size after it first appeared in a split with sufficient minimum width.

### placeholderIntent

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

```
val placeholderIntent: Intent
```

Intent to launch the placeholder activity.