summaryrefslogtreecommitdiffstats
path: root/core/java/android
diff options
context:
space:
mode:
authorCraig Mautner <cmautner@google.com>2014-10-01 17:48:12 +0000
committerAndroid (Google) Code Review <android-gerrit@google.com>2014-10-01 17:48:14 +0000
commit245645ca460150b4030d84c88faa931345a90a50 (patch)
treeb6c075957d64b5b406be87411e97bb86d846309b /core/java/android
parent15b2202bacdfcc249d7f51bcd3361e6694d24267 (diff)
parent64ccb7086741d520c041273610519a5c2f65b440 (diff)
downloadframeworks_base-245645ca460150b4030d84c88faa931345a90a50.zip
frameworks_base-245645ca460150b4030d84c88faa931345a90a50.tar.gz
frameworks_base-245645ca460150b4030d84c88faa931345a90a50.tar.bz2
Merge "Don't clear visible-behind activity if it is top" into lmp-dev
Diffstat (limited to 'core/java/android')
-rw-r--r--core/java/android/app/Activity.java30
1 files changed, 18 insertions, 12 deletions
diff --git a/core/java/android/app/Activity.java b/core/java/android/app/Activity.java
index 25c4897..9f683e3 100644
--- a/core/java/android/app/Activity.java
+++ b/core/java/android/app/Activity.java
@@ -5466,27 +5466,33 @@ public class Activity extends ContextThemeWrapper
/**
* Activities that want to remain visible behind a translucent activity above them must call
- * this method anytime before a return from {@link #onPause()}. If this call is successful
- * then the activity will remain visible when {@link #onPause()} is called, and can continue to
- * play media in the background, but it must stop playing and release resources prior to or
- * within the call to {@link #onVisibleBehindCanceled()}. If this call returns false, the
- * activity will not be visible in the background, and must release any media resources
- * immediately.
+ * this method anytime between the start of {@link #onResume()} and the return from
+ * {@link #onPause()}. If this call is successful then the activity will remain visible after
+ * {@link #onPause()} is called, and is allowed to continue playing media in the background.
+ *
+ * <p>The actions of this call are reset each time that this activity is brought to the
+ * front. That is, every time {@link #onResume()} is called the activity will be assumed
+ * to not have requested visible behind. Therefore, if you want this activity to continue to
+ * be visible in the background you must call this method again.
*
* <p>Only fullscreen opaque activities may make this call. I.e. this call is a nop
* for dialog and translucent activities.
*
- * <p>False will be returned any time this method is call between the return of onPause and
+ * <p>Under all circumstances, the activity must stop playing and release resources prior to or
+ * within a call to {@link #onVisibleBehindCanceled()} or if this call returns false.
+ *
+ * <p>False will be returned any time this method is called between the return of onPause and
* the next call to onResume.
*
* @param visible true to notify the system that the activity wishes to be visible behind other
* translucent activities, false to indicate otherwise. Resources must be
* released when passing false to this method.
- * @return the resulting visibiity state. If true the activity may remain visible beyond
- * {@link #onPause()}. If false then the activity may not count on being visible behind
- * other translucent activities, and must stop any media playback and release resources.
- * Returning false may occur in lieu of a call to onVisibleBehindCanceled() so the return
- * value must be checked.
+ * @return the resulting visibiity state. If true the activity will remain visible beyond
+ * {@link #onPause()} if the next activity is translucent or not fullscreen. If false
+ * then the activity may not count on being visible behind other translucent activities,
+ * and must stop any media playback and release resources.
+ * Returning false may occur in lieu of a call to {@link #onVisibleBehindCanceled()} so
+ * the return value must be checked.
*
* @see #onVisibleBehindCanceled()
* @see #onBackgroundVisibleBehindChanged(boolean)