SplitPairRule

class SplitPairRule : SplitRule

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

Split configuration rules for activity pairs. Define when activities that were launched on top should be placed adjacent to the one below, and the visual properties of such splits. Can be set either by RuleController.setRules or RuleController.addRule. The rules are always applied only to activities that will be started from the activity fills the whole parent task container or activity in the primary split after the rules were set.

Summary

Nested types

Builder for SplitPairRule.

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

Public properties
Boolean

If there is an existing split with the same primary container, indicates whether the existing secondary container on top and all activities in it should be destroyed when a new split is created using this rule.
Set<SplitPairFilter>

Filters used to choose when to apply this rule.
SplitRule.FinishBehavior

Determines what happens with the primary container when all activities are finished in the associated secondary container.
SplitRule.FinishBehavior

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

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

clearTop

Added in 1.0.0
val clearTop: Boolean

If there is an existing split with the same primary container, indicates whether the existing secondary container on top and all activities in it should be destroyed when a new split is created using this rule. Otherwise the new secondary will appear on top by default.

filters

Added in 1.0.0
val filters: Set<SplitPairFilter>

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

finishPrimaryWithSecondary

Added in 1.0.0
val finishPrimaryWithSecondary: SplitRule.FinishBehavior

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

See also
NEVER
ALWAYS
ADJACENT

finishSecondaryWithPrimary

Added in 1.0.0
val finishSecondaryWithPrimary: SplitRule.FinishBehavior

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

See also
NEVER
ALWAYS
ADJACENT