aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/java/com/android/volley/toolbox/NetworkImageView.java
diff options
context:
space:
mode:
authorAnonymous <no-reply@google.com>2021-07-09 17:40:10 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2021-07-09 17:40:10 +0000
commitfd5d34f4fc6ffdf0b9c31381ffee78cf73f007d3 (patch)
treecf5d56ccdb862fd9676c855f919408ef940bc019 /core/src/main/java/com/android/volley/toolbox/NetworkImageView.java
parent904ab87ee280c7545a908a8ea10a833385a7cf3f (diff)
parentba6983e134f8f64ced7921f506862a7fcee59d19 (diff)
downloadvolley-3bdbe8191fcc793b2707bdb584d7eda36ba52055.tar.gz
Import of Volley from GitHub to AOSP. am: 212e7004ac am: f77c53c3a3 am: f33c2e45dc am: ba6983e134t_frc_odp_330442040t_frc_odp_330442000t_frc_con_330443020t_frc_cbr_330443000t_frc_ase_330444010t_frc_art_330443060t_frc_adb_330444000frc_340821000frc_340819280frc_340819220frc_340819190frc_340819030frc_340819020frc_340819010frc_340818170frc_340818110android-vts-14.0_r4android-vts-14.0_r3android-vts-14.0_r2android-vts-14.0_r1android-u-beta-1-gplandroid-security-14.0.0_r9android-security-14.0.0_r8android-security-14.0.0_r7android-security-14.0.0_r6android-security-14.0.0_r5android-security-14.0.0_r4android-security-14.0.0_r3android-security-14.0.0_r2android-security-14.0.0_r1android-platform-14.0.0_r8android-platform-14.0.0_r7android-platform-14.0.0_r6android-platform-14.0.0_r5android-platform-14.0.0_r4android-platform-14.0.0_r3android-platform-14.0.0_r2android-platform-14.0.0_r1android-cts-14.0_r4android-cts-14.0_r3android-cts-14.0_r2android-cts-14.0_r1android-14.0.0_r9android-14.0.0_r8android-14.0.0_r7android-14.0.0_r6android-14.0.0_r51android-14.0.0_r50android-14.0.0_r5android-14.0.0_r45android-14.0.0_r44android-14.0.0_r43android-14.0.0_r42android-14.0.0_r41android-14.0.0_r40android-14.0.0_r4android-14.0.0_r39android-14.0.0_r38android-14.0.0_r37android-14.0.0_r36android-14.0.0_r35android-14.0.0_r34android-14.0.0_r33android-14.0.0_r32android-14.0.0_r31android-14.0.0_r30android-14.0.0_r3android-14.0.0_r29android-14.0.0_r28android-14.0.0_r27android-14.0.0_r26android-14.0.0_r25android-14.0.0_r24android-14.0.0_r23android-14.0.0_r22android-14.0.0_r21android-14.0.0_r20android-14.0.0_r2android-14.0.0_r19android-14.0.0_r18android-14.0.0_r17android-14.0.0_r16android-14.0.0_r15android-14.0.0_r14android-14.0.0_r13android-14.0.0_r12android-14.0.0_r11android-14.0.0_r10android-14.0.0_r1android-13.0.0_r83android-13.0.0_r82android-13.0.0_r81android-13.0.0_r80android-13.0.0_r79android-13.0.0_r78android-13.0.0_r77android-13.0.0_r76android-13.0.0_r75android-13.0.0_r74android-13.0.0_r73android-13.0.0_r72android-13.0.0_r71android-13.0.0_r70android-13.0.0_r69android-13.0.0_r68android-13.0.0_r67android-13.0.0_r66android-13.0.0_r65android-13.0.0_r64android-13.0.0_r63android-13.0.0_r62android-13.0.0_r61android-13.0.0_r60android-13.0.0_r59android-13.0.0_r58android-13.0.0_r57android-13.0.0_r56android-13.0.0_r55android-13.0.0_r54android-13.0.0_r53android-13.0.0_r52android-13.0.0_r51android-13.0.0_r50android-13.0.0_r49android-13.0.0_r48android-13.0.0_r47android-13.0.0_r46android-13.0.0_r45android-13.0.0_r44android-13.0.0_r43android-13.0.0_r42android-13.0.0_r41android-13.0.0_r40android-13.0.0_r39android-13.0.0_r38android-13.0.0_r37android-13.0.0_r36android-13.0.0_r35android-13.0.0_r34android-13.0.0_r33android-13.0.0_r32android-13.0.0_r30android-13.0.0_r29android-13.0.0_r28android-13.0.0_r27android-13.0.0_r24android-13.0.0_r23android-13.0.0_r22android-13.0.0_r21android-13.0.0_r20android-13.0.0_r19android-13.0.0_r18android-13.0.0_r17android-13.0.0_r16aml_uwb_341710010aml_uwb_341513070aml_uwb_341511050aml_uwb_341310300aml_uwb_341310030aml_uwb_341111010aml_uwb_341011000aml_uwb_331910010aml_uwb_331820070aml_uwb_331613010aml_uwb_331611010aml_uwb_331410010aml_uwb_331310030aml_uwb_331115000aml_uwb_331015040aml_uwb_330810010aml_tz5_341510070aml_tz5_341510050aml_tz5_341510010aml_tz4_332714070aml_tz4_332714050aml_tz4_332714010aml_tz4_331910000aml_tz4_331314030aml_tz4_331314020aml_tz4_331314010aml_tz4_331012050aml_tz4_331012040aml_tz4_331012000aml_rkp_341510000aml_rkp_341311000aml_rkp_341114000aml_rkp_341015010aml_rkp_341012000aml_odp_341717000aml_odp_341610000aml_hef_341717050aml_hef_341613000aml_hef_341512030aml_hef_341415040aml_hef_341311010aml_hef_341114030aml_go_wif_330911000aml_go_uwb_330912000aml_go_tz4_330912000aml_go_tet_330914010aml_go_swc_330913000aml_go_sta_330911000aml_go_sdk_330810000aml_go_sch_330911000aml_go_res_330912000aml_go_per_330912000aml_go_odp_330913000aml_go_odp_330912000aml_go_neu_330912000aml_go_net_330913000aml_go_mpr_330912000aml_go_ase_330913000aml_go_ads_330915100aml_go_ads_330915000aml_go_ads_330913000aml_go_adb_330913000aml_cfg_341510000aml_ase_341510000aml_ase_341410000aml_ase_341310010aml_ase_341113000aml_ase_340913000aml_ase_331311020aml_ase_331112000aml_ase_331011020aml_ads_341720000aml_ads_341615050aml_ads_341517040aml_ads_341413000aml_ads_341316030aml_ads_341131050aml_ads_341027030aml_ads_340915050aml_ads_331920180aml_ads_331814200aml_ads_331710270aml_ads_331611190aml_ads_331511020aml_ads_331418080aml_ads_331131000main-16k-with-phonesmain-16kandroid14-tests-releaseandroid14-security-releaseandroid14-s2-releaseandroid14-s1-releaseandroid14-releaseandroid14-qpr3-releaseandroid14-qpr2-s5-releaseandroid14-qpr2-s4-releaseandroid14-qpr2-s3-releaseandroid14-qpr2-s2-releaseandroid14-qpr2-s1-releaseandroid14-qpr2-releaseandroid14-qpr1-s2-releaseandroid14-qpr1-releaseandroid14-platform-releaseandroid14-mainline-uwb-releaseandroid14-mainline-healthfitness-releaseandroid14-mainline-appsearch-releaseandroid14-mainline-adservices-releaseandroid14-gsiandroid14-devandroid14-d2-s5-releaseandroid14-d2-s4-releaseandroid14-d2-s3-releaseandroid14-d2-s2-releaseandroid14-d2-s1-releaseandroid14-d2-releaseandroid14-d1-s7-releaseandroid14-d1-s6-releaseandroid14-d1-s5-releaseandroid14-d1-s4-releaseandroid14-d1-s3-releaseandroid14-d1-s2-releaseandroid14-d1-s1-releaseandroid14-d1-releaseandroid13-qpr3-s9-releaseandroid13-qpr3-s8-releaseandroid13-qpr3-s7-releaseandroid13-qpr3-s6-releaseandroid13-qpr3-s5-releaseandroid13-qpr3-s4-releaseandroid13-qpr3-s3-releaseandroid13-qpr3-s2-releaseandroid13-qpr3-s14-releaseandroid13-qpr3-s13-releaseandroid13-qpr3-s12-releaseandroid13-qpr3-s11-releaseandroid13-qpr3-s10-releaseandroid13-qpr3-s1-releaseandroid13-qpr3-releaseandroid13-qpr3-c-s8-releaseandroid13-qpr3-c-s7-releaseandroid13-qpr3-c-s6-releaseandroid13-qpr3-c-s5-releaseandroid13-qpr3-c-s4-releaseandroid13-qpr3-c-s3-releaseandroid13-qpr3-c-s2-releaseandroid13-qpr3-c-s12-releaseandroid13-qpr3-c-s11-releaseandroid13-qpr3-c-s10-releaseandroid13-qpr3-c-s1-releaseandroid13-qpr2-s9-releaseandroid13-qpr2-s8-releaseandroid13-qpr2-s7-releaseandroid13-qpr2-s6-releaseandroid13-qpr2-s5-releaseandroid13-qpr2-s3-releaseandroid13-qpr2-s2-releaseandroid13-qpr2-s12-releaseandroid13-qpr2-s11-releaseandroid13-qpr2-s10-releaseandroid13-qpr2-s1-releaseandroid13-qpr2-releaseandroid13-qpr2-b-s1-releaseandroid13-qpr1-s8-releaseandroid13-qpr1-s7-releaseandroid13-qpr1-s6-releaseandroid13-qpr1-s5-releaseandroid13-qpr1-s4-releaseandroid13-qpr1-s3-releaseandroid13-qpr1-s2-releaseandroid13-qpr1-s1-releaseandroid13-qpr1-releaseandroid13-mainline-uwb-releaseandroid13-mainline-tzdata4-releaseandroid13-mainline-go-wifi-releaseandroid13-mainline-go-uwb-releaseandroid13-mainline-go-tzdata4-releaseandroid13-mainline-go-tethering-releaseandroid13-mainline-go-sdkext-releaseandroid13-mainline-go-scheduling-releaseandroid13-mainline-go-resolv-releaseandroid13-mainline-go-permission-releaseandroid13-mainline-go-os-statsd-releaseandroid13-mainline-go-odp-releaseandroid13-mainline-go-neuralnetworks-releaseandroid13-mainline-go-networking-releaseandroid13-mainline-go-mediaprovider-releaseandroid13-mainline-go-media-swcodec-releaseandroid13-mainline-go-appsearch-releaseandroid13-mainline-go-adservices-releaseandroid13-mainline-go-adbd-releaseandroid13-mainline-appsearch-releaseandroid13-mainline-adservices-releaseandroid13-frc-odp-releaseandroid13-frc-conscrypt-releaseandroid13-frc-cellbroadcast-releaseandroid13-frc-art-releaseandroid13-frc-adbd-releaseandroid13-devandroid13-d4-s2-releaseandroid13-d4-s1-releaseandroid13-d4-releaseandroid13-d3-s1-releaseandroid13-d2-releaseaml_tz5_341510010aml_tz4_332714010
Original change: https://android-review.googlesource.com/c/platform/external/volley/+/1758419 Change-Id: I7191d1e2ebb6c416909593386dbbd3481241bf8c
Diffstat (limited to 'core/src/main/java/com/android/volley/toolbox/NetworkImageView.java')
-rw-r--r--core/src/main/java/com/android/volley/toolbox/NetworkImageView.java332
1 files changed, 332 insertions, 0 deletions
diff --git a/core/src/main/java/com/android/volley/toolbox/NetworkImageView.java b/core/src/main/java/com/android/volley/toolbox/NetworkImageView.java
new file mode 100644
index 0000000..a24b3e2
--- /dev/null
+++ b/core/src/main/java/com/android/volley/toolbox/NetworkImageView.java
@@ -0,0 +1,332 @@
+/**
+ * Copyright (C) 2013 The Android Open Source Project
+ *
+ * <p>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
+ *
+ * <p>http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * <p>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.android.volley.toolbox;
+
+import android.content.Context;
+import android.graphics.Bitmap;
+import android.graphics.drawable.Drawable;
+import android.text.TextUtils;
+import android.util.AttributeSet;
+import android.view.ViewGroup.LayoutParams;
+import android.widget.ImageView;
+import androidx.annotation.MainThread;
+import androidx.annotation.Nullable;
+import com.android.volley.VolleyError;
+import com.android.volley.toolbox.ImageLoader.ImageContainer;
+import com.android.volley.toolbox.ImageLoader.ImageListener;
+
+/** Handles fetching an image from a URL as well as the life-cycle of the associated request. */
+public class NetworkImageView extends ImageView {
+ /** The URL of the network image to load */
+ private String mUrl;
+
+ /**
+ * Resource ID of the image to be used as a placeholder until the network image is loaded. Won't
+ * be set at the same time as mDefaultImageDrawable or mDefaultImageBitmap.
+ */
+ private int mDefaultImageId;
+
+ /**
+ * Drawable of the image to be used as a placeholder until the network image is loaded. Won't be
+ * set at the same time as mDefaultImageId or mDefaultImageBitmap.
+ */
+ @Nullable private Drawable mDefaultImageDrawable;
+
+ /**
+ * Bitmap of the image to be used as a placeholder until the network image is loaded. Won't be
+ * set at the same time as mDefaultImageId or mDefaultImageDrawable.
+ */
+ @Nullable private Bitmap mDefaultImageBitmap;
+
+ /**
+ * Resource ID of the image to be used if the network response fails. Won't be set at the same
+ * time as mErrorImageDrawable or mErrorImageBitmap.
+ */
+ private int mErrorImageId;
+
+ /**
+ * Bitmap of the image to be used if the network response fails. Won't be set at the same time
+ * as mErrorImageId or mErrorImageBitmap.
+ */
+ @Nullable private Drawable mErrorImageDrawable;
+
+ /**
+ * Bitmap of the image to be used if the network response fails. Won't be set at the same time
+ * as mErrorImageId or mErrorImageDrawable.
+ */
+ @Nullable private Bitmap mErrorImageBitmap;
+
+ /** Local copy of the ImageLoader. */
+ private ImageLoader mImageLoader;
+
+ /** Current ImageContainer. (either in-flight or finished) */
+ private ImageContainer mImageContainer;
+
+ public NetworkImageView(Context context) {
+ this(context, null);
+ }
+
+ public NetworkImageView(Context context, AttributeSet attrs) {
+ this(context, attrs, 0);
+ }
+
+ public NetworkImageView(Context context, AttributeSet attrs, int defStyle) {
+ super(context, attrs, defStyle);
+ }
+
+ /**
+ * Sets URL of the image that should be loaded into this view. Note that calling this will
+ * immediately either set the cached image (if available) or the default image specified by
+ * {@link NetworkImageView#setDefaultImageResId(int)} on the view.
+ *
+ * <p>NOTE: If applicable, {@link NetworkImageView#setDefaultImageResId(int)} or {@link
+ * NetworkImageView#setDefaultImageBitmap} and {@link NetworkImageView#setErrorImageResId(int)}
+ * or {@link NetworkImageView#setErrorImageBitmap(Bitmap)} should be called prior to calling
+ * this function.
+ *
+ * <p>Must be called from the main thread.
+ *
+ * @param url The URL that should be loaded into this ImageView.
+ * @param imageLoader ImageLoader that will be used to make the request.
+ */
+ @MainThread
+ public void setImageUrl(String url, ImageLoader imageLoader) {
+ Threads.throwIfNotOnMainThread();
+ mUrl = url;
+ mImageLoader = imageLoader;
+ // The URL has potentially changed. See if we need to load it.
+ loadImageIfNecessary(/* isInLayoutPass= */ false);
+ }
+
+ /**
+ * Sets the default image resource ID to be used for this view until the attempt to load it
+ * completes.
+ *
+ * <p>This will clear anything set by {@link NetworkImageView#setDefaultImageBitmap} or {@link
+ * NetworkImageView#setDefaultImageDrawable}.
+ */
+ public void setDefaultImageResId(int defaultImage) {
+ mDefaultImageBitmap = null;
+ mDefaultImageDrawable = null;
+ mDefaultImageId = defaultImage;
+ }
+
+ /**
+ * Sets the default image drawable to be used for this view until the attempt to load it
+ * completes.
+ *
+ * <p>This will clear anything set by {@link NetworkImageView#setDefaultImageResId} or {@link
+ * NetworkImageView#setDefaultImageBitmap}.
+ */
+ public void setDefaultImageDrawable(@Nullable Drawable defaultImageDrawable) {
+ mDefaultImageId = 0;
+ mDefaultImageBitmap = null;
+ mDefaultImageDrawable = defaultImageDrawable;
+ }
+
+ /**
+ * Sets the default image bitmap to be used for this view until the attempt to load it
+ * completes.
+ *
+ * <p>This will clear anything set by {@link NetworkImageView#setDefaultImageResId} or {@link
+ * NetworkImageView#setDefaultImageDrawable}.
+ */
+ public void setDefaultImageBitmap(Bitmap defaultImage) {
+ mDefaultImageId = 0;
+ mDefaultImageDrawable = null;
+ mDefaultImageBitmap = defaultImage;
+ }
+
+ /**
+ * Sets the error image resource ID to be used for this view in the event that the image
+ * requested fails to load.
+ *
+ * <p>This will clear anything set by {@link NetworkImageView#setErrorImageBitmap} or {@link
+ * NetworkImageView#setErrorImageDrawable}.
+ */
+ public void setErrorImageResId(int errorImage) {
+ mErrorImageBitmap = null;
+ mErrorImageDrawable = null;
+ mErrorImageId = errorImage;
+ }
+
+ /**
+ * Sets the error image drawable to be used for this view in the event that the image requested
+ * fails to load.
+ *
+ * <p>This will clear anything set by {@link NetworkImageView#setErrorImageResId} or {@link
+ * NetworkImageView#setDefaultImageBitmap}.
+ */
+ public void setErrorImageDrawable(@Nullable Drawable errorImageDrawable) {
+ mErrorImageId = 0;
+ mErrorImageBitmap = null;
+ mErrorImageDrawable = errorImageDrawable;
+ }
+
+ /**
+ * Sets the error image bitmap to be used for this view in the event that the image requested
+ * fails to load.
+ *
+ * <p>This will clear anything set by {@link NetworkImageView#setErrorImageResId} or {@link
+ * NetworkImageView#setDefaultImageDrawable}.
+ */
+ public void setErrorImageBitmap(Bitmap errorImage) {
+ mErrorImageId = 0;
+ mErrorImageDrawable = null;
+ mErrorImageBitmap = errorImage;
+ }
+
+ /**
+ * Loads the image for the view if it isn't already loaded.
+ *
+ * @param isInLayoutPass True if this was invoked from a layout pass, false otherwise.
+ */
+ void loadImageIfNecessary(final boolean isInLayoutPass) {
+ int width = getWidth();
+ int height = getHeight();
+ ScaleType scaleType = getScaleType();
+
+ boolean wrapWidth = false, wrapHeight = false;
+ if (getLayoutParams() != null) {
+ wrapWidth = getLayoutParams().width == LayoutParams.WRAP_CONTENT;
+ wrapHeight = getLayoutParams().height == LayoutParams.WRAP_CONTENT;
+ }
+
+ // if the view's bounds aren't known yet, and this is not a wrap-content/wrap-content
+ // view, hold off on loading the image.
+ boolean isFullyWrapContent = wrapWidth && wrapHeight;
+ if (width == 0 && height == 0 && !isFullyWrapContent) {
+ return;
+ }
+
+ // if the URL to be loaded in this view is empty, cancel any old requests and clear the
+ // currently loaded image.
+ if (TextUtils.isEmpty(mUrl)) {
+ if (mImageContainer != null) {
+ mImageContainer.cancelRequest();
+ mImageContainer = null;
+ }
+ setDefaultImageOrNull();
+ return;
+ }
+
+ // if there was an old request in this view, check if it needs to be canceled.
+ if (mImageContainer != null && mImageContainer.getRequestUrl() != null) {
+ if (mImageContainer.getRequestUrl().equals(mUrl)) {
+ // if the request is from the same URL, return.
+ return;
+ } else {
+ // if there is a pre-existing request, cancel it if it's fetching a different URL.
+ mImageContainer.cancelRequest();
+ setDefaultImageOrNull();
+ }
+ }
+
+ // Calculate the max image width / height to use while ignoring WRAP_CONTENT dimens.
+ int maxWidth = wrapWidth ? 0 : width;
+ int maxHeight = wrapHeight ? 0 : height;
+
+ // The pre-existing content of this view didn't match the current URL. Load the new image
+ // from the network.
+
+ // update the ImageContainer to be the new bitmap container.
+ mImageContainer =
+ mImageLoader.get(
+ mUrl,
+ new ImageListener() {
+ @Override
+ public void onErrorResponse(VolleyError error) {
+ if (mErrorImageId != 0) {
+ setImageResource(mErrorImageId);
+ } else if (mErrorImageDrawable != null) {
+ setImageDrawable(mErrorImageDrawable);
+ } else if (mErrorImageBitmap != null) {
+ setImageBitmap(mErrorImageBitmap);
+ }
+ }
+
+ @Override
+ public void onResponse(
+ final ImageContainer response, boolean isImmediate) {
+ // If this was an immediate response that was delivered inside of a
+ // layout
+ // pass do not set the image immediately as it will trigger a
+ // requestLayout
+ // inside of a layout. Instead, defer setting the image by posting
+ // back to
+ // the main thread.
+ if (isImmediate && isInLayoutPass) {
+ post(
+ new Runnable() {
+ @Override
+ public void run() {
+ onResponse(response, /* isImmediate= */ false);
+ }
+ });
+ return;
+ }
+
+ if (response.getBitmap() != null) {
+ setImageBitmap(response.getBitmap());
+ } else if (mDefaultImageId != 0) {
+ setImageResource(mDefaultImageId);
+ } else if (mDefaultImageDrawable != null) {
+ setImageDrawable(mDefaultImageDrawable);
+ } else if (mDefaultImageBitmap != null) {
+ setImageBitmap(mDefaultImageBitmap);
+ }
+ }
+ },
+ maxWidth,
+ maxHeight,
+ scaleType);
+ }
+
+ private void setDefaultImageOrNull() {
+ if (mDefaultImageId != 0) {
+ setImageResource(mDefaultImageId);
+ } else if (mDefaultImageDrawable != null) {
+ setImageDrawable(mDefaultImageDrawable);
+ } else if (mDefaultImageBitmap != null) {
+ setImageBitmap(mDefaultImageBitmap);
+ } else {
+ setImageBitmap(null);
+ }
+ }
+
+ @Override
+ protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
+ super.onLayout(changed, left, top, right, bottom);
+ loadImageIfNecessary(/* isInLayoutPass= */ true);
+ }
+
+ @Override
+ protected void onDetachedFromWindow() {
+ if (mImageContainer != null) {
+ // If the view was bound to an image request, cancel it and clear
+ // out the image from the view.
+ mImageContainer.cancelRequest();
+ setImageBitmap(null);
+ // also clear out the container so we can reload the image if necessary.
+ mImageContainer = null;
+ }
+ super.onDetachedFromWindow();
+ }
+
+ @Override
+ protected void drawableStateChanged() {
+ super.drawableStateChanged();
+ invalidate();
+ }
+}