From 96cde448c25976eeb923f8ccfeaffeb3f76eec9f Mon Sep 17 00:00:00 2001 From: shawnlin Date: Mon, 20 Apr 2020 12:55:00 +0800 Subject: Update the description of getWaterfallInsets() Bug: 154229434 Test: make Change-Id: If70d09dfa96e82b4cc4d20cd9a17764ac3c5a2b7 --- core/java/android/view/DisplayCutout.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'core/java/android/view/DisplayCutout.java') diff --git a/core/java/android/view/DisplayCutout.java b/core/java/android/view/DisplayCutout.java index 679c912e846f..b4863f9c6dd0 100644 --- a/core/java/android/view/DisplayCutout.java +++ b/core/java/android/view/DisplayCutout.java @@ -332,7 +332,14 @@ public final class DisplayCutout { } /** - * Return the waterfall insets. + * Returns the insets representing the curved areas of a waterfall display. + * + * A waterfall display has curved areas along the edges of the screen. Apps should be careful + * when showing UI and handling touch input in those insets because the curve may impair + * legibility and can frequently lead to unintended touch inputs. + * + * @return the insets for the curved areas of a waterfall display in pixels or {@code + * Insets.NONE} if there are no curved areas or they don't overlap with the window. */ public @NonNull Insets getWaterfallInsets() { return mWaterfallInsets; -- cgit v1.2.3