diff options
Diffstat (limited to 'mobile/android/thirdparty/com/squareup/picasso/RequestCreator.java')
-rw-r--r-- | mobile/android/thirdparty/com/squareup/picasso/RequestCreator.java | 374 |
1 files changed, 374 insertions, 0 deletions
diff --git a/mobile/android/thirdparty/com/squareup/picasso/RequestCreator.java b/mobile/android/thirdparty/com/squareup/picasso/RequestCreator.java new file mode 100644 index 000000000..3a5ca3a9f --- /dev/null +++ b/mobile/android/thirdparty/com/squareup/picasso/RequestCreator.java @@ -0,0 +1,374 @@ +/* + * Copyright (C) 2013 Square, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.squareup.picasso; + +import android.content.res.Resources; +import android.graphics.Bitmap; +import android.graphics.drawable.Drawable; +import android.net.Uri; +import android.widget.ImageView; +import java.io.IOException; + +import static com.squareup.picasso.BitmapHunter.forRequest; +import static com.squareup.picasso.Picasso.LoadedFrom.MEMORY; +import static com.squareup.picasso.Utils.checkNotMain; +import static com.squareup.picasso.Utils.createKey; + +/** Fluent API for building an image download request. */ +@SuppressWarnings("UnusedDeclaration") // Public API. +public class RequestCreator { + private final Picasso picasso; + private final Request.Builder data; + + private boolean skipMemoryCache; + private boolean noFade; + private boolean deferred; + private int placeholderResId; + private Drawable placeholderDrawable; + private int errorResId; + private Drawable errorDrawable; + + RequestCreator(Picasso picasso, Uri uri, int resourceId) { + if (picasso.shutdown) { + throw new IllegalStateException( + "Picasso instance already shut down. Cannot submit new requests."); + } + this.picasso = picasso; + this.data = new Request.Builder(uri, resourceId); + } + + /** + * A placeholder drawable to be used while the image is being loaded. If the requested image is + * not immediately available in the memory cache then this resource will be set on the target + * {@link ImageView}. + */ + public RequestCreator placeholder(int placeholderResId) { + if (placeholderResId == 0) { + throw new IllegalArgumentException("Placeholder image resource invalid."); + } + if (placeholderDrawable != null) { + throw new IllegalStateException("Placeholder image already set."); + } + this.placeholderResId = placeholderResId; + return this; + } + + /** + * A placeholder drawable to be used while the image is being loaded. If the requested image is + * not immediately available in the memory cache then this resource will be set on the target + * {@link ImageView}. + * <p> + * If you are not using a placeholder image but want to clear an existing image (such as when + * used in an {@link android.widget.Adapter adapter}), pass in {@code null}. + */ + public RequestCreator placeholder(Drawable placeholderDrawable) { + if (placeholderResId != 0) { + throw new IllegalStateException("Placeholder image already set."); + } + this.placeholderDrawable = placeholderDrawable; + return this; + } + + /** An error drawable to be used if the request image could not be loaded. */ + public RequestCreator error(int errorResId) { + if (errorResId == 0) { + throw new IllegalArgumentException("Error image resource invalid."); + } + if (errorDrawable != null) { + throw new IllegalStateException("Error image already set."); + } + this.errorResId = errorResId; + return this; + } + + /** An error drawable to be used if the request image could not be loaded. */ + public RequestCreator error(Drawable errorDrawable) { + if (errorDrawable == null) { + throw new IllegalArgumentException("Error image may not be null."); + } + if (errorResId != 0) { + throw new IllegalStateException("Error image already set."); + } + this.errorDrawable = errorDrawable; + return this; + } + + /** + * Attempt to resize the image to fit exactly into the target {@link ImageView}'s bounds. This + * will result in delayed execution of the request until the {@link ImageView} has been measured. + * <p/> + * <em>Note:</em> This method works only when your target is an {@link ImageView}. + */ + public RequestCreator fit() { + deferred = true; + return this; + } + + /** Internal use only. Used by {@link DeferredRequestCreator}. */ + RequestCreator unfit() { + deferred = false; + return this; + } + + /** Resize the image to the specified dimension size. */ + public RequestCreator resizeDimen(int targetWidthResId, int targetHeightResId) { + Resources resources = picasso.context.getResources(); + int targetWidth = resources.getDimensionPixelSize(targetWidthResId); + int targetHeight = resources.getDimensionPixelSize(targetHeightResId); + return resize(targetWidth, targetHeight); + } + + /** Resize the image to the specified size in pixels. */ + public RequestCreator resize(int targetWidth, int targetHeight) { + data.resize(targetWidth, targetHeight); + return this; + } + + /** + * Crops an image inside of the bounds specified by {@link #resize(int, int)} rather than + * distorting the aspect ratio. This cropping technique scales the image so that it fills the + * requested bounds and then crops the extra. + */ + public RequestCreator centerCrop() { + data.centerCrop(); + return this; + } + + /** + * Centers an image inside of the bounds specified by {@link #resize(int, int)}. This scales + * the image so that both dimensions are equal to or less than the requested bounds. + */ + public RequestCreator centerInside() { + data.centerInside(); + return this; + } + + /** Rotate the image by the specified degrees. */ + public RequestCreator rotate(float degrees) { + data.rotate(degrees); + return this; + } + + /** Rotate the image by the specified degrees around a pivot point. */ + public RequestCreator rotate(float degrees, float pivotX, float pivotY) { + data.rotate(degrees, pivotX, pivotY); + return this; + } + + /** + * Add a custom transformation to be applied to the image. + * <p/> + * Custom transformations will always be run after the built-in transformations. + */ + // TODO show example of calling resize after a transform in the javadoc + public RequestCreator transform(Transformation transformation) { + data.transform(transformation); + return this; + } + + /** + * Indicate that this action should not use the memory cache for attempting to load or save the + * image. This can be useful when you know an image will only ever be used once (e.g., loading + * an image from the filesystem and uploading to a remote server). + */ + public RequestCreator skipMemoryCache() { + skipMemoryCache = true; + return this; + } + + /** Disable brief fade in of images loaded from the disk cache or network. */ + public RequestCreator noFade() { + noFade = true; + return this; + } + + /** Synchronously fulfill this request. Must not be called from the main thread. */ + public Bitmap get() throws IOException { + checkNotMain(); + if (deferred) { + throw new IllegalStateException("Fit cannot be used with get."); + } + if (!data.hasImage()) { + return null; + } + + Request finalData = picasso.transformRequest(data.build()); + String key = createKey(finalData); + + Action action = new GetAction(picasso, finalData, skipMemoryCache, key); + return forRequest(picasso.context, picasso, picasso.dispatcher, picasso.cache, picasso.stats, + action, picasso.dispatcher.downloader).hunt(); + } + + /** + * Asynchronously fulfills the request without a {@link ImageView} or {@link Target}. This is + * useful when you want to warm up the cache with an image. + */ + public void fetch() { + if (deferred) { + throw new IllegalStateException("Fit cannot be used with fetch."); + } + if (data.hasImage()) { + Request finalData = picasso.transformRequest(data.build()); + String key = createKey(finalData); + + Action action = new FetchAction(picasso, finalData, skipMemoryCache, key); + picasso.enqueueAndSubmit(action); + } + } + + /** + * Asynchronously fulfills the request into the specified {@link Target}. In most cases, you + * should use this when you are dealing with a custom {@link android.view.View View} or view + * holder which should implement the {@link Target} interface. + * <p> + * Implementing on a {@link android.view.View View}: + * <blockquote><pre> + * public class ProfileView extends FrameLayout implements Target { + * {@literal @}Override public void onBitmapLoaded(Bitmap bitmap, LoadedFrom from) { + * setBackgroundDrawable(new BitmapDrawable(bitmap)); + * } + * + * {@literal @}Override public void onBitmapFailed() { + * setBackgroundResource(R.drawable.profile_error); + * } + * } + * </pre></blockquote> + * Implementing on a view holder object for use inside of an adapter: + * <blockquote><pre> + * public class ViewHolder implements Target { + * public FrameLayout frame; + * public TextView name; + * + * {@literal @}Override public void onBitmapLoaded(Bitmap bitmap, LoadedFrom from) { + * frame.setBackgroundDrawable(new BitmapDrawable(bitmap)); + * } + * + * {@literal @}Override public void onBitmapFailed() { + * frame.setBackgroundResource(R.drawable.profile_error); + * } + * } + * </pre></blockquote> + * <p> + * <em>Note:</em> This method keeps a weak reference to the {@link Target} instance and will be + * garbage collected if you do not keep a strong reference to it. To receive callbacks when an + * image is loaded use {@link #into(android.widget.ImageView, Callback)}. + */ + public void into(Target target) { + if (target == null) { + throw new IllegalArgumentException("Target must not be null."); + } + if (deferred) { + throw new IllegalStateException("Fit cannot be used with a Target."); + } + + Drawable drawable = + placeholderResId != 0 ? picasso.context.getResources().getDrawable(placeholderResId) + : placeholderDrawable; + + if (!data.hasImage()) { + picasso.cancelRequest(target); + target.onPrepareLoad(drawable); + return; + } + + Request finalData = picasso.transformRequest(data.build()); + String requestKey = createKey(finalData); + + if (!skipMemoryCache) { + Bitmap bitmap = picasso.quickMemoryCacheCheck(requestKey); + if (bitmap != null) { + picasso.cancelRequest(target); + target.onBitmapLoaded(bitmap, MEMORY); + return; + } + } + + target.onPrepareLoad(drawable); + + Action action = new TargetAction(picasso, target, finalData, skipMemoryCache, requestKey); + picasso.enqueueAndSubmit(action); + } + + /** + * Asynchronously fulfills the request into the specified {@link ImageView}. + * <p/> + * <em>Note:</em> This method keeps a weak reference to the {@link ImageView} instance and will + * automatically support object recycling. + */ + public void into(ImageView target) { + into(target, null); + } + + /** + * Asynchronously fulfills the request into the specified {@link ImageView} and invokes the + * target {@link Callback} if it's not {@code null}. + * <p/> + * <em>Note:</em> The {@link Callback} param is a strong reference and will prevent your + * {@link android.app.Activity} or {@link android.app.Fragment} from being garbage collected. If + * you use this method, it is <b>strongly</b> recommended you invoke an adjacent + * {@link Picasso#cancelRequest(android.widget.ImageView)} call to prevent temporary leaking. + */ + public void into(ImageView target, Callback callback) { + if (target == null) { + throw new IllegalArgumentException("Target must not be null."); + } + + if (!data.hasImage()) { + picasso.cancelRequest(target); + PicassoDrawable.setPlaceholder(target, placeholderResId, placeholderDrawable); + return; + } + + if (deferred) { + if (data.hasSize()) { + throw new IllegalStateException("Fit cannot be used with resize."); + } + int measuredWidth = target.getMeasuredWidth(); + int measuredHeight = target.getMeasuredHeight(); + if (measuredWidth == 0 || measuredHeight == 0) { + PicassoDrawable.setPlaceholder(target, placeholderResId, placeholderDrawable); + picasso.defer(target, new DeferredRequestCreator(this, target, callback)); + return; + } + data.resize(measuredWidth, measuredHeight); + } + + Request finalData = picasso.transformRequest(data.build()); + String requestKey = createKey(finalData); + + if (!skipMemoryCache) { + Bitmap bitmap = picasso.quickMemoryCacheCheck(requestKey); + if (bitmap != null) { + picasso.cancelRequest(target); + PicassoDrawable.setBitmap(target, picasso.context, bitmap, MEMORY, noFade, + picasso.debugging); + if (callback != null) { + callback.onSuccess(); + } + return; + } + } + + PicassoDrawable.setPlaceholder(target, placeholderResId, placeholderDrawable); + + Action action = + new ImageViewAction(picasso, target, finalData, skipMemoryCache, noFade, errorResId, + errorDrawable, requestKey, callback); + + picasso.enqueueAndSubmit(action); + } +} |