EasyMarquee——一个基于ViewFlipper的滚动轮播库

前言

在Android中经常会遇到多条广播或者多条消息轮播的业务场景,一般的交互是在有限的空间里面自动上下滚动或者左右滚动,如下:

轮播效果图.png

有多种方式可以实现这种效果,本文基于Android的一个视图切换控件——ViewFlipper来实现,ViewFlipper顾名思义就是视图的翻转,有点类似于ViewPager,但又有点区别,Google的解释如下:

可以看到,ViewFlipper 本质也是一个View,继承于 ViewAnimatorViewAnimatorFrameLayout 的一个子类,用来做View之间的切换。它是一个变换控件的元素,帮助我们很方便地在View之间进行变换。

因此基于 ViewFlipper 实现合适不过,在 ViewFlipper 的基础上封装切换的动画,并且基于适配器的形式来填充 ViewFlipper 的数据(毕竟是个Androider都能习惯RecyclerView的使用姿势),正好巩固一下设计模式,温故而知新~
 

效果预览

效果图.gif

 

实现思路

由于 ViewFlipper 本身是采用 addView 的方式,将子View一个个填充进去,这样的话每次都要对每个子View去做各自的填充操作,不方便统一管理和刷新,于是自定义了一个Adapter层级,作为 ViewFlipper 与外界对接数据的中间者,就类似于 RecyclerView 那样 onCreateView 创建子视图,onBindView 绑定子视图数据,使用方只需要继承于Adapter,重写方法返回子视图布局。然后在 ViewFlipper 中持有Adapter实例,通过这个实例获取到使用方传过来的View,再添加到 ViewFlipper 中即可:

Adapter作为桥接角色

具体步骤如下:

1.定义抽象Adapter,封装绑定数据逻辑
2.自定义ViewFlipper,通过Adapter获取数据
3.触发滚动和停止滚动
4.自定义滚动动画
5.设置滚动监听

 

实现步骤

1.定义抽象Adapter,封装绑定数据逻辑

public abstract class MarqueeAdapter<T> {

    private List<View> mViewList;
    private List<T> mDataList;
    private DataObserver<T> mObserver;

    public List<View> getChildViews() {
        return mViewList;
    }

    public void setData(List<T> data) {
        mDataList.clear();
        mDataList.addAll(data);
        for (int index = 0; index < mDataList.size(); index++) {
            View itemView;
            if (index < mViewList.size()) {
                itemView = mViewList.get(index);
            } else {
                itemView = onCreateView(index, data.get(index));
                mViewList.add(itemView);
            }
            onBindView(index, itemView, mDataList.get(index));
        }
        notifyDataSetChanged();
    }

    public void notifyDataSetChanged() {
        if (mObserver != null) {
            mObserver.onDataChange();
        }
    }

    public abstract View onCreateView(int position, T data);

    public abstract void onBindView(int position, View view, T data);

}

由于篇幅有限,此处只抽取出关键代码,由于要给具体调用方继承,所以这里定义为抽象类,抽象出两个方法:

public abstract View onCreateView(int position, T data): 返回类型为View,具体调用方通过重写该方法返回自定义布局
public abstract void onBindView(int position, View view, T data): 为视图填充数据时调用,具体调用方通过重写该方法,将具体的数据绘制在子视图的具体控件上,实现每个子视图各自的业务逻辑

这里定义了一个setData 方法,外界通过这个方法将数据传进来,遍历数据,如果当前下标的子视图还没创建,就调用 onCreateView 新建一个子视图,如果当前下标已有视图,则不再重复创建,然后调用 onBindView 通知外界填充子视图数据。
 

2.自定义ViewFlipper,通过Adapter获取数据

public class EasyMarqueeView extends ViewFlipper {

    private MarqueeAdapter<?> marqueeAdapter;

    @SuppressWarnings("rawtypes")
    private DataObserver dataObserver = new DataObserver() {
        @Override
        public void onDataChange() {
            //adapter中setData的时候会回调这里
            notifyChange();
        }
    };

    //.....此处忽略部分代码

    public void setMarqueeAdapter(MarqueeAdapter<?> adapter) {
        marqueeAdapter = adapter;
        marqueeAdapter.registerDataSetObserver(dataObserver);
    }

