freeCalendar

概述

日历控件并不是会很常用到,但是在项目中用到的话很多时候是更倾向于UI自定义程度会比较高或者带有自己应用的特点.

github上已经存在很多很不错的日历控件.但是绝大多数的特点是该日历特有的并且UI的修改与控制也会很麻烦.

基于这个原因,所以就写了这个日历控件库希望本身功能比较完整的情况下同时也能提供比较方便容易的自定义UI的功能

版本更新内容

0.1.0,首次发布
0.2.0,新增周末标题文本可自定义的功能
0.3.0,文档调整,新增注释说明
0.4.0,打包带源码及注释的库
0.5.0

1.修复假期/加班图标可能无法正常显示的问题
2.修复日期工具可能导致出错的问题
3.修复xml属性设置显示不正常的问题
4.更新接口参数

功能特点

丰富的xml属性设置可以满足大部分的需要并且能直接在xml中预览出效果
大量的自定义绘制方法可直接控制日历的UI显示
自定义UI绘制采用接口回调的方式不需要继承任何View直接重写相关的方法即可

TODO

[] 优化绘制的方式和逻辑(长期工作)
[] 调整"假期/加班"图标绘制方式
[] 分离并独立农历/公历节日计算
[] 提供一些日期相关的工具方法或接口

使用方式

step1:在项目级别的 `build.gradle` 文件下声明仓库

allprojects {
	repositories {
		...
		maven { url 'https://www.jitpack.io' }
	}
}

step2:引用需要的版本

最新版本: [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3ZeJe1WG-1617088467361)(https://jitpack.io/v/CrazyTaro/freeCalendar.svg)]

dependencies {
        //latest_release记得替换成最新版本号
        compile 'com.github.CrazyTaro:freeCalendar:latest_release'
}

step3:在xml中使用

<com.taro.calendar.lib.CalendarView
        android:id="@+id/cv_calendar"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>

step4:自定义UI控制

颜色样式配置

大部分的颜色可以在xml中直接设置,也可以在代码中进行设置;所有的颜色配置都在

ColorSetting

的类中.

view.getColorSetting()
        .setBackgroundColor(ColorSetting.DEFAULT_COLOR_BLUE)
        .setDateBackgroundColor(Color.parseColor("#ff9900"));

也可以

new ColorSetting()

并配置后再设置给

calendarView

假期/加班图标设置

由于默认UI是不处理并显示任何图标的,假期及加班图标的设置需要重写部分绘制UI.

@Override
public void updateDayCellAfterNewSetting(@NonNull DayCell cell, @NonNull Lunar lunarDate) {
    //农历日期类计算当前日期是需要休假的
    //现在正在调整节日的计算及处理,后面可能就不再是进行类似的判断
    //之后根据调整后的节日计算再判断当前日期是否需要休假,这部分将会考虑被独立出来处理
    if (lunarDate.isHoliday()) {
        //必须对日期对象中相关的特殊日期标识进行设置才有效
        //需要显示底部图标时也需要设置相关的标识
        //MASK_DATE_HOLIDAY,假期标识
        //MASK_DATE_WORK,加班标识
        //MASK_DATE_BOTTOM_DRAWABLE,显示底部图标标识
        cell.setSpecialDate(DayCell.MASK_DATE_HOLIDAY, true);
    }
}

设置了显示假期图标或者加班图标后,还可以设置假期或加班图标的标识;该图标的类型是

TipDrawable

,通过调用对应的方法即可设置相关样式.包括背景色/文本等;获取默认的假期/加班图标可调用

calendarView

的方法

getWorkTipDrawable

getFestivalDrawable

;

view.getFestivalDrawable()
        //设置图标文本
        .setText("啊")
        //设置文本颜色
        .setTextColor(Color.WHITE)
        //设置图标背景色
        .setBackgroundColor(Color.BLACK);

完全自定义UI

继承

BaseCalendarDrawHelper

,对需要修改或者控制的UI进行重写即可.

其中

BaseCalendarDrawHelper

是一个默认实现了所有绘制接口的类,默认的控件

CalendarView

的绘制操作即使用此类的实例.该类是实现了

IDrawCallback

的绘制接口.

直接实现

IDrawCallback

也是一样的,但一次需要实现的接口有点多,推荐还是继承

BaseCalendarDrawHelper

进行并重写相关方法即可;

public class BaseCalendarDrawHelper implements IDrawCallback {
    //实现对应的方法...
}

在回调的方法中,实际上需要使用的样式已经设置在

paint

中,如果不需要改动样式直接就可以绘制自己需要的UI

public class BaseCalendarDrawHelper implements IDrawCallback {
    @Override
    public void drawWeekTitleBackground(Canvas canvas, @NonNull RectF drawArea, Paint paint) {
        canvas.drawRect(drawArea, paint);
    }

    @Override
    public void drawSelectedDayBackground(Canvas canvas, @NonNull RectF recommendRectf, @Nullable Drawable drawable, boolean isToday, Paint paint) {
        if (drawable != null) {
            //存在drawable使用背景drawable绘制
            drawable.setBounds((int) recommendRectf.left, (int) recommendRectf.top,
                    (int) recommendRectf.right, (int) recommendRectf.bottom);
            drawable.draw(canvas);
        } else {
            //否则绘制圆形背景
            canvas.drawArc(recommendRectf, 0, 360, false, paint);
        }
    }
    
    @Override
    public void drawDateText(Canvas canvas, boolean isToday, boolean isSelected, int color, float textSize, float x, float y, @NonNull String date, Paint paint) {
        canvas.drawText(date, x, y, paint);
    }
    
    //其它绘制方法...
}

以上给出了几个默认绘制方法的实现,可见看到实际上只需要调用

canvas

默认对应的方法就可以进行绘制了(图形或者是文字等);

当需要自己调整绘制的UI时,则可以使用方法提供的参数自行调整.如上默认提供的推荐区域为正方形,但是可以将UI绘制为圆形.具体视需求而定.

重要提示:

BaseCalendarDrawHelper

中基本每个方法都实现了相关的绘制逻辑,不需要默认的UI绘制方式则重写时注意不要调用

super

方法,以上示例为

BaseCalendarDrawHelper

的实现,具体每个方法的默认实现请查看该类的源码.

更多接口方法及说明请查看以下内容

效果图

默认效果(带农历日期/节日/日期不居中/显示次要月份)

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ZNumXUEB-1617088467364)(https://raw.githubusercontent.com/CrazyTaro/freeCalendar/master/screenshot/normal.png)]

文本居中(仔细看主要的元素都集中在下半部分,可能会感觉有点挤)

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WJfvvLv0-1617088467366)(https://raw.githubusercontent.com/CrazyTaro/freeCalendar/master/screenshot/date_in_center.png)]

无农历日期