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

Add a note to preferKeepClear APIs documentation

Browse Source 
Bug: 216590903
Test: m doc-comment-check-docs
Change-Id: Ic696694edfea4bd9c0bb88d6851b2932427b757d
This commit is contained in:
Galia Peycheva
2022-02-08 18:12:32 +01:00
parent 22fba15a4a
commit cd6bf71ced
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/java/android/view/View.java
View File

@@ -11763,7 +11763,10 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* user and that ideally it should not be covered. Setting this is only appropriate for UI
* where the user would likely take action to uncover it.
* <p>
* The system will try to respect this, but when not possible will ignore it.
* The system will try to respect this preference, but when not possible will ignore it.
* <p>
* Note: while this is set to {@code true}, the system will ignore the {@code Rect}s provided
* through {@link #setPreferKeepClearRects} (but not clear them).
* <p>
* @see #setPreferKeepClearRects
* @see #isPreferKeepClear
@@ -11795,11 +11798,11 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* user and that ideally they should not be covered. Setting this is only appropriate for UI
* where the user would likely take action to uncover it.
* <p>
* If the whole view is preferred to be clear ({@link #isPreferKeepClear}), the rects set here
* will be ignored.
* <p>
* The system will try to respect this preference, but when not possible will ignore it.
* <p>
* Note: While {@link #isPreferKeepClear} is {@code true}, the {@code Rect}s set here are
* ignored.
* <p>
* @see #setPreferKeepClear
* @see #getPreferKeepClearRects
*/

2
core/res/res/values/attrs.xml
View File

@@ -3353,7 +3353,7 @@
area for the user and that ideally it should not be covered. Setting this is only
appropriate for UI where the user would likely take action to uncover it.
<p>The system will try to respect this, but when not possible will ignore it.
See {@link android.view.View#setPreferKeepClear}. -->
<p>This is equivalent to {@link android.view.View#setPreferKeepClear}.-->
<attr name="preferKeepClear" format="boolean" />
<!-- <p>Whether or not the auto handwriting initiation is enabled in this View.