SplitAttributesCalculatorParams

Artifact: androidx.window:window

View Source

Added in 1.1.0

---

Kotlin |Java

class SplitAttributesCalculatorParams

---

The parameter container used to report the current device and window state in SplitController.setSplitAttributesCalculator and references the corresponding SplitRule by splitRuleTag if SplitPairRule.tag is specified.

Summary

Public functions
open String	toString()

Public properties
Boolean	areDefaultConstraintsSatisfied Whether the parentWindowMetrics satisfies the dimensions and aspect ratios requirements specified in the SplitRule, which are:
SplitAttributes	defaultSplitAttributes The SplitRule.defaultSplitAttributes.
Configuration	parentConfiguration The parent container's Configuration
WindowLayoutInfo	parentWindowLayoutInfo The parent container's WindowLayoutInfo
WindowMetrics	parentWindowMetrics The parent container's WindowMetrics
String?	splitRuleTag The tag of SplitRule to apply this SplitAttributes, which is null if the tag is not set.

Public functions

toString

open fun toString(): String

Public properties

areDefaultConstraintsSatisfied

Added in 1.2.0

val areDefaultConstraintsSatisfied: Boolean

Whether the parentWindowMetrics satisfies the dimensions and aspect ratios requirements specified in the SplitRule, which are:

• SplitRule.minWidthDp

• SplitRule.minHeightDp

• SplitRule.minSmallestWidthDp

• SplitRule.maxAspectRatioInPortrait

• SplitRule.maxAspectRatioInLandscape

defaultSplitAttributes

Added in 1.1.0

val defaultSplitAttributes: SplitAttributes

The SplitRule.defaultSplitAttributes. It could be from SplitRule Builder APIs (SplitPairRule.Builder.setDefaultSplitAttributes or SplitPlaceholderRule.Builder.setDefaultSplitAttributes) or from the splitRatio and splitLayoutDirection attributes from static rule definitions.

parentConfiguration

Added in 1.1.0

val parentConfiguration: Configuration

The parent container's Configuration

parentWindowLayoutInfo

Added in 1.1.0

val parentWindowLayoutInfo: WindowLayoutInfo

The parent container's WindowLayoutInfo

parentWindowMetrics

Added in 1.1.0

val parentWindowMetrics: WindowMetrics

The parent container's WindowMetrics

splitRuleTag

Added in 1.1.0

val splitRuleTag: String?

The tag of SplitRule to apply this SplitAttributes, which is null if the tag is not set.

See also
setTag
setTag