Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@yannecer
yannecer authored Apr 3, 2020
1 parent 72c5400 commit 8bf9e01
Showing 1 changed file with 42 additions and 276 deletions.
318 changes: 42 additions & 276 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,30 @@

## 使用方法

#### Gradle

#### 项目build文件

```
implementation 'com.necer.ncalendar:ncalendar:4.3.8'
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
...
}
implementation 'com.necer.ncalendar:ncalendar:4.4.1' 项目升级到androidx
```

#### Gradle
```
implementation 'com.necer.ncalendar:ncalendar:5.0.0' 项目升级到androidx
```

#### 月周切换
#### 简单使用

```
miui9 和 钉钉日历
Expand All @@ -66,7 +80,7 @@ implementation 'com.necer.ncalendar:ncalendar:4.4.1' 项目升级到androidx
android:layout_width="match_parent"
android:layout_height="match_parent"
>
<android.support.v7.widget.RecyclerView
<<androidx.recyclerview.widget.RecyclerView
android:id="@+id/recyclerView"
android:layout_width="match_parent"
android:layout_height="match_parent" />
Expand Down Expand Up @@ -96,303 +110,52 @@ implementation 'com.necer.ncalendar:ncalendar:4.4.1' 项目升级到androidx
```

### [详细用法](https://github.com/yannecer/NCalendar/wiki/%E8%AF%A6%E7%BB%86%E7%94%A8%E6%B3%95)

#### 注意


- NCalendar（Miui9Calendar、Miui10Calendar、EmuiCalendar）内部```TargetView```可以是除```ScrollView```、```ListView```、```GridView```之外的任意```View```，处理滑动的内容请使用```RecyclerView```和```NestedScrollView```等实现了```NestedScrollingChild```的```View```
- 如果布局文件中，内部实际滑动的```TargetView```有多个父```View```，恰好也有实现了```NestedScrollingChild```的父```View```，则需要给实际滑动的子```View```设置```tag（“@string/factual_scroll_view”）```，不然可能会出现滑动异常，此种情况在下拉刷新中比较常见



### 交流群

技术交流QQ群：127278900 (请先仔细看文档，然后再进群发问，上方加粗字体有下载demo链接)
### 主要Api

#### 月日历、周日历、折叠月周日历共同拥有的api


## 自定义属性
```
/**
* 设置选中模式
*
* @param selectedMode SINGLE_SELECTED--日历默认选中模式 每个页面都有选中，左右页面为加减一月或者一周后的日期
* SINGLE_UNSELECTED--单个选中，不点击选中日期不会改变，翻页不改变选中日期
* MULTIPLE--多选，多个选中，累计选中
*/
void setSelectedMode(SelectedModel selectedMode);
/**
* 多选个数和模式
*
* @param multipleNum 多选限制的个数
* @param multipleNumModel FULL_CLEAR--超过清除所有
* FULL_REMOVE_FIRST--超过清除第一个
*/
void setMultipleNum(int multipleNum, MultipleNumModel multipleNumModel);
//默认选中时，是否翻页选中第一个，只在selectedMode==SINGLE_SELECTED有效
void setDefaultSelectFitst(boolean isDefaultSelectFitst);
//跳转日期
void jumpDate(String formatDate);
void jumpDate(int year, int month, int day);
//跳转月份
void jumpMonth(int year, int month);
//上一页 上一周 上一月
void toLastPager();
//下一页 下一周 下一月
void toNextPager();
//回到今天
void toToday();
//设置自定义绘制类
void setCalendarPainter(CalendarPainter calendarPainter);
//刷新日历
void notifyCalendar();
//设置初始化日期
void setInitializeDate(String formatInitializeDate);
//设置初始化日期和可用区间
void setDateInterval(String startFormatDate, String endFormatDate, String formatInitializeDate);
//设置可用区间
void setDateInterval(String startFormatDate, String endFormatDate);
//单选日期变化监听
void setOnCalendarChangedListener(OnCalendarChangedListener onCalendarChangedListener);
//多选日期变化监听
void setOnCalendarMultipleChangedListener(OnCalendarMultipleChangedListener onCalendarMultipleChangedListener);
//设置点击了不可用日期监听
void setOnClickDisableDateListener(OnClickDisableDateListener onClickDisableDateListener);
//获取绘制类
CalendarPainter getCalendarPainter();
//获取全部选中的日期集合
List<LocalDate> getAllSelectDateList();
//获取当前页面选中的日期集合
List<LocalDate> getCurrectSelectDateList();
//获取当前页面的数据 如果是月周折叠日历 周状态下获取的是一周的数据，月状态下获取的一月的数据
List<LocalDate> getCurrectDateList();
5.x版本更新了大量的自定义属性
```
### [自定义属性](https://github.com/yannecer/NCalendar/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7)

