[English](https://github.com/AbbyJM/XBanner) | **中文版**
XBanner
=========
支持无限轮播的广告插件，提供gif支持。
## 简介
XBanner是一个支持无限轮播的广告控件，主要通过viewpager实现。你可以自定义指示器的风格。XBanner提供了gif支持，为了提供更好的性能，采用了第三方依赖库android-gif-drawable。
## 效果
#### 最终的效果
## Gradle
```java
dependencies{
compile 'com.abby.app:xbanner:1.5.7' //最新版本
//非常感谢 koral--的android-gif-drawable,这是一个高性能的gif加载依赖库
//使用这个库的原因是ImageView配合Glide加载gif图片的性能并不是很好
//android-gif-drawable已经添加在本项目中
}
```
## 用法
#### 一个简单的用法如下所示 //注意，必须在视图销毁时调用releaseBanner()来释放回调
```java
@Override
public void onCreate(Bundle savedInstanceState) {
int[] res={R.drawable.pic1,R.drawable.pic2,R.drawable.pic3,R.drawable.pic4,R.drawable.pic5};
xbanner.isAutoPlay(false)
.setDelay(3000)
.setImageRes(res)
.start();
}
@Override
public void onDestroy(){
super.onDestroy();
xbanner.releaseBanner(); //必须在视图销毁时调用releaseBanner()来释放回调
}
```
#### 一个简单的使用标题的例子 ***注意，使用标题时一定要将Bannertype设置成TITLE对应的风格***
```java
@Override
public void onCreate(Bundle savedInstanceState) {
int[] res={R.drawable.pic1,R.drawable.pic2,R.drawable.pic3,R.drawable.pic4,R.drawable.pic5};
List titles=Arrays.asList("This is the picture 1","This is the picture 2","This is the picture 3","This is the picture 4","This is the picture 5");
xbanner.isAutoPlay(false)
.setBannerTypes(XBanner.NUM_INDICATOR_TITLE)//使用标题时一定要将Bannertype设置成TITLE对应的风格以避免一些逻辑错误
.setDelay(3000)
.setImageRes(res)
.setTitles(titles)// 也可以使用setImageResAndTitles(res,titles)
.start();
}
@Override
public void onDestroy(){
super.onDestroy();
xbanner.releaseBanner();// 必须在视图销毁时调用releaseBanner()来释放回调
}
```
#### 如果从网络中获取图像时，必须设置一个Imageloader，但如果加载的是gif图片，可以使用内置的loader
```java
@Override
public void onCreate(Bundle savedInstanceState) {
List imageUrls=new ArrayList<>();
imageUrls.add("http://img2.tgbusdata.cn/v2/thumb/jpg/YzQ0NSw4MzAsNjQwLDQsMywxLC0xLDAscms1MA==/u/olpic.tgbusdata.cn/uploads/allimg/160324/238-160324160031.jpg");
imageUrls.add("http://img2.tgbusdata.cn/v2/thumb/jpg/ZjliZCw4MzAsNjQwLDQsMywxLC0xLDAscms1MA==/u/olpic.tgbusdata.cn/uploads/allimg/160324/238-160324160031-50.jpg");
xbanner.isAutoPlay(false)
.setDelay(3000)
.setImageUrls(imageUrls)
//.asGif() 如果加载的是gif则调用此方法
.setImageLoader(new AbstractUrlLoader() {
@Override
/**
*简单Glide使用方法，当然你可以自己自定义
*加载gif图片时，可以不用设置loader而使用内置的loader，当然也可以自己定义
*/
public void loadImages(Context context, String url, ImageView image) {
Glide.with(context)
.load(url)
.into(image);
}
@Override
public void loadGifs(String url, GifImageView gifImageView, ImageView.ScaleType scaleType) {
}
}).start();
}
@Override
public void onDestroy(){
super.onDestroy();
xbanner.releaseBanner();// 必须在视图销毁时调用releaseBanner()来释放回调
}
```
## 加载gif的简单示例
```java
@Override
public void onCreate(Bundle savedInstanceState) {
banner.setImageUrls(gifUrls)
.asGif()
.setLoadingProgressType(XBanner.CIRCLE_PROGRESS) //这里可以设置gif加载动画
//可以是圆形加载动画CIRCLE_PROGRESS或者文本加载进度TEXT_PROGRESS
.start();
}
@Override
public void onDestroy(){
super.onDestroy();
xbanner.releaseBanner();// 必须在视图销毁时调用releaseBanner()来释放回调
}
```
## 特性(主要方法)
|名称|描述|参数
|----|-----|----|
|setBannerTypes|设置banner类型,默认的类型是CIRCLE_INDICATOR|CIRCLE_INDICATOR,***CIRCLE_INDICATOR_TITLE***,CUBE_INDICATOR,***NUM_INDICATOR,NUM_INDICATOR_TITLE***|
|setIndicatorGravity|设置指示器的重心方向,___默认的类型是 CENTER___|INDICATOR_START,***INDICATOR_CENTER***,INDICATOR_END|
|setUpIndicatorSize|设置指示器的尺寸,***单位为像素，选中和未选中的尺寸都会同时设定***|int size|
|setUpIndicators|设置指示器选中和未选中时的图片ResourceID|int res_selected,int res_unselected|
|setEllipsizeType|设置标题文本的ellipsizetype,___默认的类型END___|ELLIPSIZE_END,***ELLIPSIZE_MARQUEE***|
|setImageScaleType|设置图片的缩放类型,___注意，这个方法必须在图片设置之前调用，否则会没有效果___,___默认的缩放类型是FIT_XY___|ImageView.ScaleType scaletype|
|setScroller|设置scroller|将要设置的scroller
|setTitlebgAlpha|设置标题的背景为透明|不需要参数|
|setImageRes|设置图片的resourceID|int[] res|
|setImageUrls|设置图片的url|List< String > urls|
|setTitles|设置标题|List< String > titles|
|setImageResAndTitles|设置图片的resourceID和标题|int[] res,List< String > titles|
|setImageUrlsAndTitles|设置图片的url和标题|List< String > urls,List< String > titles|
|setPageTransformer|设置一个transformer给viewpager|PageTransformer transformer|
|setDelay|设置播放的延迟,***单位是毫秒***|int delay|
|isAutoPlay|指出banner是否是自动播放，***默认情况下不自动播放***|boolean is autoPlay|
|setTransformerSpeed,***默认是600毫秒***|设置未拖拽情况下transformer的切换延迟|int speed|
|setTitleHeight|设置标题的高度,***单位是像素***|int height|
|setBannerPageListener|设置banner的监听器|BannerPageListener listener|
|getViewPager|获得banner的viewpager|不需要参数|
|asGif|指出当前加载的url是不是来自gif图片|不需要参数|
|clearGifCache|清楚gif的缓存|不需要参数|
|autoDeleteGifCache|当达到一个阈值时自动清除gif缓存|int sizeInMB|
|start|banner开始播放,***一定要调用这个方法来开始播放***|不需要参数|
|setLoadingProgressType|设置加载gif图片时的加载动画|CIRCLE_PROGRESS或者TEXT_PROGRESS|
|notifyDataSetChanged|在重新调用setImageUrls或setImageRes后调用，可以在运行时刷新数据|no params|
## 注意
* []() 如果图片无法显示，请首先检查权限设置，然后确认图片是否可用
* []() 显示标题时一定要将banner的类型设置为TITLE类型以避免一些不必要的逻辑错误
* []() 一定要在图片设置完之前调用setImageScaleType
* []() 必须设置一个Imageloader如果当前加载的图片来自于网络，但是如果加载的是gif图片，可以不设置，将使用内置的加载器
* []() 一定要调用asGif()如果当前加载的图片是gif图片
* []() 必须在视图销毁时调用releaseBanner()来释放回调
* []() 为了获取更好的视觉效果，当我们使用标题的时候指示器重心将设置在末端
* []() 当您加载gif的时候请确保使用正确的gif图片，否则可能无法显示
* []() 可以通过调用notifyDataSetChanged来通知xbanner数据更新，此时也应该同时设置新的bannerPageListener来获取正确的响应，因为listener基于viewpager的位置而不是图片本身设定，***gif暂时不能刷新因为重新加载gif将造成巨大的开销***
* []() 支持API 19以及更高版本，因为某些API需要更高的版本支持
## 更新
#### v1.5.2:
* []()因为加载gif的时间可能会有点长，所以考虑加入方法setLoadingProgressType(int type)来设置加载gifs时的加载动画
* []()一些内存方面的优化和gif下载过程的优化
#### v1.5.3:
* []()解决gif可能无法显示的问题
#### v1.5.5:
* []()支持运行时修改图片来源，可以调用notifyDataSetChanged()来通知xbanner来更新图片来源
#### v1.5.6:
* [] ()移除AndroidManifest中的icon设置，在某些AndroidO设备会导致问题
# License
Copyright 2017 AbbyJM
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.