CalendarListView日历列表

原文地址:http://www.jianshu.com/p/ca2af05b3a53 ,转载已取得作者本人同意。

概述:


听过PullToRefreshListView,听过PinnedSectionListView,那你应该没听过CalendarListView,什么是CalendarListView呢,ListView和Calendar扯上什么关系呢,我们先来看下Demo(动画效果会稍微有点卡顿,真实效果会比较流畅,大家可以到我GitHub下载apk自己试用一下,效果还不错!)。

CalendarListView 是一个ListView 和 CalendarView 结合并互相联动的控件,日历可以伸缩扩展,列表可以上拉下沉, 日历的选择会让ListView 滑动到指定的位置,ListView的滑动同时也会带动日历滑到指定位置并能同时自动切换月份。如果我们的应用涉及到聊天记录、笔记、订单记录、天气、日报等和时间关系比较紧的业务场景,这样的控件要比简单的ListView 来得更清晰一些,也更炫一些。如果你喜欢,可以先收藏很多业务场景都可以使用。

GitHub:https://github.com/Kelin-Hong/CalendarListView

功能简介:


可以参照上面的动画,我安装上面演示的顺序说明:
1、CalendarListView 的上部分是常规的日历模块,在日历不收缩的情况下上下滑动可以切换月份
2、在日历不收缩的情况,选择日历某一天,ListView的滑到指定日期的那一条。
3、在日历不收缩的情况,选择日历某一天,选完之后,把ListView往上拉,这时候会根据日历选中日期(红色框)的高度,计算出日历的滑动速率,从而使整体滑到顶部的时候,日历日期选中的那一行是可见的。
4、在日历收缩的情况下,按住日历往下拉,这时候和上面一样经过计算,使控件能够平滑的展开。
5、在日历执行展开或者收缩过程中,用手在拖动中,如果拖动的距离超过一半放手了,会有动画执行剩下的下滑或者上拉操作,如果拖动没有超过一半,会自动回到原来的位置。
6、在日历收缩的情况下,滑动ListView,这时候日期当前ListView的section的日期变化了,那么日历会自动选中当前pin住的那个header的日期,ListView上下滑动都会牵动日历日期的变更(日历会上下滑动同时选中header的日期)
7、ListView 往下滑,到底的时候会自动触发LoadMore操作,当从1月份滑到二月份的时候,日历会自动切换2月份同时选中指定的日期。
8、ListView 往上滑,到最顶部时候会自动触发Refresh操作,当从1月份滑到去年12月份的时候,日历会自动切换到去年12月份同时选中指定的日期。
9、ListView 快速滑动试,日历跟随的日期仍能不会错
10、在日历收缩的情况,选择日历某一天,ListView的依然滑到指定日期的那一条。

如何使用

compile 'com.kelin.mvvmlight:library:1.0.0'

CalendarListView 接口的设计使得用户完全可以定制想要的UI和各种响应的事件的支持

1、自定义CalendarView的样式(在小格子里添加价格,tag,图标等)

//继承BaseCalendarItemModel添加你想要的额外的字段,比较价格,是否收藏,数量等
public class CustomCalendarItemModel  extends BaseCalendarItemModel{     
   //这一天有多少条数据
   private int count;
   //是否收藏(如Demo 日历上有没有爱心)
   private boolean isFav;
   //get set
   ...
   ...
}
// 继承BaseCalendarItemAdapter<T> (T 为你自定义的Model extendsBaseCalendarItemModel),
// 重写 getView方法自定义CalendarView Item 的样式和数据
public class CalendarItemAdapter extends BaseCalendarItemAdapter<CustomCalendarItemModel>{
    //date 是时间,样式“yyyy-MM-dd”
    @Override
    public View getView(String date, CustomCalendarItemModel model, View convertView, ViewGroup parent) {
        //也可以从dayModelList 根据date获取指定时间的model(dayModelList是基类的变量)  CustomCalendarItemModel model = dayModelList.get(date);
        ....
        ViewGroup view = (ViewGroup) LayoutInflater.from(mContext).inflate(R.layout.custom_calendar_item, null);
        TextView dayNum = (TextView)  view.findViewById(R.id.day_num);
        dayNum.setText(model.getDayNumber());
        ....
        //从model里面获取数据自定义想要的UI
        ....
        ....
   }
}

注:如果不需要再日历页面添加自定义的元素,也可以直接使用BaseCalendarItemAdapter ,这样日历的视图只会有日期,依然是可用的。

2、自定义ListView的样式,和传统的BaseAdapter 差不多,重写getSectionHeaderView自定义SectionHeader的样式,重写getItemView自定义每个Item的样式

