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

Commit e6cec1a2 authored by joneckenrode's avatar joneckenrode
Browse files

Updated API documentation of screenWidthDp and screenHeightDp to include multiple-screen behavior. 



Test: Built API docs
Signed-off-by: default avatarjoneckenrode <joneckenrode@google.com>
Change-Id: I44aec14f1607e3ddabb7f792eac22da982347613
parent e3ebb21b

core/java/android/content/res/Configuration.java

+16 −0
Original line number Original line Diff line number Diff line
@@ -763,6 +763,14 @@ public final class Configuration implements Parcelable, Comparable<Configuration 
     * (for example, when apps are displayed side by side in split-screen mode

     * (for example, when apps are displayed side by side in split-screen mode

     * in landscape orientation).

     * in landscape orientation).

     *

     *

     * <p>In multiple-screen scenarios, the width measurement can span screens.

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

     * (with the screens side by side), {@code screenWidthDp} represents the

     * width of both screens, excluding the area occupied by screen decorations.

     * When the app is restricted to a single screen in a multiple-screen

     * environment, {@code screenWidthDp} is the width of the screen on which

     * the app is running.

     *

     * <p>Differs from {@link android.view.WindowMetrics} by not including

     * <p>Differs from {@link android.view.WindowMetrics} by not including

     * screen decorations in the width measurement and by expressing the

     * screen decorations in the width measurement and by expressing the

     * measurement in dp rather than px. Use {@code screenWidthDp} to obtain the

     * measurement in dp rather than px. Use {@code screenWidthDp} to obtain the
@@ -792,6 +800,14 @@ public final class Configuration implements Parcelable, Comparable<Configuration 
     * (for example, when apps are displayed one above another in split-screen

     * (for example, when apps are displayed one above another in split-screen

     * mode in portrait orientation).

     * mode in portrait orientation).

     *

     *

     * <p>In multiple-screen scenarios, the height measurement can span screens.

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

     * rotated 90 degrees (one screen above the other), {@code screenHeightDp}

     * represents the height of both screens, excluding the area occupied by

     * screen decorations. When the app is restricted to a single screen in a

     * multiple-screen environment, {@code screenHeightDp} is the height of the

     * screen on which the app is running.

     *

     * <p>Differs from {@link android.view.WindowMetrics} by not including

     * <p>Differs from {@link android.view.WindowMetrics} by not including

     * screen decorations in the height measurement and by expressing the

     * screen decorations in the height measurement and by expressing the

     * measurement in dp rather than px. Use {@code screenHeightDp} to obtain

     * measurement in dp rather than px. Use {@code screenHeightDp} to obtain