Browse Source

update readme

zhangpan 5 years ago
parent
commit
1ab250c55a
2 changed files with 132 additions and 79 deletions
  1. 127 74
      README.md
  2. 5 5
      bannerview/src/main/java/com/zhpan/bannerview/BannerViewPager.java

+ 127 - 74
README.md

@@ -6,26 +6,26 @@
 
 | 嵌套RecyclerView | 自定义页面 | 嵌套PhotoView   |
 |--|--|--|
-| ![嵌套RecyclerView](https://github.com/zhpanvip/BannerViewPager/blob/master/image/preview1.gif) | ![自定义页面](https://github.com/zhpanvip/BannerViewPager/blob/master/image/preview2.gif) | ![嵌套PhotoView](https://github.com/zhpanvip/BannerViewPager/blob/master/image/preview3.gif)   |
+| [外链图片转存失败(img-JhqS7t00-1567686170213)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/preview1.gif)] | [外链图片转存失败(img-S6PbBhqg-1567686170216)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/preview2.gif)] | [外链图片转存失败(img-dZC2uU6Z-1567686170217)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/preview3.gif)]   |
 
 ## 2.自定义Indicator样式
 
 | NORMAL | SMOOTH |
 |--|--|
-| ![NORMAL](https://github.com/zhpanvip/BannerViewPager/blob/master/image/slide_normal.gif) |  ![SMOOTH](https://github.com/zhpanvip/BannerViewPager/blob/master/image/slide_smooth.gif) |
+| [外链图片转存失败(img-sV9Ykmiy-1567686170218)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/slide_normal.gif)] |  [外链图片转存失败(img-IkCrrWpD-1567686170220)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/slide_smooth.gif)] |
 
 ## 3.自定义IndicatorView
 如果以上样式不能满足你的需求,BannerViewPager还提供了完全自定义IndicatorView的功能。只要实现IIndicator接口,你就可以为所欲为的打造属于你自己的Indicator了,效果如下:
 
 | Custom Indicator |
 |--|
-| ![NORMAL](https://github.com/zhpanvip/BannerViewPager/blob/master/image/custom_indicator.gif) |
+| [外链图片转存失败(img-XaUue18N-1567686170227)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/custom_indicator.gif)] |
 
 ## 4.内置Transform样式
 
 | 参数 | STACK | ROTATE | DEPTH | ACCORDION |
 |--|--|--|--|--|