public class ListItemAdapter extends BaseCalendarListAdapter<ListModel> {
    //date 是时间,样式“yyyy-MM-dd”
    @Override
    public View getSectionHeaderView(String date, View convertView, ViewGroup parent) {
       List<ListModel> modelList = dateDataMap.get(date);
       .....
       .....//根据数据模型自定义ListView SectionHeader的样式
       .....
    }
   //date 是时间,样式“yyyy-MM-dd”
    @Override
    public View getItemView(ListModel model,String date, int pos, View convertView, ViewGroup parent) {
      //通过基类BaseCalendarListAdapter的成员变量dateDataMap可以获取当前date的包含的数据列表
      //List<ListModel> modelList = dateDataMap.get(date);
      //model = modelList.get(pos) 也可以获取model
      .....
      .....//根据数据模型model自定义ListView Item的样式
      .....
   }
}

3、初始化CalendarListView 并且设置CalendarItemAdapter和ListItemAdapter

<com.kelin.calendarlistview.library.calendar.CalendarListView   
   android:id="@+id/calendar_listview"    
   android:layout_width="match_parent"    
   android:layout_height="match_parent">
</com.kelin.calendarlistview.library.calendar.CalendarListView>
//在onCreate中分别创建两个Adapter的实例,并且设置到CalendarListView里面
@Override
protected void onCreate(Bundle savedInstanceState) {
 //获取calendarListView
 calendarListView = (CalendarListView) findViewById(R.id.calendar_listview);
 //声明CalendarView和ListView的Adapter,分别为上面1、2步自定义的样式的Adapter
 listItemAdapter = new ListItemAdapter(this);
 calendarItemAdapter = new CalendarItemAdapter(this);
 //给calendarListView设置Adapter
 calendarListView.setCalendarListViewAdapter(calendarItemAdapter, listItemAdapter);
}

4、去服务器获取日历和列表的数据(建议接口按月份来)获取每个月份的数据,在获取完数据更新日历和列表

  • 对于CalendarView的数据更新
private void onCalendarDataLoadFinish(List<Data> datas){
    ....
    ....
    //calendarItemAdapter.getDayModelList()可以获取当前月份的所有数据列表
    //它是一个TreeMap<String, T>,key是“yyyy-MM-dd”,value 是当天的数据模型
    TreeMap<String, CustomCalendarItemModel> dateMap=calendarItemAdapter.getDayModelList();
    ....
    //获取指定日期的Model,date的格式是yyyy-MM-dd
    CustomCalendarItemModel customCalendarItemModel = dateMap.get(date);
    //更新数据模型的数据
    customCalendarItemModel.setXXX(data.getXXX());
   ....
   ....
   //通知日历更新UI
   calendarItemAdapter.notifyDataSetChanged();
}
  • 对于ListView的数据更新
//建议声明一个TreeMap<String, List<ListModel>>的成员变量用来保持每一天下面的数据列表
//key:date "yyyy-mm-dd" format.
private TreeMap<String, List<ListModel>> listTreeMap = new TreeMap<>();
private void onListDataLoadFinish(List<Data> datas){
   ....
   ....
  for(Data item:datas) {
     //获取数据的日期
     String day=item.getDate();
    //给listTreeMap 添加数据
     if (listTreeMap.get(day) != null) {    
         List<NewsService.News.StoriesBean> list = listTreeMap.get(day);    
         list.add(i);
      } else {    
         List<NewsService.News.StoriesBean> list = new ArrayList<NewsService.News.StoriesBean>();    
         list.add(i);   
         listTreeMap.put(day, list);
     }
  }
 ....
 ....
 //更新数据,通知更新UI
 listItemAdapter.setDateDataMap(listTreeMap);
 listItemAdapter.notifyDataSetChanged();
}

5、CalendarView的事件支持

  • 日期选择

    calendarListView.setOnCalendarViewItemClickListener(new CalendarListView.OnCalendarViewItemClickListener() {   
       //具体参数看注释,写得比较详细
       @Override    
       public void onDateSelected(View View, String selectedDate, int listSection) {   
       //do something....
       }
    });
    
  • 月份改变

    calendarListView.setOnMonthChangedListener(new CalendarListView.OnMonthChangedListener() {    
         @Override    
         public void onMonthChanged(String yearMonth) {
         //yearMonth:"yyyy-MM-dd"
         }
    });
    
  • 下拉刷新,上拉加载更多

    calendarListView.setOnListPullListener(new CalendarListView.onListPullListener() {    
      @Override    
      public void onRefresh() {
      }    
      @Override    
      public void onLoadMore() {
      }
    });
    

6、CalendarView的选中框样式颜色、上方的week bar 的样式都是支持自定义的。

备注


1、控件部分交互有些小复杂,可能存在一些Bug,欢迎issue和PR!
2、源码涉及较多事件分发的处理,如果你有看过我的另一篇文章《图解Android事件分发机制》,那么源码应该是比较好的实践,可以去读一下。
3、任何控件上的问题或者使用上的问题,可以给我留言或私信。
4、最后,喜欢可以收藏哦!O(∩_∩)O~~