Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d2b8731f authored by Jon Eckenrode's avatar Jon Eckenrode Committed by Android (Google) Code Review
Browse files

Merge "Revised API documentation of getLocationOnScreen, getLocationInWindow,... 

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

core/java/android/view/View.java

+23 −11
Original line number Diff line number Diff line
@@ -12063,6 +12063,9 @@ public class View implements Drawable.Callback, KeyEvent.Callback, 
     * Gets the coordinates of this view in the coordinate space of the

     * {@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

     * y-coordinates of the view relative to the view's left and top edges,

     * 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













     * coordinate space of the device screen, irrespective of system decorations













     * and whether the system is in multi-window mode.













     * Gets the coordinates of this view in the coordinate space of the device













     * screen, irrespective of system decorations and whether the system is in













     * multi-window mode.















     *













     * <p>In multi-window mode, the global coordinate space encompasses the













     * entire device screen, ignoring the bounds of the app window. For













     * example, if the view is in the bottom portion of a horizontal split













     * screen, the top edge of the screen&mdash;not the top edge of the













     * window&mdash;is the origin from which the y-coordinate is calculated.













     * <p>In multi-window mode, the coordinate space encompasses the entire













     * device screen, ignoring the bounds of the app window. For example, if the













     * view is in the bottom portion of a horizontal split screen, the top edge













     * of the screen&mdash;not the top edge of the window&mdash;is the origin













     * from which the y-coordinate is calculated.















     *













     * <p><b>Note:</b> In multiple-screen scenarios, the global coordinate space













     * is restricted to the screen on which the view is displayed. The













     * coordinate space does not span multiple screens.













     * <p>In multiple-screen scenarios, the coordinate space can span screens.













     * For example, if the app is spanning both screens of a dual-screen device













     * 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















     * 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















     * 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















     * y-coordinates of the view relative to the view's left and top edges,















     * respectively.