WindowManager

public final class WindowManager


Main interaction point with the WindowManager library. An instance of this class allows polling the current state of the device and display, and registering callbacks for changes in the corresponding states.

All methods of this class will return information that is associated with this visual context.

Summary

Public constructors

WindowManager(
    @NonNull Context context,
    @NonNull WindowBackend windowBackend
)

Public methods

final @NonNull WindowMetrics

Returns the WindowMetrics according to the current system state.

final @NonNull WindowMetrics

Returns the largest WindowMetrics an app may expect in the current system state.

final void

Registers a callback for layout changes of the window of the current visual Context.

final void

Unregisters a callback for window layout changes of the window.

Public constructors

WindowManager

public final WindowManager(
    @NonNull Context context,
    @NonNull WindowBackend windowBackend
)

Public methods

getCurrentWindowMetrics

@NonNull
public final WindowMetrics getCurrentWindowMetrics()

Returns the WindowMetrics according to the current system state.

The metrics describe the size of the area the window would occupy with MATCH_PARENT width and height and any combination of flags that would allow the window to extend behind display cutouts.

The value of this is based on the current windowing state of the system. For example, for activities in multi-window mode, the metrics returned are based on the current bounds that the user has selected for the Activity's window.

getMaximumWindowMetrics

@NonNull
public final WindowMetrics getMaximumWindowMetrics()

Returns the largest WindowMetrics an app may expect in the current system state.

The metrics describe the size of the largest potential area the window might occupy with MATCH_PARENT width and height and any combination of flags that would allow the window to extend behind display cutouts.

The value of this is based on the largest potential windowing state of the system. For example, for activities in multi-window mode the metrics returned are based on what the bounds would be if the user expanded the window to cover the entire screen.

Note that this might still be smaller than the size of the physical display if certain areas of the display are not available to windows created for the associated Context. For example, devices with foldable displays that wrap around the enclosure may split the physical display into different regions, one for the front and one for the back, each acting as different logical displays. In this case .getMaximumWindowMetrics would return the region describing the side of the device the associated context's window is placed.

registerLayoutChangeCallback

@NonNull
public final void registerLayoutChangeCallback(
    @NonNull Executor executor,
    @NonNull Consumer<@NonNull WindowLayoutInfo> callback
)

Registers a callback for layout changes of the window of the current visual Context. Must be called only after the it is attached to the window.

unregisterLayoutChangeCallback

@NonNull
public final void unregisterLayoutChangeCallback(
    @NonNull Consumer<@NonNull WindowLayoutInfo> callback
)

Unregisters a callback for window layout changes of the window.