#### 折叠月周日历miui9，miui10，emui 拥有的api
## 日历Api
```
//回到周状态 只能从月->周
void toWeek();
//回到月状态 可以从周回到月或者从拉伸回到周
void toMonth();
//回到拉伸状态 只能从月->拉伸
void toStretch();
//设置周滑动到周位置固定
void setWeekHoldEnable(boolean isWeekHoldEnable);
//设置月状态下 下拉拉伸
void setMonthStretchEnable(boolean isMonthStretchEnable);
//日历月周状态变化回调
void setOnCalendarStateChangedListener(OnCalendarStateChangedListener onCalendarStateChangedListener);
//日历 月 周 拉伸 状态滑动监听
void setOnCalendarScrollingListener(OnCalendarScrollingListener onCalendarScrollingListener);
//设置日历状态
void setCalendarState(CalendarState calendarState);
//获取当前日历的状态 CalendarState.MONTH==月视图 CalendarState.WEEK==周视图 CalendarState.MONTH_STRETCH==日历拉伸状态
CalendarState getCalendarState();
```


#### 添加指示圆点
```
此功能为默认 CalendarPainter 类 InnerPainter 的功能，如果设置了自定义 CalendarPainter ，没有此方法，需要自己实现
List<String> pointList = Arrays.asList("2018-10-01", "2018-11-19", "2018-11-20", "2018-05-23", "2019-01-01");
InnerPainter innerPainter = (InnerPainter) miui10Calendar.getCalendarPainter();
innerPainter.setPointList(pointList);
```
#### 设置法定节假日
```
此功能为默认 CalendarPainter 类 InnerPainter 的功能，如果设置了自定义 CalendarPainter ，没有此方法，需要自己实现
List<String> holidayList = Arrays.asList("2018-10-01", "2018-11-19", "2018-11-20");
List<String> holidayList = Arrays.asList("2019-10-01", "2019-11-19", "2019-11-20");
InnerPainter innerPainter = (InnerPainter) miui10Calendar.getCalendarPainter();
innerPainter.setLegalHolidayList(holidayList,workdayList);
日历提供了各种可能用到的方法、回调，5.x版本增加了日历日期变化的行为参数，区分了各种引起日历变化的不同的操作
```
#### 替换农历文字及颜色
```
此功能为默认 CalendarPainter 类 InnerPainter 的功能，如果设置了自定义 CalendarPainter ，没有此方法，需要自己实现
InnerPainter innerPainter = (InnerPainter) miui10Calendar.getCalendarPainter();
Map<String, String> strMap = new HashMap<>();
strMap.put("2019-01-25", "测试");
strMap.put("2019-01-23", "测试1");
strMap.put("2019-01-24", "测试2");
innerPainter.setReplaceLunarStrMap(strMap);
### [日历Api](https://github.com/yannecer/NCalendar/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7)
### [日历Api相关类说明](https://github.com/yannecer/NCalendar/wiki/Api%E7%9B%B8%E5%85%B3%E7%B1%BB%E8%AF%B4%E6%98%8E)

Map<String, Integer> colorMap = new HashMap<>();
colorMap.put("2019-01-25", Color.RED);
colorMap.put("2019-01-23", Color.GREEN);
colorMap.put("2019-01-24", Color.parseColor("#000000"));
innerPainter.setReplaceLunarColorMap(colorMap);
## 自定义日历UI
```
#### 添加日历拉伸之后的文字显示
如果自定义属性不能满足日历ui要求，可以使用自定义页面实现个性化需求，项目提供了两种自定义UI的方式，
1、实现CalendarPainter接口，通过Canvas绘制
2、继承CalendarAdapter抽象类，和ListView的BaseAdapter用法相似
```
日历支持拉伸之后显示一行文字
此功能为默认 CalendarPainter 类 InnerPainter 的功能，如果设置了自定义 CalendarPainter ，没有此方法，需要自己实现
InnerPainter innerPainter = (InnerPainter) miui10Calendar.getCalendarPainter();
innerPainter.setPointList(pointList);
Map<String, String> strMap = new HashMap<>();
strMap.put("2019-07-01", "测试");
strMap.put("2019-07-19", "测试1");
strMap.put("2019-07-25", "测试2");
innerPainter.setStretchStrMap(strMap);
```


### [自定义日历UI](https://github.com/yannecer/NCalendar/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E6%97%A5%E5%8E%86UI)

### 自定义

## 项目提供两种方式自定义，Canvas绘制和适配器传入View，两种方式都能实现，方法类似，具体参见下面的链接

