Universal Image Loader

Project News

Features

Downloads

Documentation |Useful Info |User Support |Changelog

Quick Setup

1. Include library

<dependency><groupId>com.nostra13.universalimageloader</groupId><artifactId>universal-image-loader</artifactId><version>1.9.3</version></dependency>

compile'com.nostra13.universalimageloader:universal-image-loader:1.9.3'

2. Android Manifest

<manifest><!-- Include following permission if you load images from Internet--><uses-permissionandroid:name="android.permission.INTERNET" /><!-- Include following permission if you want to cache images on SD card--><uses-permissionandroid:name="android.permission.WRITE_EXTERNAL_STORAGE" />...</manifest>

3. Application or Activity class (before the first usage of ImageLoader)

publicclassMyActivityextendsActivity {@OverridepublicvoidonCreate() {super.onCreate();// Create global configuration and initialize ImageLoader with this configImageLoaderConfigurationconfig =newImageLoaderConfiguration.Builder(this)....build();ImageLoader.getInstance().init(config);...}}

Configuration and Display Options

Configuration

// DON'T COPY THIS CODE TO YOUR PROJECT! This is just example of ALL options using.// See the sample project how to use ImageLoader correctly.FilecacheDir =StorageUtils.getCacheDirectory(context);ImageLoaderConfigurationconfig =newImageLoaderConfiguration.Builder(context).memoryCacheExtraOptions(480,800)// default = device screen dimensions.diskCacheExtraOptions(480,800,null).taskExecutor(...).taskExecutorForCachedImages(...).threadPoolSize(3)// default.threadPriority(Thread.NORM_PRIORITY -2)// default.tasksProcessingOrder(QueueProcessingType.FIFO)// default.denyCacheImageMultipleSizesInMemory().memoryCache(newLruMemoryCache(2 *1024 *1024)).memoryCacheSize(2 *1024 *1024).memoryCacheSizePercentage(13)// default.diskCache(newUnlimitedDiscCache(cacheDir))// default.diskCacheSize(50 *1024 *1024).diskCacheFileCount(100).diskCacheFileNameGenerator(newHashCodeFileNameGenerator())// default.imageDownloader(newBaseImageDownloader(context))// default.imageDecoder(newBaseImageDecoder())// default.defaultDisplayImageOptions(DisplayImageOptions.createSimple())// default.writeDebugLogs().build();

Display Options

// DON'T COPY THIS CODE TO YOUR PROJECT! This is just example of ALL options using.// See the sample project how to use ImageLoader correctly.DisplayImageOptionsoptions =newDisplayImageOptions.Builder().showImageOnLoading(R.drawable.ic_stub)// resource or drawable.showImageForEmptyUri(R.drawable.ic_empty)// resource or drawable.showImageOnFail(R.drawable.ic_error)// resource or drawable.resetViewBeforeLoading(false)// default.delayBeforeLoading(1000).cacheInMemory(false)// default.cacheOnDisk(false)// default.preProcessor(...).postProcessor(...).extraForDownloader(...).considerExifParams(false)// default.imageScaleType(ImageScaleType.IN_SAMPLE_POWER_OF_2)// default.bitmapConfig(Bitmap.Config.ARGB_8888)// default.decodingOptions(...).displayer(newSimpleBitmapDisplayer())// default.handler(newHandler())// default.build();

Usage

Acceptable URIs examples

StringimageUri ="http://site.com/image.png";// from WebStringimageUri ="file:///mnt/sdcard/image.png";// from SD cardStringimageUri ="content://media/external/audio/albumart/1";// from content providerStringimageUri ="assets://image.png";// from assetsStringimageUri ="drawable://" +R.drawable.img;// from drawables (non-9patch images)

Simple

// Load image, decode it to Bitmap and display Bitmap in ImageView (or any other view//which implements ImageAware interface)imageLoader.displayImage(imageUri,imageView);

// Load image, decode it to Bitmap and return Bitmap to callbackimageLoader.loadImage(imageUri,newSimpleImageLoadingListener() {@OverridepublicvoidonLoadingComplete(StringimageUri,Viewview,BitmaploadedImage) {// Do whatever you want with Bitmap}});

// Load image, decode it to Bitmap and return Bitmap synchronouslyBitmapbmp =imageLoader.loadImageSync(imageUri);

Complete

// Load image, decode it to Bitmap and display Bitmap in ImageView (or any other view//which implements ImageAware interface)imageLoader.displayImage(imageUri,imageView,options,newImageLoadingListener() {@OverridepublicvoidonLoadingStarted(StringimageUri,Viewview) {...}@OverridepublicvoidonLoadingFailed(StringimageUri,Viewview,FailReasonfailReason) {...}@OverridepublicvoidonLoadingComplete(StringimageUri,Viewview,BitmaploadedImage) {...}@OverridepublicvoidonLoadingCancelled(StringimageUri,Viewview) {...}},newImageLoadingProgressListener() {@OverridepublicvoidonProgressUpdate(StringimageUri,Viewview,intcurrent,inttotal) {...}});

// Load image, decode it to Bitmap and return Bitmap to callbackImageSizetargetSize =newImageSize(80,50);// result Bitmap will be fit to this sizeimageLoader.loadImage(imageUri,targetSize,options,newSimpleImageLoadingListener() {@OverridepublicvoidonLoadingComplete(StringimageUri,Viewview,BitmaploadedImage) {// Do whatever you want with Bitmap}});

// Load image, decode it to Bitmap and return Bitmap synchronouslyImageSizetargetSize =newImageSize(80,50);// result Bitmap will be fit to this sizeBitmapbmp =imageLoader.loadImageSync(imageUri,targetSize,options);

Applications using Universal Image Loader

Donation

Alternative libraries

License

Copyright 2011-2014 Sergey TarasevichLicensed 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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.