SplitPinRule

public final class SplitPinRule extends SplitRule

java.lang.Object
   ↳ 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
public final class SplitPinRule.Builder

Builder for SplitPinRule.

Public methods
boolean
equals(Object other)
int
final boolean

Whether this rule should be sticky.
@NonNull String

Inherited methods
From androidx.window.embedding.EmbeddingRule
final String

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

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

The smallest value of height of the parent task window when the split should be used, in DP.
final 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.
final int

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-alpha05
public final boolean isSticky()

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).

toString

public @NonNull String toString()