    private void notifyChange() {
        List<View> children = marqueeAdapter.getChildViews();
        if (children != null && children.size() > 0) {
            removeAllViews();
            for (View view: children) {
                addView(view);
            }
        }
    }
}

继承于 ViewFlipper,并且提供 setMarqueeAdapter(MarqueeAdapter<?> adapter) 方法,获取外界传进来的具体的adapter子类,同时设置注册adapter的监听,等到外界设置新数据的时候,由adapter触发回调 onDataChange() ,此刻Adapter里面的子视图已经创建好了,因此可以开始遍历获取子视图并 addView 了。
 

3.触发滚动和停止滚动

上面两步已经准备好了子视图的布局和数据,接着就可以开始滚动了,由于是继承 ViewFlipper,可以直接调用 ViewFlipperstartFlipping 触发滚动:

public void startFlip() {
    if (!isFlipping()) {
        startFlipping();
    }
}

相应的提供停止滚动的方法,在需要退出页面销毁或者主动停止的时候调用:

public void stopFlip() {
    if (isFlipping()) {
        stopFlipping();
    }
}

 

4.自定义滚动动画

ViewFlipper 本身已经提供了设置进场动画和出场动画的方法:

public void setInAnimation(Animation inAnimation)
public void setOutAnimation(Animation outAnimation)

可以看到都是基于 Animation ,我们可以通过定义anim类型的xml配置生成 Animation也可以直接在代码里初始化构造 Animation

Animation enterAnimation = AnimationUtils.loadAnimation(getContext(), R.anim.xxx);
Animation exitAnimation = AnimationUtils.loadAnimation(getContext(), R.anim.xxx);
enterAnimation.setDuration(mDuration);
exitAnimation.setDuration(mDuration);
setInAnimation(enterAnimation);
setOutAnimation(exitAnimation);

当然,由于我们是继承于 ViewFlipper, 所以也可以由外界来自定义anim对象设置给 ViewFlipper

 

5.设置滚动监听

ViewFlipper 本身是没有滚动监听方法的,但我们可以通过每次滚动时退场动画的结束监听,来代表每一轮的滚动,利用 Animation 对象提供的 setAnimationListener 方法:

Animation outAnimation = getOutAnimation();
if (outAnimation != null) {
    outAnimation.setAnimationListener(new Animation.AnimationListener() {
        @Override
        public void onAnimationStart(Animation animation) {}

        @Override
        public void onAnimationEnd(Animation animation) {
            if (mListener != null) {
                mListener.onMarquee(getCurrentItem());
            }
        }

        @Override
        public void onAnimationRepeat(Animation animation) {}
    });
}

//滚动监听接口
public interface MarqueeListener {
    void onMarquee(int position);
}

 

结语

本文所涉及的所有代码均已上传到GitHub,传送门:EasyMarquee
取名为 EasyMarquee,简而言之就是为了更方便更灵活地定义滚动轮播效果,目前支持的属性如下:

1)基于ViewFlipper实现,继承ViewFlipper的所有方法
2)支持设置滚动方向和滚动时长
3)支持自定义每个滚动项的样式
4)支持动态更新滚动数据
5)支持添加滚动监听
6)支持AndroidX

同时本库也提供了其它的一些配置,例如 getCurrentItemsetFlipInterval 等,继承了 ViewFlipper 的所有方法,滚动轮播效果已经基本满足需求,后续会再针对视图的复用和其它拓展属性继续更新,提升组件的性能,欢迎issue和star~
 

欢迎关注 Android小Y 的简书,更多Android精选自定义View

『Android自定义View实战』实现一个小清新的弹出式圆环菜单
『Android自定义View实战』玩转PathMeasure之自定义支付结果动画
『Android自定义View实战』自定义弧形旋转菜单栏——卫星菜单
『Android自定义View实战』Android自定义带侧滑菜单的二维表格控件

GitHubGitHubZJY
简 书Android小Y
在GitHub上建了一个炫酷自定义View的集合ZJYWidget,主要是平时实现的一些实用的自定义View源码及demo,会长期维护,如有不足之处或建议还望指正,相互学习,相互进步~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容