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

Commit e1fcf32f authored by Mariia Sandrikova's avatar Mariia Sandrikova
Browse files

Fix app compat component properties documentation. 

Update documentation to correctly indicate that properties are applied on the app level rather than the activity level. Applying properties on the app level maintains consistency with the level on which per-app overrides are applied by device manufacturers. Also, this allows to easily opt-out/in the whole app from per-app overrides.

Fix: 267082980
Test: builds
Change-Id: Icb2b4394b73216c0af762db07dca42796eb4d49a
parent c1cb41e9

core/java/android/view/WindowManager.java

+25 −25
Original line number Diff line number Diff line
@@ -814,8 +814,8 @@ public interface WindowManager extends ViewManager { 
    }



    /**

     * Activity level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the activity can be opted-in or opted-out

     * Application level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the app can be opted-in or opted-out

     * from the compatibility treatment that avoids {@link

     * android.app.Activity#setRequestedOrientation} loops. The loop can be trigerred by

     * ignoreRequestedOrientation display setting enabled on the device or by the landscape natural
@@ -833,17 +833,17 @@ public interface WindowManager extends ViewManager { 
     *     <li>Camera compatibility force rotation treatment is active for the package.

     * </ul>

     *

     * <p>Setting this property to {@code false} informs the system that the activity must be

     * <p>Setting this property to {@code false} informs the system that the app must be

     * opted-out from the compatibility treatment even if the device manufacturer has opted the app

     * into the treatment.

     *

     * <p><b>Syntax:</b>

     * <pre>

     * &lt;activity&gt;

     * &lt;application&gt;

     *   &lt;property

     *     android:name="android.window.PROPERTY_COMPAT_IGNORE_REQUESTED_ORIENTATION"

     *     android:value="true|false"/&gt;

     * &lt;/activity&gt;

     * &lt;/application&gt;

     * </pre>

     *

     * @hide
@@ -853,8 +853,8 @@ public interface WindowManager extends ViewManager { 
            "android.window.PROPERTY_COMPAT_IGNORE_REQUESTED_ORIENTATION";



    /**

     * Activity level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the activity should be excluded from the

     * Application level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the app should be excluded from the

     * camera compatibility force rotation treatment.

     *

     * <p>The camera compatibility treatment aligns orientations of portrait app window and natural
@@ -879,11 +879,11 @@ public interface WindowManager extends ViewManager { 
     *

     * <p><b>Syntax:</b>

     * <pre>

     * &lt;activity&gt;

     * &lt;application&gt;

     *   &lt;property

     *     android:name="android.window.PROPERTY_CAMERA_COMPAT_ALLOW_FORCE_ROTATION"

     *     android:value="true|false"/&gt;

     * &lt;/activity&gt;

     * &lt;/application&gt;

     * </pre>

     *

     * @hide
@@ -893,8 +893,8 @@ public interface WindowManager extends ViewManager { 
            "android.window.PROPERTY_CAMERA_COMPAT_ALLOW_FORCE_ROTATION";



    /**

     * Activity level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the activity should be excluded

     * Application level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the app should be excluded

     * from the activity "refresh" after the camera compatibility force rotation treatment.

     *

     * <p>The camera compatibility treatment aligns orientations of portrait app window and natural
@@ -926,11 +926,11 @@ public interface WindowManager extends ViewManager { 
     *

     * <p><b>Syntax:</b>

     * <pre>

     * &lt;activity&gt;

     * &lt;application&gt;

     *   &lt;property

     *     android:name="android.window.PROPERTY_CAMERA_COMPAT_ALLOW_REFRESH"

     *     android:value="true|false"/&gt;

     * &lt;/activity&gt;

     * &lt;/application&gt;

     * </pre>

     *

     * @hide
@@ -940,7 +940,7 @@ public interface WindowManager extends ViewManager { 
            "android.window.PROPERTY_CAMERA_COMPAT_ALLOW_REFRESH";



    /**

     * Activity level {@link android.content.pm.PackageManager.Property PackageManager

     * Application level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the activity should be or shouldn't be

     * "refreshed" after the camera compatibility force rotation treatment using "paused ->

     * resumed" cycle rather than "stopped -> resumed".
@@ -976,11 +976,11 @@ public interface WindowManager extends ViewManager { 
     *

     * <p><b>Syntax:</b>

     * <pre>

     * &lt;activity&gt;

     * &lt;application&gt;

     *   &lt;property

     *     android:name="android.window.PROPERTY_CAMERA_COMPAT_ENABLE_REFRESH_VIA_PAUSE"

     *     android:value="true|false"/&gt;

     * &lt;/activity&gt;

     * &lt;/application&gt;

     * </pre>

     *

     * @hide
@@ -990,23 +990,23 @@ public interface WindowManager extends ViewManager { 
            "android.window.PROPERTY_CAMERA_COMPAT_ENABLE_REFRESH_VIA_PAUSE";



    /**

     * Activity level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the activity should be excluded from the

     * Application level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the app should be excluded from the

     * compatibility override for orientation set by the device manufacturer.

     *

     * <p>With this property set to {@code true} or unset, device manufacturers can override

     * orientation for the activity using their discretion to improve display compatibility.

     * orientation for the app using their discretion to improve display compatibility.

     *

     * <p>With this property set to {@code false}, device manufactured per-app override for

     * orientation won't be applied.

     *

     * <p><b>Syntax:</b>

     * <pre>

     * &lt;activity&gt;

     * &lt;application&gt;

     *   &lt;property

     *     android:name="android.window.PROPERTY_COMPAT_ALLOW_ORIENTATION_OVERRIDE"

     *     android:value="true|false"/&gt;

     * &lt;/activity&gt;

     * &lt;/application&gt;

     * </pre>

     *

     * @hide
@@ -1016,8 +1016,8 @@ public interface WindowManager extends ViewManager { 
            "android.window.PROPERTY_COMPAT_ALLOW_ORIENTATION_OVERRIDE";



    /**

     * Activity level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the activity should be opted-out from the

     * Application level {@link android.content.pm.PackageManager.Property PackageManager

     * .Property} for an app to inform the system that the app should be opted-out from the

     * compatibility override that fixes display orientation to landscape natural orientation when

     * an activity is fullscreen.

     *
@@ -1047,11 +1047,11 @@ public interface WindowManager extends ViewManager { 
     *

     * <p><b>Syntax:</b>

     * <pre>

     * &lt;activity&gt;

     * &lt;application&gt;

     *   &lt;property

     *     android:name="android.window.PROPERTY_COMPAT_ALLOW_DISPLAY_ORIENTATION_OVERRIDE"

     *     android:value="true|false"/&gt;

     * &lt;/activity&gt;

     * &lt;/application&gt;

     * </pre>

     *

     * @hide