- [ 绘制接口 CalendarPainter](https://github.com/yannecer/NCalendar/blob/master/CalendarPainter.md)
- [适配器抽象类 CalendarAdapter](https://github.com/yannecer/NCalendar/blob/master/CalendarAdapter.md)
```
写好之后调用下面的方法设置、两中方式取其一，如果同时设置，后面设置的生效
CalendarPainter ---> setCalendarPainter(CalendarPainter calendarPainter);
CalendarAdapter ---> setCalendarAdapter(CalendarAdapter calendarAdapter);
```



### CalendarDate
```
CalendarDate 日历中存放日期各种参数的类，包含公历、农历、节气、节日、属相、天干地支等
public LocalDate localDate;//公历日期
public Lunar lunar;//农历
public String solarHoliday;//公历节日
public String lunarHoliday;//农历节日
public String solarTerm;//节气
其中Lunar为农历信息的对象

### 交流群

public boolean isLeap;//是否闰年
public int lunarDay;//农历天
public int lunarMonth;//农历月
public int lunarYear;//农历年
public int leapMonth;//闰月
技术交流QQ群：127278900 (请先仔细看文档，然后再进群发问，上方加粗字体有下载demo链接)

public String lunarOnDrawStr;//农历位置需要绘制的文字
public String lunarDayStr;//农历天 描述 廿二等
public String lunarMonthStr;//农历月 描述
public String lunarYearStr;//农历年 描述
public String animals;//生肖
public String chineseEra;//天干地支



CalendarDate对象通过 CalendarUtil 获取

CalendarDate calendarDate = CalendarUtil.getCalendarDate(LocalDate localDate);

```


## 感谢：

项目中日期计算使用 [joda-time](https://github.com/JodaOrg/joda-time)<br/>
感谢同事 **魏昌琳** 提出的优化建议<br/>
感觉农历和节气数据工具类的作者<br/>

## 感谢：

项目中日期计算使用 [joda-time](https://github.com/JodaOrg/joda-time)<br/>农历和节气数据是工具类，多谢



## 支持的属性：

|Attributes|forma|describe
|---|---|---|
|solarTextColor| color|公历日期的颜色
|lunarTextColor| color|农历日期的颜色
|solarHolidayTextColor| color|公历节假日的颜色
|lunarHolidayTextColor| color|农历节假日的颜色
|solarTermTextColor| color|节气颜色
|selectCircleColor| color|选中圈的颜色
|holidayColor|color| 法定节休息日颜色
|workdayColor|color| 法定节调休工作日颜色
|bgCalendarColor|color| 日历的背景
|bgChildColor|color| 日历包含子view的背景
|todaySelectContrastColor|color| 今天被选中是其他元素的对比色，比如 农历，圆点等
|pointColor| color |小圆点的颜色
|pointSize| dimension |小圆点的大小
|pointDistance| dimension |小圆点到公历的距离
|alphaColor| integer |不是本月的日期颜色的透明度0-255
|disabledAlphaColor| integer |日期区间之外的地日颜色的透明度0-255
|disabledString| string |点击日期区间之外的日期提示语
|todaySolarTextColor| color|今天不选中的颜色
|todaySolarSelectTextColor| color|今天选中的颜色
|selectCircleRadius| dimension | 选中圈的半径
|solarTextSize| dimension|公历日期字体大小
|lunarTextSize| dimension|农历日期字体大小
|lunarDistance| dimension|农历日期到公历字体的距离
|holidayTextSize| dimension|法定节假日字体的大小
|holidayDistance| dimension |法定节假日到公历的距离
|hollowCircleStroke| dimension |空心圆的宽度
|hollowCircleColor| color |空心圆的边框颜色
|calendarHeight| dimension |日历的高度
|duration|integer| 日历自动滑动的时间
|isShowLunar| boolean |是否显示农历
|isShowHoliday|boolean| 是否显示法定节假日
|isDefaultSelect|boolean| 是否默认选中（只对单个月日历或者周日历有效）
|defaultCalendar|enum| 默认视图 week 或者 month
|pointLocation|enum| 指示点的文职 up（在公历的上方） 或者 down（在公历的下方） 默认是up
|firstDayOfWeek|enum| 一周开始的星期天还是星期一 sunday 或者 monday 默认是sunday
|holidayLocation|enum| 法定节假日相对公历日期的位置 top_right（右上方）、top_left（左上方）、bottom_right（右下方）、bottom_left（左下方）
|stretchTextSize|dimension| 拉伸之后显示字体的大小
|stretchTextColor|color| 拉伸之后显示字体的颜色
|stretchTextDistance|dimension| 拉伸显示的字体距离矩形中心的距离
|stretchCalendarHeight|dimension| 拉伸之后的高度
|isAllMonthSixLine|boolean| 是否每个月份都占用6行，默认为flase
|selectSolarTextColorColor|color| 选中公历颜色
|selectLunarTextColor|color| 选中农历颜色
|isShowNumberBackground|boolean| 是否显示数字背景
|numberBackgroundTextSize|dimension| 数字背景字体大小
|numberBackgroundTextColor|color| 数字背景字体颜色
|numberBackgroundAlphaColor|integer| 数字背景字体透明度0-255
|isLastNextMonthClickEnable|boolean| 月日历上下月是否可点击


## 更新日志
* 5.0.0<br/> 重写InnerPainter，增加大量属性、优化跳转逻辑等
* 4.4.1<br/> 新增跳转月份的方法
* 4.4.0<br/> 新增适配器模式自定义页面
* 4.3.8<br/> 新增月日历上下月是否可点击的属性 isLastNextMonthClickEnable
Expand All @@ -411,6 +174,9 @@ CalendarDate calendarDate = CalendarUtil.getCalendarDate(LocalDate localDate);






License
-------

Expand Down

0 comments on commit 8bf9e01

Please sign in to comment.