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

Merge "Revised API documentation of getLocationOnScreen, getLocationInWindow, and getLocationInSurface to include multiple-screen behavior and remove mentions of "global" coordinate space." into tm-dev

Browse Source
This commit is contained in:
Jon Eckenrode
2022-04-25 13:48:48 +00:00
committed by Android (Google) Code Review
parent b49c8b3a3a f71eddec34
commit d2b8731f93
1 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -12063,6 +12063,9 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* Gets the coordinates of this view in the coordinate space of the * Gets the coordinates of this view in the coordinate space of the
* {@link Surface} that contains the view. * {@link Surface} that contains the view.
* *
* <p>In multiple-screen scenarios, if the surface spans multiple screens,
* the coordinate space of the surface also spans multiple screens.
*
* <p>After the method returns, the argument array contains the x- and * <p>After the method returns, the argument array contains the x- and
* y-coordinates of the view relative to the view's left and top edges, * y-coordinates of the view relative to the view's left and top edges,
* respectively. * respectively.
@@ -25585,19 +25588,23 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
} }
/** /**
* Gets the global coordinates of this view. The coordinates are in the * Gets the coordinates of this view in the coordinate space of the device
* coordinate space of the device screen, irrespective of system decorations * screen, irrespective of system decorations and whether the system is in
* and whether the system is in multi-window mode. * multi-window mode.
* *
* <p>In multi-window mode, the global coordinate space encompasses the * <p>In multi-window mode, the coordinate space encompasses the entire
* entire device screen, ignoring the bounds of the app window. For * device screen, ignoring the bounds of the app window. For example, if the
* example, if the view is in the bottom portion of a horizontal split * view is in the bottom portion of a horizontal split screen, the top edge
* screen, the top edge of the screen&mdash;not the top edge of the * of the screen&mdash;not the top edge of the window&mdash;is the origin
* window&mdash;is the origin from which the y-coordinate is calculated. * from which the y-coordinate is calculated.
* *
* <p><b>Note:</b> In multiple-screen scenarios, the global coordinate space * <p>In multiple-screen scenarios, the coordinate space can span screens.
* is restricted to the screen on which the view is displayed. The * For example, if the app is spanning both screens of a dual-screen device
* coordinate space does not span multiple screens. * and the view is located on the right-hand screen, the x-coordinate is
* calculated from the left edge of the left-hand screen to the left edge of
* the view. When the app is restricted to a single screen in a
* multiple-screen environment, the coordinate space includes only the
* screen on which the app is running.
* *
* <p>After the method returns, the argument array contains the x- and * <p>After the method returns, the argument array contains the x- and
* y-coordinates of the view relative to the view's left and top edges, * y-coordinates of the view relative to the view's left and top edges,
@@ -25625,6 +25632,11 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* top left corner of the window that contains the view. In full screen * top left corner of the window that contains the view. In full screen
* mode, the origin is the top left corner of the device screen. * mode, the origin is the top left corner of the device screen.
* *
* <p>In multiple-screen scenarios, if the app spans multiple screens, the
* coordinate space also spans multiple screens. But if the app is
* restricted to a single screen, the coordinate space includes only the
* screen on which the app is running.
*
* <p>After the method returns, the argument array contains the x- and * <p>After the method returns, the argument array contains the x- and
* y-coordinates of the view relative to the view's left and top edges, * y-coordinates of the view relative to the view's left and top edges,
* respectively. * respectively.