diff options
author | Mark Wei <markwei@google.com> | 2013-11-04 21:24:34 -0800 |
---|---|---|
committer | Mark Wei <markwei@google.com> | 2013-11-04 21:24:34 -0800 |
commit | 10dddd8a24a80d1d539997d8eaa9763c62bd02ad (patch) | |
tree | 7a5b365c4d7cfc5ece62e0f9df5125ae26855b50 | |
parent | aab539ecd75ae365912200eb7f3318a53e9834f4 (diff) | |
download | bitmap-10dddd8a24a80d1d539997d8eaa9763c62bd02ad.tar.gz |
Add some documentation.
Change-Id: Ie32f29997946714d10318b111fabf4ed04e042e3
-rw-r--r-- | src/com/android/bitmap/drawable/BasicBitmapDrawable.java | 43 | ||||
-rw-r--r-- | src/com/android/bitmap/drawable/ExtendedBitmapDrawable.java | 6 |
2 files changed, 38 insertions, 11 deletions
diff --git a/src/com/android/bitmap/drawable/BasicBitmapDrawable.java b/src/com/android/bitmap/drawable/BasicBitmapDrawable.java index 503c004..7bb29a4 100644 --- a/src/com/android/bitmap/drawable/BasicBitmapDrawable.java +++ b/src/com/android/bitmap/drawable/BasicBitmapDrawable.java @@ -105,31 +105,49 @@ public class BasicBitmapDrawable extends Drawable implements DecodeCallback, } } - public RequestKey getKey() { + public final RequestKey getKey() { return mCurrKey; } - protected ReusableBitmap getBitmap() { + protected final ReusableBitmap getBitmap() { return mBitmap; } /** - * Set the dimensions to decode into. + * Set the dimensions to decode into. These dimensions should never change while the drawable is + * attached to the same cache, because caches can only contain bitmaps of one size for re-use. + * + * All UI operations should be called from the UI thread. */ - public void setDecodeDimensions(int w, int h) { + public final void setDecodeDimensions(int w, int h) { mDecodeWidth = w; mDecodeHeight = h; loadFileDescriptorFactory(); } - public void unbind() { - setImage(null); + /** + * Binds to the given key and start the decode process. This will first look in the cache, then + * decode from the request key if not found. + * + * All UI operations should be called from the UI thread. + */ + public final void bind(RequestKey key) { + setImage(key); } - public void bind(RequestKey key) { - setImage(key); + /** + * Unbinds the current key and bitmap from the drawable. This will cause the bitmap to decrement + * its ref count. + * + * All UI operations should be called from the UI thread. + */ + public final void unbind() { + setImage(null); } + /** + * Should only be overriden, not called. + */ protected void setImage(final RequestKey key) { if (mCurrKey != null && mCurrKey.equals(key)) { return; @@ -178,6 +196,9 @@ public class BasicBitmapDrawable extends Drawable implements DecodeCallback, Trace.endSection(); } + /** + * Should only be overriden, not called. + */ protected void setBitmap(ReusableBitmap bmp) { if (mBitmap != null && mBitmap != bmp) { mBitmap.releaseReference(); @@ -186,6 +207,9 @@ public class BasicBitmapDrawable extends Drawable implements DecodeCallback, invalidateSelf(); } + /** + * Should only be overriden, not called. + */ protected void loadFileDescriptorFactory() { if (mCurrKey == null || mDecodeWidth == 0 || mDecodeHeight == 0) { return; @@ -214,6 +238,9 @@ public class BasicBitmapDrawable extends Drawable implements DecodeCallback, } } + /** + * Should only be overriden, not called. + */ protected void decode(final FileDescriptorFactory factory) { Trace.beginSection("decode"); final int bufferW; diff --git a/src/com/android/bitmap/drawable/ExtendedBitmapDrawable.java b/src/com/android/bitmap/drawable/ExtendedBitmapDrawable.java index 068fca2..fa3d071 100644 --- a/src/com/android/bitmap/drawable/ExtendedBitmapDrawable.java +++ b/src/com/android/bitmap/drawable/ExtendedBitmapDrawable.java @@ -536,9 +536,9 @@ public class ExtendedBitmapDrawable extends BasicBitmapDrawable implements * <p/> * Requirements: * Set {@link #parallaxSpeedMultiplier} to the ratio between the decoded height and the - * visual bound height. Call {@link ExtendedBitmapDrawable#setParallaxFraction(float)} when - * the user scrolls, usually accomplished in your view's - * {@link android.view.View#onDraw(android.graphics.Canvas)} method. + * visual bound height. Call {@link ExtendedBitmapDrawable#setDecodeDimensions(int, int)} + * with the height multiplied by {@link #parallaxSpeedMultiplier}. + * Call {@link ExtendedBitmapDrawable#setParallaxFraction(float)} when the user scrolls. */ public static final int FEATURE_PARALLAX = 1 << 1; |