WindowLayoutInfo

Artifact: androidx.window:window

View Source

Added in 1.0.0

---

Kotlin |Java

class WindowLayoutInfo

---

Contains the list of DisplayFeature-s present in the window and the window's engagement mode.

See also
windowLayoutInfo
WindowLayoutInfo.EngagementMode

Summary

Nested types
class WindowLayoutInfo.EngagementMode This class is deprecated. Use WindowEngagementInfo.EngagementMode instead

Public functions
open operator Boolean	equals(other: Any?)
Boolean	hasEngagementMode(mode: WindowLayoutInfo.EngagementMode) This function is deprecated. Use WindowEngagementInfo#hasEngagementMode instead
Boolean	hasEngagementModes(vararg modes: WindowLayoutInfo.EngagementMode) This function is deprecated. Use WindowEngagementInfo#hasEngagementModes instead
open Int	hashCode()
open String	toString()

Public properties
List<DisplayFeature>	displayFeatures The display features that are present in the window.
Set<WindowLayoutInfo.EngagementMode>	engagementModes This property is deprecated. Use WindowEngagementInfo#engagementModes instead

Public functions

equals

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

hasEngagementMode

Added in 1.6.0-alpha05

Deprecated in 1.6.0-alpha05

fun hasEngagementMode(mode: WindowLayoutInfo.EngagementMode): Boolean

This function is deprecated.
Use WindowEngagementInfo#hasEngagementMode instead

Checks if a specific engagement mode is currently active.

Parameters
mode: WindowLayoutInfo.EngagementMode	The EngagementMode to check for.

Returns
Boolean	true if the mode is present in the engagementModes set, false otherwise.

hasEngagementModes

Added in 1.6.0-alpha05

Deprecated in 1.6.0-alpha05

fun hasEngagementModes(vararg modes: WindowLayoutInfo.EngagementMode): Boolean

This function is deprecated.
Use WindowEngagementInfo#hasEngagementModes instead

Checks if all specified engagement modes are currently active.

Parameters
vararg modes: WindowLayoutInfo.EngagementMode	The EngagementMode-s to check for.

Returns
Boolean	true if all specified modes are in the engagementModes set, false otherwise.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

displayFeatures

Added in 1.0.0

val displayFeatures: List<DisplayFeature>

The display features that are present in the window. It is an empty list if there are no display features.

engagementModes

Added in 1.6.0-alpha05

Deprecated in 1.6.0-alpha05

val engagementModes: Set<WindowLayoutInfo.EngagementMode>

This property is deprecated.
Use WindowEngagementInfo#engagementModes instead

The current user engagement modes, indicating how the user is interacting with the app.