Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WindowInsets: clarify displayCutout javadoc

Browse Source 
Fixes: 152729752
Change-Id: I4d24aaede44d80dae8d6e6d95a7d15d5f33a04c9
This commit is contained in:
Adrian Roos
2020-04-14 08:58:17 +00:00
parent 40dff7cd01
commit e978d75237
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
core/java/android/view/WindowInsets.java
View File

@@ -473,6 +473,12 @@ public final class WindowInsets {
/**
* Returns the display cutout if there is one.
*
* <p>Note: the display cutout will already be {@link #consumeDisplayCutout consumed} during
* dispatch to {@link View#onApplyWindowInsets}, unless the window has requested a
* {@link WindowManager.LayoutParams#layoutInDisplayCutoutMode} other than
* {@link WindowManager.LayoutParams#LAYOUT_IN_DISPLAY_CUTOUT_MODE_NEVER never} or
* {@link WindowManager.LayoutParams#LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT default}.
*
* @return the display cutout or null if there is none
* @see DisplayCutout
*/
@@ -1424,7 +1430,13 @@ public final class WindowInsets {
/**
* Returns an insets type representing the area that used by {@link DisplayCutout}.
*
* <p>This is equivalent to the safe insets on {@link #getDisplayCutout()}.</p>
* <p>This is equivalent to the safe insets on {@link #getDisplayCutout()}.
*
* <p>Note: During dispatch to {@link View#onApplyWindowInsets}, if the window is using
* the {@link WindowManager.LayoutParams#LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT default}
* {@link WindowManager.LayoutParams#layoutInDisplayCutoutMode}, {@link #getDisplayCutout()}
* will return {@code null} even if the window overlaps a display cutout area, in which case
* the {@link #displayCutout() displayCutout() inset} will still report the accurate value.
*
* @see DisplayCutout#getSafeInsetLeft()
* @see DisplayCutout#getSafeInsetTop()