summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChet Haase <chet@google.com>2015-06-10 14:27:44 +0000
committerAndroid (Google) Code Review <android-gerrit@google.com>2015-06-10 14:27:47 +0000
commit81728b862e8448bc460fd6589de6c1b954f8227e (patch)
tree4d044e40a60fc049390af97ed3fa49f03c4a91cd
parent300a141650dc17d2a893b55133c62b0353d2a9bb (diff)
parent4ddd9257d60c378ddcf5b537ea2a03b80629f097 (diff)
downloadframeworks_base-81728b862e8448bc460fd6589de6c1b954f8227e.zip
frameworks_base-81728b862e8448bc460fd6589de6c1b954f8227e.tar.gz
frameworks_base-81728b862e8448bc460fd6589de6c1b954f8227e.tar.bz2
Merge "Clarify docs for Animator.isStarted()" into mnc-dev
-rw-r--r--core/java/android/animation/Animator.java14
1 files changed, 9 insertions, 5 deletions
diff --git a/core/java/android/animation/Animator.java b/core/java/android/animation/Animator.java
index da48709..aa1be9a 100644
--- a/core/java/android/animation/Animator.java
+++ b/core/java/android/animation/Animator.java
@@ -211,11 +211,15 @@ public abstract class Animator implements Cloneable {
public abstract boolean isRunning();
/**
- * Returns whether this Animator has been started and not yet ended. This state is a superset
- * of the state of {@link #isRunning()}, because an Animator with a nonzero
- * {@link #getStartDelay() startDelay} will return true for {@link #isStarted()} during the
- * delay phase, whereas {@link #isRunning()} will return true only after the delay phase
- * is complete.
+ * Returns whether this Animator has been started and not yet ended. For reusable
+ * Animators (which most Animators are, apart from the one-shot animator produced by
+ * {@link android.view.ViewAnimationUtils#createCircularReveal(
+ * android.view.View, int, int, float, float) createCircularReveal()}),
+ * this state is a superset of {@link #isRunning()}, because an Animator with a
+ * nonzero {@link #getStartDelay() startDelay} will return true for {@link #isStarted()} during
+ * the delay phase, whereas {@link #isRunning()} will return true only after the delay phase
+ * is complete. Non-reusable animators will always return true after they have been
+ * started, because they cannot return to a non-started state.
*
* @return Whether the Animator has been started and not yet ended.
*/