From 613ca984b100942a49e1aac2cb59cf390ebd24a0 Mon Sep 17 00:00:00 2001
From: Shawn Lin <shawnlin@google.com>
Date: Fri, 11 Nov 2022 08:10:22 +0000
Subject: [PATCH] Update the API doc for shortEdge/always cutout flags

Bug: 216065293
Test: make
Change-Id: I80cd9f3377ba27e61f26f74000a656da1489df18
---
 core/java/android/view/WindowManager.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/core/java/android/view/WindowManager.java b/core/java/android/view/WindowManager.java
index cc85181f52f2b..16f6cea2135c9 100644
--- a/core/java/android/view/WindowManager.java
+++ b/core/java/android/view/WindowManager.java
@@ -3408,6 +3408,11 @@ public interface WindowManager extends ViewManager {
          * alt="Screenshot of an activity on a display with a cutout on the long edge in portrait,
          *         letterbox is applied."/>
          *
+         * <p>
+         * Note: Android might not allow the content view to overlap the system bars in view level.
+         * To override this behavior and allow content to be able to extend into the cutout area,
+         * call {@link Window#setDecorFitsSystemWindows(boolean)} with {@code false}.
+         *
          * @see DisplayCutout
          * @see WindowInsets#getDisplayCutout()
          * @see #layoutInDisplayCutoutMode
@@ -3443,6 +3448,11 @@ public interface WindowManager extends ViewManager {
          * In this mode, the window extends under cutouts on the all edges of the display in both
          * portrait and landscape, regardless of whether the window is hiding the system bars.
          *
+         * <p>
+         * Note: Android might not allow the content view to overlap the system bars in view level.
+         * To override this behavior and allow content to be able to extend into the cutout area,
+         * call {@link Window#setDecorFitsSystemWindows(boolean)} with {@code false}.
+         *
          * @see DisplayCutout
          * @see WindowInsets#getDisplayCutout()
          * @see #layoutInDisplayCutoutMode