Google is committed to advancing racial equity for Black communities. See how.
Added in API level 1

WindowManager

interface WindowManager : ViewManager
android.view.WindowManager

The interface that apps use to talk to the window manager.

Each window manager instance is bound to a particular Display. To obtain a WindowManager for a different display, use Context#createDisplayContext to obtain a Context for that display, then use Context.getSystemService(Context.WINDOW_SERVICE) to get the WindowManager.

The simplest way to show a window on another display is to create a Presentation. The presentation will automatically obtain a WindowManager and Context for that display.

Summary

Nested classes
open

Exception that is thrown when trying to add view whose LayoutParams LayoutParams#token is invalid.
open

Exception that is thrown when calling addView to a secondary display that cannot be found.
open

Public methods
open WindowMetrics

Returns the WindowMetrics according to the current system state.
abstract Display!

Returns the Display upon which this WindowManager instance will create new windows.
open WindowMetrics

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

Special variation of removeView that immediately invokes the given view hierarchy's View#onDetachedFromWindow() methods before returning.

Inherited functions

Public methods

getCurrentWindowMetrics

Added in API level 30
open fun getCurrentWindowMetrics(): WindowMetrics

Returns the WindowMetrics according to the current system state.

The metrics describe the size of the area the window would occupy with LayoutParams#MATCH_PARENT width and height, and the WindowInsets such a window would have.

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 task.

Return
WindowMetrics This value cannot be null.

getDefaultDisplay

Added in API level 1
Deprecated in API level 30
abstract fun getDefaultDisplay(): Display!

Deprecated: Use Context#getDisplay() instead.

Returns the Display upon which this WindowManager instance will create new windows.

Despite the name of this method, the display that is returned is not necessarily the primary display of the system (see Display#DEFAULT_DISPLAY). The returned display could instead be a secondary display that this window manager instance is managing. Think of it as the display that this WindowManager instance uses by default.

To create windows on a different display, you need to obtain a WindowManager for that Display. (See the WindowManager class documentation for more information.)

Return
Display! The display that this window manager is managing.

getMaximumWindowMetrics

Added in API level 30
open fun getMaximumWindowMetrics(): WindowMetrics

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 LayoutParams#MATCH_PARENT width and height, and the WindowInsets such a window would have.

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 the what the bounds would be if the user expanded the Activity's task 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 in this Context.

Return
WindowMetrics This value cannot be null.

removeViewImmediate

Added in API level 1
abstract fun removeViewImmediate(view: View!): Unit

Special variation of removeView that immediately invokes the given view hierarchy's View#onDetachedFromWindow() methods before returning. This is not for normal applications; using it correctly requires great care.

Parameters
view View!: The view to be removed.