-| 预览 | ![STACK](https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_stack.gif) | ![ROTATE_DOWN](https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_rotate.gif) | ![DEPTH](https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_depth.gif)  |![ACCORDION](https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_accordion.gif)  |
+| 预览 | [外链图片转存失败(img-XSdc9Rhu-1567686170233)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_stack.gif)] | [外链图片转存失败(img-Xf9qAQjn-1567686170234)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_rotate.gif)] | [外链图片转存失败(img-tHaHnDvp-1567686170236)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_depth.gif)]  |[外链图片转存失败(img-heywPwXq-1567686170238)(https://github.com/zhpanvip/BannerViewPager/blob/master/image/transform_accordion.gif)]  |
 
 
 
@@ -33,34 +33,38 @@
 
 | 方法名 | 方法描述 | 说明 |
 |--|--|--|
-| BannerViewPager<T, VH> setInterval(int interval) | 自动轮播事件间隔 |单位毫秒,默认值3000  |
+| void startLoop() |开启自动轮播 | 初始化BannerViewPager时不必调用该方法,设置setAutoPlay后会调用startLoop() |
+| void stopLoop() | 停止自动轮播 | 如果开启自动轮播,为避免内存泄漏需要在onStop()或onDestory中调用此方法 |
+| List\<T> getList() | 获取Banner中的集合数据 |  |
 | BannerViewPager<T, VH> setCanLoop(boolean canLoop) | 是否可以循环 | 默认值true|
 | BannerViewPager<T, VH> setAutoPlay(boolean autoPlay) | 是否开启自动轮播 | 默认值true|
-| BannerViewPager<T, VH> setRoundCorner(@DimenRes int radius) | 设置圆角 |默认无圆角 需要SDK_INT>=LOLLIPOP(API 21)  |
-| BannerViewPager<T, VH> setRoundCorner(float radiusDp) | 设置圆角 | 单位dp,默认无圆角 需要SDK_INT>=LOLLIPOP(API 21)|
+| BannerViewPager<T, VH> setInterval(int interval) | 自动轮播事件间隔 |单位毫秒,默认值3000  |
+| BannerViewPager<T, VH> setScrollDuration(int scrollDuration) | 设置页面滚动时间 |  |
+| BannerViewPager<T, VH> setRoundCorner(int radius) | 设置圆角 |默认无圆角 需要SDK_INT>=LOLLIPOP(API 21)  |
+| BannerViewPager<T, VH> setOnPageClickListener(OnPageClickListener onPageClickListener) | 设置页面点击事件 |  |
+| BannerViewPager<T, VH> setHolderCreator(HolderCreator\<VH> holderCreator) |设置HolderCreator  |必须设置HolderCreator,否则会抛出NullPointerException|
 | BannerViewPager<T, VH> showIndicator(boolean showIndicator) |  是否显示指示器|默认值true  |
-| BannerViewPager<T, VH> setIndicatorGravity(int gravity) | 指示器位置 |可选值(Center、Start、End)默认值Center |
-| BannerViewPager<T, VH> setIndicatorColor(int normalColor,int checkedColor) | 指示器圆点颜色 |normalColor:未选中时颜色默认"#000000", checkedColor:选中时颜色 默认"#FFFFFF" |
-|BannerViewPager<T, VH> setIndicatorSlideMode  | 设置Indicator滑动模式 | V2.2.2新增,可选(NORMAL、SMOOTH),默认值SMOOTH  |
-| BannerViewPager<T, VH> setIndicatorRadius(float radiusDp) | 设置指示器圆点半径 | 单位dp 默认值4dp|
-| BannerViewPager<T, VH> setIndicatorRadius(@DimenRes int radiusRes) | 设置指示器圆点半径| DimenRes资源 默认值4dp|
-| BannerViewPager<T, VH> setIndicatorRadius(float normalRadius, float checkRadius) | 设置指示器圆点半径 |单位dp normalRadius:未选中时半径  checkedRadius:选中时的半径 |
-|BannerViewPager<T, VH> setIndicatorRadius(@DimenRes int normalRadius, @DimenRes int checkRadius)  |设置指示器圆点半径  |  normalRadius:未选中时半径  checkedRadius:选中时的半径 |
-| BannerViewPager<T, VH> setIndicatorMargin(float indicatorMarginDp) | 指示器圆点间距| 单位dp  默认值圆点直径|
-| BannerViewPager<T, VH> setIndicatorMargin(@DimenRes int marginRes) | 指示器圆点间距| DimenRes 默认值圆点直径|
-| BannerViewPager<T, VH> setIndicatorView(IIndicator indicatorView) | 设置自定义指示器| 2.2.3新增 设置自定义指示器后以上关于IndicatorView的参数均会失效|
-| BannerViewPager<T, VH> setCurrentItem(final int position)  |  切换到第position个页面|  |
-| BannerViewPager<T, VH> setCurrentItem(final int position, final boolean smoothScroll) | 平滑切换到第position个页面 |  |
-| BannerViewPager<T, VH> setHolderCreator(HolderCreator<VH> holderCreator) |设置HolderCreator  |必须设置HolderCreator,否则会抛出NullPointerException|
-| void startLoop() |开启自动轮播 | 初始化BannerViewPager时不必调用该方法,设置setAutoPlay后会调用startLoop() |
-| void stopLoop() | 停止自动轮播 |  |
+| BannerViewPager<T, VH> setIndicatorGravity(int gravity) | 指示器位置 |可选值(CENTER、START、END)默认值CENTER |
+| BannerViewPager<T, VH> setIndicatorColor(int normalColor,int checkedColor) | 指示器圆点颜色 |normalColor:未选中时颜色默认"#8C6C6D72", checkedColor:选中时颜色 默认"#8C18171C" |
+| BannerViewPager<T, VH> setIndicatorSlideMode(IndicatorSlideMode slideMode)  | 设置Indicator滑动模式 | 可选(NORMAL、SMOOTH),默认值SMOOTH  |
+| BannerViewPager<T, VH> setIndicatorRadius(int radiusDp) | 设置指示器圆点半径 | 默认值4dp|
+| BannerViewPager<T, VH> setIndicatorRadius(int normalRadius,int checkRadius)  |设置指示器圆点半径  |  normalRadius:未选中时半径  checkedRadius:选中时的半径,默认值4dp |
+| BannerViewPager<T, VH> setIndicatorWidth(int indicatorWidth) | 设置指示器宽度,如果是圆形指示器,则为直径 |  默认值8dp|
+| BannerViewPager<T, VH> setIndicatorWidth(int normalWidth, int checkWidth) | 设置指示器宽度,如果是圆形指示器,则为直径 | 默认值8dp |
+| BannerViewPager<T, VH> setIndicatorGap(int indicatorMarginDp) | 指示器圆点间距| 默认值为指示器宽度(或者是圆的直径)|
+| BannerViewPager<T, VH> setIndicatorView(IIndicator indicatorView) | 设置自定义指示器| 设置自定义指示器后以上关于IndicatorView的参数会部分失效|
+| BannerViewPager<T, VH> setPageTransformerStyle(TransformerStyle style) | 设置页面Transformer内置样式 |  |
+| BannerViewPager<T, VH> setIndicatorStyle(IndicatorStyle indicatorStyle) | 设置指示器样式 | 可选枚举(CIRCLE, DASH) 默认CIRCLE  |
+| ViewPager getViewPager() | 获取BannerViewPager内部封装的ViewPager |  |
 | void create(List<T> list) |初始化并构造BannerViewPager  |必须调用,否则前面设置的参数无效  |
 
+
+
 # 如何使用
 
 ## 1.gradle中添加依赖
    
-latestVersion is: [ ![latestVersion](https://api.bintray.com/packages/zhpanvip/CircleViewPager/bannerview/images/download.svg) ](https://bintray.com/zhpanvip/CircleViewPager/bannerview/_latestVersion)
+latestVersion is: [ [外链图片转存失败(img-ea1UXLGv-1567686170240)(https://api.bintray.com/packages/zhpanvip/CircleViewPager/bannerview/images/download.svg)] ](https://bintray.com/zhpanvip/CircleViewPager/bannerview/_latestVersion)
 
 如果您已迁移到AndroidX请使用2.2.4以上版本
 ```
@@ -82,7 +86,43 @@ implementation 'com.zhpan.library:bannerview:2.1.5'
             android:layout_height="160dp" />
 ```
 
-## 3.自定义ViewHolder
+## 3.Banner的页面布局
+
+```
+<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content">
+
+    <ImageView
+        android:id="@+id/banner_image"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:scaleType="centerCrop" />
+
+    <LinearLayout
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:layout_alignParentBottom="true"
+        android:background="#66000000"
+        android:gravity="center_vertical">
+
+        <TextView
+            android:id="@+id/tv_describe"
+            android:layout_width="wrap_content"
+            android:layout_height="match_parent"
+            android:layout_gravity="center_vertical"
+            android:layout_marginStart="15dp"
+            android:gravity="center_vertical"
+            android:paddingTop="5dp"
+            android:paddingBottom="5dp"
+            android:textColor="#FFFFFF"
+            android:textSize="16sp" />
+    </LinearLayout>
+
+</RelativeLayout>
+```
+
+## 4.自定义ViewHolder
 
 ```
 public class NetViewHolder implements ViewHolder<BannerData> {
@@ -106,7 +146,7 @@ public class NetViewHolder implements ViewHolder<BannerData> {
 }
 ```
 
-## 4.BannerViewPager参数配置
+## 5.BannerViewPager参数配置
 
 ```
     private BannerViewPager<BannerData, NetViewHolder> mBannerViewPager;
@@ -114,21 +154,23 @@ public class NetViewHolder implements ViewHolder<BannerData> {
 	private void initViewPager() {
              mBannerViewPager = findViewById(R.id.banner_view);
              mBannerViewPager.showIndicator(true)
-                            .setInterval(3000)
-                            .setRoundCorner(7f)
-                            .setIndicatorColor(Color.parseColor("#935656"), Color.parseColor("#FF4C39"))
-                            .setIndicatorGravity(BannerViewPager.END)
-                            .setScrollDuration(1000).setHolderCreator(NetViewHolder::new)
-                            .setOnPageClickListener(position -> {
-                                BannerData bannerData = mBannerViewPager.getList().get(position);
-                                Toast.makeText(NetworkBannerActivity.this,
-                                        "点击了图片" + position + " " + bannerData.getDesc(), Toast.LENGTH_SHORT).show();
-
-                            }).create(mList);
+                .setInterval(3000)
+                .setCanLoop(false)
+                .setAutoPlay(true)
+                .setRoundCorner(DpUtils.dp2px(7))
+                .setIndicatorColor(Color.parseColor("#935656"), Color.parseColor("#FF4C39"))
+                .setIndicatorGravity(BannerViewPager.END)
+                .setScrollDuration(1000).setHolderCreator(NetViewHolder::new)
+                .setOnPageClickListener(position -> {
+                    BannerData bannerData = mBannerViewPager.getList().get(position);
+                    Toast.makeText(NetworkBannerActivity.this,
+                            "点击了图片" + position + " " + bannerData.getDesc(), Toast.LENGTH_SHORT).show();
+
+                }).create(mList);
         }
 ```
 
-## 5.开启与停止轮播
+## 6.开启与停止轮播
 
 如果开启了自动轮播功能,请务必在onDestroy中停止轮播,以免出现内存泄漏。
 
@@ -159,88 +201,98 @@ public class NetViewHolder implements ViewHolder<BannerData> {
 ```
 ## 6.高级功能---自定义IndicatorView
 
-**(1)自定义View并实现IIndicator接口**
+**(1)自定义View并继承BaseIndicatorView**
 
 ```
-public class RectangleIndicatorView extends View implements IIndicator {
-    ...
+public class DashIndicatorView extends BaseIndicatorView implements IIndicator {
+    private Paint mPaint;
+    private float sliderHeight;
+
+    public DashIndicatorView(Context context) {
+        this(context, null);
+    }
+
+    public DashIndicatorView(Context context, AttributeSet attrs) {
+        this(context, attrs, 0);
+    }
 
-    public RectangleIndicatorView(Context context, AttributeSet attrs, int defStyleAttr) {
+    public DashIndicatorView(Context context, AttributeSet attrs, int defStyleAttr) {
         super(context, attrs, defStyleAttr);
-        normalColor = Color.parseColor("#8C18171C");
-        checkedColor = Color.parseColor("#8C6C6D72");
         mPaint = new Paint();
         mPaint.setColor(normalColor);
         mPaint.setAntiAlias(true);
-        sliderWidth = DpUtils.dp2px(context, 5);
-        sliderHeight = sliderWidth / 2;
-        mMargin = sliderWidth;
+        sliderHeight = normalIndicatorWidth / 2;
+    }
+
+    @Override
+    protected void onSizeChanged(int w, int h, int oldw, int oldh) {
+        super.onSizeChanged(w, h, oldw, oldh);
     }
 
     @Override
     protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
         super.onMeasure(widthMeasureSpec, heightMeasureSpec);
-        setMeasuredDimension((int) ((mPageSize - 1) * mMargin + sliderWidth * mPageSize),
+        setMeasuredDimension((int) ((mPageSize - 1) *mIndicatorGap  + normalIndicatorWidth * mPageSize),
                 (int) (sliderHeight));
     }
 
+    @Override
+    protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
+        super.onLayout(changed, left, top, right, bottom);
+    }
+
     @Override
     protected void onDraw(Canvas canvas) {
         super.onDraw(canvas);
         mPaint.setColor(normalColor);
         for (int i = 0; i < mPageSize; i++) {
             mPaint.setColor(normalColor);
-            canvas.drawRect(i * (sliderWidth) + i * +mMargin, 0, i * (sliderWidth) + i * +mMargin + sliderWidth, sliderHeight, mPaint);
+            canvas.drawRect(i * (normalIndicatorWidth) + i * +mIndicatorGap, 0, i * (normalIndicatorWidth) + i * +mIndicatorGap + normalIndicatorWidth, sliderHeight, mPaint);
         }
         drawSliderStyle(canvas);
     }
 
     @Override
     public void onPageSelected(int position) {
-        if (mSlideStyle == IndicatorSlideMode.NORMAL) {
-            this.currentPosition = position;
-            invalidate();
-        }
+        super.onPageSelected(position);
     }
 
     @Override
     public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {
-        if (mSlideStyle == IndicatorSlideMode.SMOOTH) {
-            slideProgress = positionOffset;
-            currentPosition = position;
-            invalidate();
-        }
+        super.onPageScrolled(position, positionOffset, positionOffsetPixels);
     }
 
     @Override
     public void onPageScrollStateChanged(int state) {
-
+        super.onPageScrollStateChanged(state);
     }
 
     private void drawSliderStyle(Canvas canvas) {
-        switch (mSlideStyle) {
-            case NORMAL:
-                slideProgress = 0;
-            case SMOOTH:
-                slideProgress = (currentPosition == mPageSize - 1) ? 0 : slideProgress;
-                break;
-        }
         mPaint.setColor(checkedColor);
-        canvas.drawRect(currentPosition * (sliderWidth) + currentPosition * +mMargin + (sliderWidth + mMargin) * slideProgress, 0, currentPosition * (sliderWidth) + currentPosition * +mMargin + (sliderWidth + mMargin) * slideProgress + sliderWidth, sliderHeight, mPaint);
+        float left = currentPosition * (checkedIndicatorWidth) + currentPosition * +mIndicatorGap + (checkedIndicatorWidth + mIndicatorGap) * slideProgress;
+        canvas.drawRect(left, 0, left + checkedIndicatorWidth, sliderHeight, mPaint);
     }
-    ...
- }
+
+    public DashIndicatorView setSliderHeight(int sliderHeight) {
+        this.sliderHeight = sliderHeight;
+        return this;
+    }
+}
 ```
 **(2)BannerViewPager设置自定义Indicator**
 
 ```
-RectangleIndicatorView indicatorView = new RectangleIndicatorView(this);
-        indicatorView.setPageSize(list.size()).setSliderWidth(8f).setSliderHeight(3.5f)
-                .setIndicatorMargin(5f).setCheckedColor(getResources().getColor(R.color.colorAccent))
-                .setNormalColor(getResources().getColor(R.color.colorPrimary));
-        viewPager.setIndicatorView(indicatorView)
+ DashIndicatorView indicatorView = new DashIndicatorView(this);
+        indicatorView.setPageSize(list.size());
+        indicatorView.setIndicatorWidth(DpUtils.dp2px(8), DpUtils.dp2px(8));
+        indicatorView.setSliderHeight(DpUtils.dp2px(4));
+        indicatorView.setIndicatorGap(DpUtils.dp2px(5));
+        indicatorView.setCheckedColor(getResources().getColor(R.color.colorAccent));
+        indicatorView.setNormalColor(getResources().getColor(R.color.colorPrimary));
+        viewPager.setAutoPlay(false).setCanLoop(true)
+                .setRoundCorner(DpUtils.dp2px(5))
+                .setIndicatorView(indicatorView)
                 .setHolderCreator(SlideModeViewHolder::new).create(list);
-
 ```
 
 # TODO 版本计划
@@ -260,6 +312,7 @@ RectangleIndicatorView indicatorView = new RectangleIndicatorView(this);
  (7)ViewPager更换为ViewPager2 (3.0.0)
  
  (8)目前Indicator部分代码比较乱,还有很大很大的优化空间,后续版本将持续优化
+ 
 
 
 [更多详情请点击此处](https://juejin.im/post/5d6bce24f265da03db0790d1)

+ 5 - 5
bannerview/src/main/java/com/zhpan/bannerview/BannerViewPager.java

@@ -8,7 +8,6 @@ import android.os.Build;
 import android.os.Handler;
 
 import androidx.annotation.ColorInt;
-import androidx.annotation.DimenRes;
 import androidx.annotation.IntDef;
 import androidx.viewpager.widget.ViewPager;
 
@@ -381,12 +380,12 @@ public class BannerViewPager<T, VH extends ViewHolder> extends FrameLayout imple
     /**
      * 设置圆角ViewPager
      *
-     * @param radiusDp 圆角大小
+     * @param radius 圆角大小
      */
-    public BannerViewPager<T, VH> setRoundCorner(int radiusDp) {
+    public BannerViewPager<T, VH> setRoundCorner(int radius) {
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
             ViewStyleSetter viewStyleSetter = new ViewStyleSetter(this);
-            viewStyleSetter.setRoundCorner(radiusDp);
+            viewStyleSetter.setRoundCorner(radius);
         }
         return this;
     }
@@ -431,8 +430,9 @@ public class BannerViewPager<T, VH extends ViewHolder> extends FrameLayout imple
     /**
      * 设置页面Transformer内置样式
      */
-    public void setPageTransformerStyle(TransformerStyle style) {
+    public BannerViewPager<T, VH> setPageTransformerStyle(TransformerStyle style) {
         mViewPager.setPageTransformer(true, new PageTransformerFactory().createPageTransformer(style));
+        return this;
     }