commit a02d2748be353393b7b593d5adbd37d80dee427d
author Alan Viverette <alanv@google.com> Wed Sep 16 17:08:58 2015 -0400
committer Alan Viverette <alanv@google.com> Wed Sep 16 17:08:58 2015 -0400
tree 8b8f870dc52750ce25bc0e45771872220ccdbb84
parent 96d9953f74ab16a9a63ebfe4119d5340ec734e87

Clean up DrawableContainer.selectDrawable() docs, params

Change-Id: Ic38cbb4a21dab452950ba0e308ceba3cbe966363

graphics/java/android/graphics/drawable/DrawableContainer.java

diff --git a/graphics/java/android/graphics/drawable/DrawableContainer.java b/graphics/java/android/graphics/drawable/DrawableContainer.java
index 1915dd7..1f7d996 100644
--- a/graphics/java/android/graphics/drawable/DrawableContainer.java
+++ b/graphics/java/android/graphics/drawable/DrawableContainer.java
@@ -420,14 +420,23 @@
         return mCurIndex;
     }
 
-    public boolean selectDrawable(int idx) {
-        if (idx == mCurIndex) {
+    /**
+     * Sets the currently displayed drawable by index.
+     * <p>
+     * If an invalid index is specified, the current drawable will be set to
+     * {@code null} and the index will be set to {@code -1}.
+     *
+     * @param index the index of the drawable to display
+     * @return {@code true} if the drawable changed, {@code false} otherwise
+     */
+    public boolean selectDrawable(int index) {
+        if (index == mCurIndex) {
             return false;
         }
 
         final long now = SystemClock.uptimeMillis();
 
-        if (DEBUG) android.util.Log.i(TAG, toString() + " from " + mCurIndex + " to " + idx
+        if (DEBUG) android.util.Log.i(TAG, toString() + " from " + mCurIndex + " to " + index
                 + ": exit=" + mDrawableContainerState.mExitFadeDuration
                 + " enter=" + mDrawableContainerState.mEnterFadeDuration);
 
@@ -448,10 +457,10 @@
             mCurrDrawable.setVisible(false, false);
         }
 
-        if (idx >= 0 && idx < mDrawableContainerState.mNumChildren) {
-            final Drawable d = mDrawableContainerState.getChild(idx);
+        if (index >= 0 && index < mDrawableContainerState.mNumChildren) {
+            final Drawable d = mDrawableContainerState.getChild(index);
             mCurrDrawable = d;
-            mCurIndex = idx;
+            mCurIndex = index;
             if (d != null) {
                 if (mDrawableContainerState.mEnterFadeDuration > 0) {
                     mEnterAnimationEnd = now + mDrawableContainerState.mEnterFadeDuration;