WindowArea

class WindowArea

The current state of a window area. The WindowArea can represent a part of or an entire display in the system. These values can be used to modify the UI to show/hide controls and determine when features can be enabled.

Summary

Nested types

Represents a type of WindowArea

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

Returns the WindowAreaCapability corresponding to the operation provided.
open Int
open String

Public properties
WindowAreaToken

WindowAreaToken token to identify the specific WindowArea
WindowArea.Type

The Type of this window area
WindowMetrics

The WindowMetrics that represent the size of the area.

Public functions

equals

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

getCapability

Added in 1.6.0-alpha03
fun getCapability(operation: WindowAreaCapability.Operation): WindowAreaCapability

Returns the WindowAreaCapability corresponding to the operation provided. If this WindowAreaCapability does not exist for this WindowArea, a WindowAreaCapability with a WINDOW_AREA_STATUS_UNSUPPORTED value is returned.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

token

Added in 1.6.0-alpha03
val token: WindowAreaToken

WindowAreaToken token to identify the specific WindowArea

type

Added in 1.6.0-alpha03
val type: WindowArea.Type

The Type of this window area

windowMetrics

Added in 1.6.0-alpha03
val windowMetrics: WindowMetrics

The WindowMetrics that represent the size of the area. Used to determine if the behavior desired fits the size of the window area available.