GitHub - frapontillo/ImageViewEx: [DEPRECATED] - Extension of Android's ImageView that supports animated GIFs and includes a better density management.
Extension of Android's ImageView that supports animated GIFs and includes a better density management.
The ImageViewEx is an extension of the standard Android ImageView that fills in one of the biggest gaps in the standard ImageView: displaying animated GIFs.
The Android Framework Drawable class, in fact, only supports static GIFs. This View is able to receive a raw image in byte[] form, bypassing the standard Drawables handling and thus providing broader support.
The ImageViewEx also allows you to specify what has to be considered the default image density when loading images from raw data. Android defaults to considering mdpi as the baseline, but using setInDensity you can choose to change it to whatever value you like (we suggest to stick to standard abstracted density buckets like hdpi thou).
The following is a brief documentation of the classes, methods and views included in this library.
The Eclipse project included specifies this is a library project, although it provides two basic Activities for testing the extended ImageViews provided.
For your application, you need to include the permissions specified in the AndroidManifest of the library, which are:
The ImageViewExService service is also internally used by ImageViewNext for handling asynchronous operation. You need to declare this service in your AndroidManifest.xml:
<service android:name="net.frakbot.imageviewex.service.ImageViewExService"/>
Simply call img.setSource(mGIF) and see your GIF animating. Note that there may be some issues under some conditions (see Known issues and workarounds).
What if you don't know if an image is a GIF or a regular one? No problem, simply call setSource and ImageViewEx will do the rest, displaying your image as a regular one or an animated GIF when necessary.
As mentioned earlier, you may not want to animate some GIF under some conditions.
So we've provided you with a conditional method that gets triggered just before each animation begins, boolean canAnimate(). This method should be overridden by your custom implementation. By default, it always returns true. This method decides whether animations can be started for this instance of ImageViewEx.
If you don't want to have another class extending ImageViewEx and your canAnimate() returns the same value throughout your application, you can use the following
ImageViewNext.setCanAlwaysAnimate(false);
to specify you never want to animate GIFs. If you don't set any value to setCanAlwaysAnimate, it defaults to true. The result you get by setting the value to false is that it will stop all animations, no matter what canAnimate() returns.
You can check the current behavior by calling the static boolean getCanAlwaysAnimate() method.
ImageViewExService is used by ImageViewNext, an extension of ImageViewEx that handles downloading, displaying and caching of images (and animated GIFs, of course).
ImageViewNext extends ImageViewEx, thus supporting all of its methods, plus some more.
In order to get images from the Internet, simply call setUrl(String url) to start retrieving an image from the internet or the caches.
ImageViewNext can be overridden in order to do some custom operations in the following methods:
void onMemCacheHit(byte[] image)is called as soon as there's a memory cache hit for the requested URLvoid onMemCacheMiss()is called as soon as there's a memory cache miss for the requested URLvoid onDiskCacheHit(byte[] image)is called as soon as there's a disk cache hit for the requested URLvoid onDiskCacheMiss()is called as soon as there's a disk cache miss for the requested URLvoid onNetworkHit(byte[] image)is called as soon as there's a network hit for the requested URLvoid onNetworkMiss()is called as soon as there's a network miss for the requested URLvoid onMiss()is called when an error occurs or the resource can't be found anywherevoid onSuccess(byte[] image)is automatically called after the image has been retrieved
You should not worry about setting images, as this is handled by ImageViewNext itself , which by defaults sets the loading image when there's a memory miss (on onMemCacheMiss()), an error one in case of error (onMiss()) and the retrieved image in case of success (onSuccess(byte[] image)).
If you override ImageViewNext, always call the default implementation of these methods.
By default, starting from version 2.2.0, each ImageViewNext will listen to network availability changes and automatically retry and get the image from the Internet, if and only if the same instance failed to do so in the previous attempt.
If you want to override the default behavior you can use:
setClassAutoRetryFromNetwork(boolean classAutoRetryFromNetwork)to set a class-level behaviorsetAutoRetryFromNetwork(boolean autoRetryFromNetwork)to set an instance-specific behavior
To know what the current settings are in regards to auto retry, use:
isClassAutoRetryFromNetwork()to get the class-level settingisAutoRetryFromNetwork()to retrieve the instance-specific setting
Remember: the instance-specific setting has an higher priority than the class-level setting.
You can set the maximum number of concurrent threads; threads are used to retrieve an image, given its URL, from the memory cache, the disk cache or the network.
Use ImageViewNext.setMaximumNumberOfThreads(THREAD_NUMBER) BEFORE any ImageViewNext object is instantiated (ideally, in your Application class), as calling this function again after an ImageViewNext has been instantiated will have no effect.
You can retrieve the maximum number of concurrent threads with ImageViewNext.getMaximumNumberOfThreads().
ImageViewExinternally uses an old Android Framework class, Movie, to parse animated GIFs. This ensures fast execution, since the Movie class internally relies on native code. Due to Movie being a legacy class, though, there are a few quirks.
Firstly, you can't have Movie working on an hardware-accelerated canvas in Honeycomb and newer versions of Android. The ImageViewEx thus automatically disables hardware acceleration by itself when it has to display a GIF image. One side effect is that hardware acceleration is "lost" forever on the View once turned off, so if you reuse the ImageViewEx and at some point you assign a GIF image to it, from that point onwards it won't be hardware accelerated anymore. That's a limitation Android itself imposes, so there's not much we can do about that. On the bright side, this only affects cases where hardware acceleration is available; even when software rendering is active, there's not a big performance hit thou.
The second issue is that Movie has serious issues on some emulator instances and some retail devices. This is most likely due to some broken code down at native (maybe in Skia) or video driver level. So not much we can do on this one either. On the bright side, we've provided a workaround, that is setting setCanAlwaysAnimate(false) on phones known to cause issues. You will lose animation support, but you don't need to get crazy trying to handle several layouts, some using ImageViews and some using ImageViewExes.
Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
Copyright (c) 2011-2013 Francesco Pontillo and Sebastiano Poggi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.