SplitPinRule

class SplitPinRule : SplitRule

kotlin.Any
   ↳ androidx.window.embedding.EmbeddingRule
     ↳ androidx.window.embedding.SplitRule
       ↳ androidx.window.embedding.SplitPinRule

Split configuration rules for pinning an ActivityStack. Define how the pinned ActivityStack should be displayed side-by-side with the other ActivityStack.

Summary

Nested types

Builder for SplitPinRule.

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
Boolean

Whether this rule should be sticky.

Inherited properties
From androidx.window.embedding.EmbeddingRule
String?

A unique string to identify this EmbeddingRule, which defaults to null.
From androidx.window.embedding.SplitRule
SplitAttributes

The default SplitAttributes to apply on the activity containers pair when the host task bounds satisfy minWidthDp, minHeightDp, minSmallestWidthDp, maxAspectRatioInPortrait and maxAspectRatioInLandscape requirements.
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.
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.
Int

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

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

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

isSticky

Added in 1.4.0-alpha05
val isSticky: Boolean

Whether this rule should be sticky. If the value is false, this rule be removed whenever the pinned 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).