ImageLoadingListener.java

/*******************************************************************************
 * Copyright 2011-2013 Sergey Tarasevich
 *
 * 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.smartandroid.sa.zUImageLoader.core.listener;

import android.graphics.Bitmap;
import android.view.View;

import com.smartandroid.sa.zUImageLoader.core.assist.FailReason;

/**
 * Listener for image loading process.<br />
 * You can use {@link SimpleImageLoadingListener} for implementing only needed
 * methods.
 * 
 * @author Sergey Tarasevich (nostra13[at]gmail[dot]com)
 * @see SimpleImageLoadingListener
 * @see com.nostra13.universalimageloader.core.assist.FailReason
 * @since 1.0.0
 */
public interface ImageLoadingListener {

	/**
	 * Is called when image loading task was started
	 * 
	 * @param imageUri
	 *            Loading image URI
	 * @param view
	 *            View for image
	 */
	void onLoadingStarted(String imageUri, View view);

	/**
	 * Is called when an error was occurred during image loading
	 * 
	 * @param imageUri
	 *            Loading image URI
	 * @param view
	 *            View for image. Can be <b>null</b>.
	 * @param failReason
	 *            {@linkplain com.nostra13.universalimageloader.core.assist.FailReason
	 *            The reason} why image loading was failed
	 */
	void onLoadingFailed(String imageUri, View view, FailReason failReason);

	/**
	 * Is called when image is loaded successfully (and displayed in View if one
	 * was specified)
	 * 
	 * @param imageUri
	 *            Loaded image URI
	 * @param view
	 *            View for image. Can be <b>null</b>.
	 * @param loadedImage
	 *            Bitmap of loaded and decoded image
	 */
	void onLoadingComplete(String imageUri, View view, Bitmap loadedImage);

	/**
	 * Is called when image loading task was cancelled because View for image
	 * was reused in newer task
	 * 
	 * @param imageUri
	 *            Loading image URI
	 * @param view
	 *            View for image. Can be <b>null</b>.
	 */
	void onLoadingCancelled(String imageUri, View view);
}