WindowInsets: reimplement WindowInsets on top of Insets (60f59298) · Commits · e / os / android_frameworks_base

api/current.txt

+2 −0

Original line number	Diff line number	Diff line
		@@ -49982,10 +49982,12 @@ package android.view {
		method public int getStableInsetLeft();
		method public int getStableInsetRight();
		method public int getStableInsetTop();
		method public android.graphics.Insets getStableInsets();
		method public int getSystemWindowInsetBottom();
		method public int getSystemWindowInsetLeft();
		method public int getSystemWindowInsetRight();
		method public int getSystemWindowInsetTop();
		method public android.graphics.Insets getSystemWindowInsets();
		method public boolean hasInsets();
		method public boolean hasStableInsets();
		method public boolean hasSystemWindowInsets();

core/java/android/view/View.java

+4 −4

Original line number	Diff line number	Diff line
		@@ -9852,12 +9852,12 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
		// We weren't called from within a direct call to fitSystemWindows,
		// call into it as a fallback in case we're in a class that overrides it
		// and has logic to perform.
		if (fitSystemWindows(insets.getSystemWindowInsets())) {
		if (fitSystemWindows(insets.getSystemWindowInsetsAsRect())) {
		return insets.consumeSystemWindowInsets();
		}
		} else {
		// We were called from within a direct call to fitSystemWindows.
		if (fitSystemWindowsInt(insets.getSystemWindowInsets())) {
		if (fitSystemWindowsInt(insets.getSystemWindowInsetsAsRect())) {
		return insets.consumeSystemWindowInsets();
		}
		}
		@@ -9960,7 +9960,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
		protected boolean computeFitSystemWindows(Rect inoutInsets, Rect outLocalInsets) {
		WindowInsets innerInsets = computeSystemWindowInsets(new WindowInsets(inoutInsets),
		outLocalInsets);
		inoutInsets.set(innerInsets.getSystemWindowInsets());
		inoutInsets.set(innerInsets.getSystemWindowInsetsAsRect());
		return innerInsets.isSystemWindowInsetsConsumed();
		}

		@@ -9979,7 +9979,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
		\|\| mAttachInfo == null
		\|\| ((mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0
		&& !mAttachInfo.mOverscanRequested)) {
		outLocalInsets.set(in.getSystemWindowInsets());
		outLocalInsets.set(in.getSystemWindowInsetsAsRect());
		return in.consumeSystemWindowInsets().inset(outLocalInsets);
		} else {
		// The application wants to take care of fitting system window for

core/java/android/view/WindowInsets.java

+147 −121

Original line number	Diff line number	Diff line
		@@ -17,8 +17,10 @@

		package android.view;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.UnsupportedAppUsage;
		import android.graphics.Insets;
		import android.graphics.Rect;

		import com.android.internal.util.Preconditions;
		@@ -43,26 +45,24 @@ import java.util.Objects;
		*/
		public final class WindowInsets {

		private Rect mSystemWindowInsets;
		private Rect mWindowDecorInsets;
		private Rect mStableInsets;
		private Rect mTempRect;
		private boolean mIsRound;
		private DisplayCutout mDisplayCutout;
		@NonNull private final Insets mSystemWindowInsets;
		@NonNull private final Insets mWindowDecorInsets;
		@NonNull private final Insets mStableInsets;
		@Nullable private Rect mTempRect;
		private final boolean mIsRound;
		@Nullable private final DisplayCutout mDisplayCutout;

		/**
		* In multi-window we force show the navigation bar. Because we don't want that the surface size
		* changes in this mode, we instead have a flag whether the navigation bar size should always
		* be consumed, so the app is treated like there is no virtual navigation bar at all.
		*/
		private boolean mAlwaysConsumeNavBar;
		private final boolean mAlwaysConsumeNavBar;

		private boolean mSystemWindowInsetsConsumed = false;
		private boolean mWindowDecorInsetsConsumed = false;
		private boolean mStableInsetsConsumed = false;
		private boolean mDisplayCutoutConsumed = false;

		private static final Rect EMPTY_RECT = new Rect(0, 0, 0, 0);
		private final boolean mSystemWindowInsetsConsumed;
		private final boolean mWindowDecorInsetsConsumed;
		private final boolean mStableInsetsConsumed;
		private final boolean mDisplayCutoutConsumed;

		/**
		* Since new insets may be added in the future that existing apps couldn't
		@@ -74,21 +74,27 @@ public final class WindowInsets {
		public static final WindowInsets CONSUMED;

		static {
		CONSUMED = new WindowInsets(null, null, null, false, false, null);
		CONSUMED = new WindowInsets((Insets) null, null, null, false, false, null);
		}

		/** @hide */
		public WindowInsets(Rect systemWindowInsets, Rect windowDecorInsets, Rect stableInsets,
		boolean isRound, boolean alwaysConsumeNavBar, DisplayCutout displayCutout) {
		this(Insets.of(systemWindowInsets), Insets.of(windowDecorInsets), Insets.of(stableInsets),
		isRound, alwaysConsumeNavBar, displayCutout);
		}

		private WindowInsets(Insets systemWindowInsets, Insets windowDecorInsets,
		Insets stableInsets, boolean isRound, boolean alwaysConsumeNavBar,
		DisplayCutout displayCutout) {
		mSystemWindowInsetsConsumed = systemWindowInsets == null;
		mSystemWindowInsets = mSystemWindowInsetsConsumed
		? EMPTY_RECT : new Rect(systemWindowInsets);
		mSystemWindowInsets = mSystemWindowInsetsConsumed ? Insets.NONE : systemWindowInsets;

		mWindowDecorInsetsConsumed = windowDecorInsets == null;
		mWindowDecorInsets = mWindowDecorInsetsConsumed ? EMPTY_RECT : new Rect(windowDecorInsets);
		mWindowDecorInsets = mWindowDecorInsetsConsumed ? Insets.NONE : windowDecorInsets;

		mStableInsetsConsumed = stableInsets == null;
		mStableInsets = mStableInsetsConsumed ? EMPTY_RECT : new Rect(stableInsets);
		mStableInsets = mStableInsetsConsumed ? Insets.NONE : stableInsets;

		mIsRound = isRound;
		mAlwaysConsumeNavBar = alwaysConsumeNavBar;
		@@ -104,16 +110,21 @@ public final class WindowInsets {
		* @param src Source to copy insets from
		*/
		public WindowInsets(WindowInsets src) {
		mSystemWindowInsets = src.mSystemWindowInsets;
		mWindowDecorInsets = src.mWindowDecorInsets;
		mStableInsets = src.mStableInsets;
		mSystemWindowInsetsConsumed = src.mSystemWindowInsetsConsumed;
		mWindowDecorInsetsConsumed = src.mWindowDecorInsetsConsumed;
		mStableInsetsConsumed = src.mStableInsetsConsumed;
		mIsRound = src.mIsRound;
		mAlwaysConsumeNavBar = src.mAlwaysConsumeNavBar;
		mDisplayCutout = src.mDisplayCutout;
		mDisplayCutoutConsumed = src.mDisplayCutoutConsumed;
		this(src.mSystemWindowInsetsConsumed ? null : src.mSystemWindowInsets,
		src.mWindowDecorInsetsConsumed ? null : src.mWindowDecorInsets,
		src.mStableInsetsConsumed ? null : src.mStableInsets,
		src.mIsRound, src.mAlwaysConsumeNavBar,
		displayCutoutCopyConstructorArgument(src));
		}

		private static DisplayCutout displayCutoutCopyConstructorArgument(WindowInsets w) {
		if (w.mDisplayCutoutConsumed) {
		return null;
		} else if (w.mDisplayCutout == null) {
		return DisplayCutout.NO_CUTOUT;
		} else {
		return w.mDisplayCutout;
		}
		}

		/** @hide */
		@@ -126,14 +137,17 @@ public final class WindowInsets {
		* Used to provide a safe copy of the system window insets to pass through
		* to the existing fitSystemWindows method and other similar internals.
		* @hide
		*
		* @deprecated use {@link #getSystemWindowInsets()} instead.
		*/
		@UnsupportedAppUsage
		public Rect getSystemWindowInsets() {
		@Deprecated
		public Rect getSystemWindowInsetsAsRect() {
		if (mTempRect == null) {
		mTempRect = new Rect();
		}
		if (mSystemWindowInsets != null) {
		mTempRect.set(mSystemWindowInsets);
		mTempRect.set(mSystemWindowInsets.left, mSystemWindowInsets.top,
		mSystemWindowInsets.right, mSystemWindowInsets.bottom);
		} else {
		// If there were no system window insets, this is just empty.
		mTempRect.setEmpty();
		@@ -141,6 +155,20 @@ public final class WindowInsets {
		return mTempRect;
		}

		/**
		* Returns the system window insets in pixels.
		*
		* <p>The system window inset represents the area of a full-screen window that is
		* partially or fully obscured by the status bar, navigation bar, IME or other system windows.
		* </p>
		*
		* @return The system window insets
		*/
		@NonNull
		public Insets getSystemWindowInsets() {
		return mSystemWindowInsets;
		}

		/**
		* Returns the left system window inset in pixels.
		*
		@@ -305,10 +333,11 @@ public final class WindowInsets {
		* @return A modified copy of this WindowInsets
		*/
		public WindowInsets consumeDisplayCutout() {
		final WindowInsets result = new WindowInsets(this);
		result.mDisplayCutout = null;
		result.mDisplayCutoutConsumed = true;
		return result;
		return new WindowInsets(mSystemWindowInsetsConsumed ? null : mSystemWindowInsets,
		mWindowDecorInsetsConsumed ? null : mWindowDecorInsets,
		mStableInsetsConsumed ? null : mStableInsets,
		mIsRound, mAlwaysConsumeNavBar,
		null /* displayCutout */);
		}


		@@ -350,100 +379,90 @@ public final class WindowInsets {
		* @return A modified copy of this WindowInsets
		*/
		public WindowInsets consumeSystemWindowInsets() {
		final WindowInsets result = new WindowInsets(this);
		result.mSystemWindowInsets = EMPTY_RECT;
		result.mSystemWindowInsetsConsumed = true;
		return result;
		}

		/**
		* Returns a copy of this WindowInsets with selected system window insets fully consumed.
		*
		* @param left true to consume the left system window inset
		* @param top true to consume the top system window inset
		* @param right true to consume the right system window inset
		* @param bottom true to consume the bottom system window inset
		* @return A modified copy of this WindowInsets
		* @hide pending API
		*/
		public WindowInsets consumeSystemWindowInsets(boolean left, boolean top,
		boolean right, boolean bottom) {
		if (left \|\| top \|\| right \|\| bottom) {
		final WindowInsets result = new WindowInsets(this);
		result.mSystemWindowInsets = new Rect(
		left ? 0 : mSystemWindowInsets.left,
		top ? 0 : mSystemWindowInsets.top,
		right ? 0 : mSystemWindowInsets.right,
		bottom ? 0 : mSystemWindowInsets.bottom);
		return result;
		}
		return this;
		return new WindowInsets(null /* systemWindowInsets */,
		mWindowDecorInsetsConsumed ? null : mWindowDecorInsets,
		mStableInsetsConsumed ? null : mStableInsets,
		mIsRound, mAlwaysConsumeNavBar,
		displayCutoutCopyConstructorArgument(this));
		}

		/**
		* Returns a copy of this WindowInsets with selected system window insets replaced
		* with new values.
		*
		* <p>Note: If the system window insets are already consumed, this method will return them
		* unchanged on {@link android.os.Build.VERSION_CODES#Q Q} and later. Prior to
		* {@link android.os.Build.VERSION_CODES#Q Q}, the new values were applied regardless of
		* whether they were consumed, and this method returns invalid non-zero consumed insets.
		*
		* @param left New left inset in pixels
		* @param top New top inset in pixels
		* @param right New right inset in pixels
		* @param bottom New bottom inset in pixels
		* @return A modified copy of this WindowInsets
		*/
		public WindowInsets replaceSystemWindowInsets(int left, int top,
		int right, int bottom) {
		final WindowInsets result = new WindowInsets(this);
		result.mSystemWindowInsets = new Rect(left, top, right, bottom);
		return result;
		public WindowInsets replaceSystemWindowInsets(int left, int top, int right, int bottom) {
		// TODO(roosa): deprecate in follow-up CL, once we have a builder for WindowInsets.

		// Compat edge case: what should this do if the insets have already been consumed?
		// On platforms prior to Q, the behavior was to override the insets with non-zero values,
		// but leave them consumed, which is invalid (consumed insets must be zero).
		// The behavior is now keeping them consumed and discarding the new insets.
		if (mSystemWindowInsetsConsumed) {
		return this;
		}

		return new WindowInsets(Insets.of(left, top, right, bottom),
		mWindowDecorInsetsConsumed ? null : mWindowDecorInsets,
		mStableInsetsConsumed ? null : mStableInsets,
		mIsRound, mAlwaysConsumeNavBar,
		displayCutoutCopyConstructorArgument(this));
		}

		/**
		* Returns a copy of this WindowInsets with selected system window insets replaced
		* with new values.
		*
		* <p>Note: If the system window insets are already consumed, this method will return them
		* unchanged on {@link android.os.Build.VERSION_CODES#Q Q} and later. Prior to
		* {@link android.os.Build.VERSION_CODES#Q Q}, the new values were applied regardless of
		* whether they were consumed, and this method returns invalid non-zero consumed insets.
		*
		* @param systemWindowInsets New system window insets. Each field is the inset in pixels
		* for that edge
		* @return A modified copy of this WindowInsets
		*/
		public WindowInsets replaceSystemWindowInsets(Rect systemWindowInsets) {
		final WindowInsets result = new WindowInsets(this);
		result.mSystemWindowInsets = new Rect(systemWindowInsets);
		return result;
		// TODO(roosa): deprecate in follow-up CL, once we have a builder for WindowInsets.
		return replaceSystemWindowInsets(systemWindowInsets.left, systemWindowInsets.top,
		systemWindowInsets.right, systemWindowInsets.bottom);
		}

		/**
		* @hide
		*/
		public WindowInsets consumeWindowDecorInsets() {
		final WindowInsets result = new WindowInsets(this);
		result.mWindowDecorInsets.set(0, 0, 0, 0);
		result.mWindowDecorInsetsConsumed = true;
		return result;
		}

		/**
		* @hide
		*/
		public WindowInsets consumeWindowDecorInsets(boolean left, boolean top,
		boolean right, boolean bottom) {
		if (left \|\| top \|\| right \|\| bottom) {
		final WindowInsets result = new WindowInsets(this);
		result.mWindowDecorInsets = new Rect(left ? 0 : mWindowDecorInsets.left,
		top ? 0 : mWindowDecorInsets.top,
		right ? 0 : mWindowDecorInsets.right,
		bottom ? 0 : mWindowDecorInsets.bottom);
		return result;
		}
		return this;
		return new WindowInsets(mSystemWindowInsetsConsumed ? null : mSystemWindowInsets,
		null /* windowDecorInsets */,
		mStableInsetsConsumed ? null : mStableInsets,
		mIsRound, mAlwaysConsumeNavBar,
		displayCutoutCopyConstructorArgument(this));
		}

		/**
		* @hide
		* Returns the stable insets in pixels.
		*
		* <p>The stable inset represents the area of a full-screen window that <b>may</b> be
		* partially or fully obscured by the system UI elements. This value does not change
		* based on the visibility state of those elements; for example, if the status bar is
		* normally shown, but temporarily hidden, the stable inset will still provide the inset
		* associated with the status bar being shown.</p>
		*
		* @return The stable insets
		*/
		public WindowInsets replaceWindowDecorInsets(int left, int top, int right, int bottom) {
		final WindowInsets result = new WindowInsets(this);
		result.mWindowDecorInsets = new Rect(left, top, right, bottom);
		return result;
		@NonNull
		public Insets getStableInsets() {
		return mStableInsets;
		}

		/**
		@@ -528,10 +547,11 @@ public final class WindowInsets {
		* @return A modified copy of this WindowInsets
		*/
		public WindowInsets consumeStableInsets() {
		final WindowInsets result = new WindowInsets(this);
		result.mStableInsets = EMPTY_RECT;
		result.mStableInsetsConsumed = true;
		return result;
		return new WindowInsets(mSystemWindowInsetsConsumed ? null : mSystemWindowInsets,
		mWindowDecorInsetsConsumed ? null : mWindowDecorInsets,
		null /* stableInsets */,
		mIsRound, mAlwaysConsumeNavBar,
		displayCutoutCopyConstructorArgument(this));
		}

		/**
		@@ -555,12 +575,24 @@ public final class WindowInsets {
		* Returns a copy of this instance inset in the given directions.
		*
		* @see #inset(int, int, int, int)
		* @deprecated use {@link #inset(Insets)}
		* @hide
		*/
		@Deprecated
		public WindowInsets inset(Rect r) {
		return inset(r.left, r.top, r.right, r.bottom);
		}

		/**
		* Returns a copy of this instance inset in the given directions.
		*
		* @see #inset(int, int, int, int)
		* @hide
		*/
		public WindowInsets inset(Insets insets) {
		return inset(insets.left, insets.top, insets.right, insets.bottom);
		}

		/**
		* Returns a copy of this instance inset in the given directions.
		*
		@@ -587,25 +619,19 @@ public final class WindowInsets {
		Preconditions.checkArgumentNonnegative(right);
		Preconditions.checkArgumentNonnegative(bottom);

		WindowInsets result = new WindowInsets(this);
		if (!result.mSystemWindowInsetsConsumed) {
		result.mSystemWindowInsets =
		insetInsets(result.mSystemWindowInsets, left, top, right, bottom);
		}
		if (!result.mWindowDecorInsetsConsumed) {
		result.mWindowDecorInsets =
		insetInsets(result.mWindowDecorInsets, left, top, right, bottom);
		}
		if (!result.mStableInsetsConsumed) {
		result.mStableInsets = insetInsets(result.mStableInsets, left, top, right, bottom);
		}
		if (mDisplayCutout != null) {
		result.mDisplayCutout = result.mDisplayCutout.inset(left, top, right, bottom);
		if (result.mDisplayCutout.isEmpty()) {
		result.mDisplayCutout = null;
		}
		}
		return result;
		return new WindowInsets(
		mSystemWindowInsetsConsumed ? null :
		insetInsets(mSystemWindowInsets, left, top, right, bottom),
		mWindowDecorInsetsConsumed ? null :
		insetInsets(mWindowDecorInsets, left, top, right, bottom),
		mStableInsetsConsumed ? null :
		insetInsets(mStableInsets, left, top, right, bottom),
		mIsRound, mAlwaysConsumeNavBar,
		mDisplayCutoutConsumed
		? null :
		mDisplayCutout == null
		? DisplayCutout.NO_CUTOUT
		: mDisplayCutout.inset(left, top, right, bottom));
		}

		@Override
		@@ -632,7 +658,7 @@ public final class WindowInsets {
		mWindowDecorInsetsConsumed, mStableInsetsConsumed, mDisplayCutoutConsumed);
		}

		private static Rect insetInsets(Rect insets, int left, int top, int right, int bottom) {
		private static Insets insetInsets(Insets insets, int left, int top, int right, int bottom) {
		int newLeft = Math.max(0, insets.left - left);
		int newTop = Math.max(0, insets.top - top);
		int newRight = Math.max(0, insets.right - right);
		@@ -640,7 +666,7 @@ public final class WindowInsets {
		if (newLeft == left && newTop == top && newRight == right && newBottom == bottom) {
		return insets;
		}
		return new Rect(newLeft, newTop, newRight, newBottom);
		return Insets.of(newLeft, newTop, newRight, newBottom);
		}

		/**

core/java/android/widget/Magnifier.java

+2 −1

Original line number	Diff line number	Diff line
		@@ -28,6 +28,7 @@ import android.content.res.Resources;
		import android.content.res.TypedArray;
		import android.graphics.Bitmap;
		import android.graphics.Color;
		import android.graphics.Insets;
		import android.graphics.Outline;
		import android.graphics.Paint;
		import android.graphics.PixelFormat;
		@@ -568,7 +569,7 @@ public final class Magnifier {
		private Point getCurrentClampedWindowCoordinates() {
		final Rect windowBounds;
		if (mParentSurface.mIsMainWindowSurface) {
		final Rect systemInsets = mView.getRootWindowInsets().getSystemWindowInsets();
		final Insets systemInsets = mView.getRootWindowInsets().getSystemWindowInsets();
		windowBounds = new Rect(systemInsets.left, systemInsets.top,
		mParentSurface.mWidth - systemInsets.right,
		mParentSurface.mHeight - systemInsets.bottom);

core/java/com/android/internal/policy/DecorView.java

+1 −1

Original line number	Diff line number	Diff line
		@@ -1001,7 +1001,7 @@ public class DecorView extends FrameLayout implements RootViewSurfaceTaker, Wind
		insets.getSystemWindowInsetRight(), 0);
		}
		}
		mFrameOffsets.set(insets.getSystemWindowInsets());
		mFrameOffsets.set(insets.getSystemWindowInsetsAsRect());
		insets = updateColorViews(insets, true /* animate */);
		insets = updateStatusGuard(insets);
		if (getForeground() != null) {