https://github.com/donkingliang/labelsview
Android的标签列表控件。可以设置标签的选中效果。 可以设置标签的选中类型：不可选中、单选、限数量多选和不限数量多选等， 并支持设置必选项、单行显示、最大显示行数等功能。
https://github.com/donkingliang/labelsview
android android-library android-ui custom-view labels tabs
Last synced: 3 months ago
JSON representation
Android的标签列表控件。可以设置标签的选中效果。 可以设置标签的选中类型：不可选中、单选、限数量多选和不限数量多选等， 并支持设置必选项、单行显示、最大显示行数等功能。
- Host: GitHub
- URL: https://github.com/donkingliang/labelsview
- Owner: donkingliang
- License: apache-2.0
- Created: 2017-03-07T11:11:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-09T12:10:39.000Z (over 2 years ago)
- Last Synced: 2025-05-30T00:42:09.522Z (4 months ago)
- Topics: android, android-library, android-ui, custom-view, labels, tabs
- Language: Java
- Homepage:
- Size: 347 KB
- Stars: 1,029
- Watchers: 15
- Forks: 156
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LabelsView
======
标签列表控件的使用介绍。
**1、引入依赖**
在Project的build.gradle在添加以下代码
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
在Module的build.gradle在添加以下代码
```
dependencies {
implementation 'com.github.donkingliang:LabelsView:1.6.5'
}
```
**2、编写布局：**
```xml
//设置为指示器模式，不能手动改变标签的选中状态
app:labelTextWidth="wrap_content" // 标签项宽
app:labelTextHeight="wrap_content" // 标签项高
app:labelGravity="center" // 标签项的文本显示方向
app:labelTextPadding="5dp" // 标签的Padding
app:singleLine="true" // 单行显示，默认false
app:isTextBold="true" // 是否粗字体，默认false
```
这里有两个地方需要说明一下：
1）标签的正常样式和选中样式是通过drawable来实现的。比如下面两个drawable。
```xml
```
```xml
```
TextView的textColor属性除了可以设置一个颜色值以外，也可以通过资源来设置的，这一点很多同学都不知道。
2）标签的选择类型有四种：
**NONE** ：标签不可选中，也不响应选中事件监听，这是默认值。
**SINGLE**：单选(可反选)。这种模式下，可以一个也不选。
**SINGLE_IRREVOCABLY**：单选(不可反选)。这种模式下，有且只有一个是选中的。默认是第一个。
**MULTI**：多选，可以通过设置maxSelect限定选择的最大数量，0为不限数量。maxSelect只有在多选的时候才有效。多选模式下可以设置一些标签为必选项。必选项的标签默认选中，且不能取消。
**3、设置标签：**
```java
labelsView = (LabelsView) findViewById(labels);
ArrayList label = new ArrayList<>();
label.add("Android");
label.add("IOS");
label.add("前端");
label.add("后台");
label.add("微信开发");
label.add("游戏开发");
labelsView.setLabels(label); //直接设置一个字符串数组就可以了。
//LabelsView可以设置任何类型的数据，而不仅仅是String。
ArrayList testList = new ArrayList<>();
testList.add(new TestBean("Android",1));
testList.add(new TestBean("IOS",2));
testList.add(new TestBean("前端",3));
testList.add(new TestBean("后台",4));
testList.add(new TestBean("微信开发",5));
testList.add(new TestBean("游戏开发",6));
labelsView.setLabels(testList, new LabelsView.LabelTextProvider() {
@Override
public CharSequence getLabelText(TextView label, int position, TestBean data) {
// label就是标签项，在这里可以对标签项单独设置一些属性，比如文本样式等。
//根据data和position返回label需要显示的数据。
return data.getName();
}
});
```
**4、设置事件监听：**(如果需要的话)
```java
//标签的点击监听
labelsView.setOnLabelClickListener(new LabelsView.OnLabelClickListener() {
@Override
public void onLabelClick(TextView label, Object data, int position) {
//label是被点击的标签，data是标签所对应的数据，position是标签的位置。
}
});
// 标签的长按监听
labelsView.setOnLabelLongClickListener(new LabelsView.OnLabelLongClickListener() {
@Override
public boolean onLabelLongClick(TextView label, Object data, int position) {
return false;
}
});
//标签的选中监听
labelsView.setOnLabelSelectChangeListener(new LabelsView.OnLabelSelectChangeListener() {
@Override
public void onLabelSelectChange(TextView label, Object data, boolean isSelect, int position) {
//label是被选中的标签，data是标签所对应的数据，isSelect是是否选中，position是标签的位置。
}
});
```
**5、设置标签选中事件拦截：**(如果需要的话)
当希望某个标签在特定条件下不被选中/取消选中时，可以使用事件拦截。只有用户点击改变标签选中状态时才会回调拦截，用其他方法改变时不会回调这个方法，不会被拦截。点击选中/取消选中时，拦截事件，返回true时，表示事件被拦截，不会改变标签的选中状态。
```java
//设置标签选中状态的点击改变拦截器
labelsView.setOnSelectChangeIntercept(new LabelsView.OnSelectChangeIntercept() {
@Override
public boolean onIntercept(TextView label, Object data, boolean oldSelect, boolean newSelect, int position) {
if (position == 0){
//拦截第一个标签的状态改变事件，不能选中和反选
return true;
} else {
return false;
}
}
});
```
**6、常用方法**
```java
//设置选中标签。
//positions是个可变类型，表示被选中的标签的位置。
//比喻labelsView.setSelects(1,2,5);选中第1,3,5个标签。如果是单选的话，只有第一个参数有效。
public void setSelects(int... positions);
public void setSelects(List positions)；
//获取选中的标签(返回的是所有选中的标签的位置)。返回的是一个Integer的数组，表示被选中的标签的下标。如果没有选中，数组的size等于0。
public ArrayList getSelectLabels();
//获取选中的label(返回的是所有选中的标签的数据)。如果没有选中，数组的size等于0。T表示标签的数据类型。
public List getSelectLabelDatas();
//取消所有选中的标签。
public void clearAllSelect();
//设置标签的选择类型，有NONE、SINGLE、SINGLE_IRREVOCABLY和MULTI四种类型。
public void setSelectType(SelectType selectType);
//设置最大的选择数量，只有selectType等于MULTI时有效。
public void setMaxSelect(int maxSelect);
//设置最少的选择数量，只有selectType等于MULTI时有效。
//注意：minSelect只限制用户手动点击取消选中时的效果。调用setSelects()、clearAllSelect()等方法改变标签的选中状态时，不受minSelect影响。
public void setMinSelect(int minSelect);
//设置为指示器模式，只能看，不能手动操作。这种模式下，用户不能通过手动点击改变标签的选中状态。
//但是仍然可以通过调用setSelects()、clearAllSelect()等方法改变标签的选中状态。
public void setIndicator(boolean indicator)
//设置必选项，只有在多项模式下，这个方法才有效
public void setCompulsorys(int... positions)
public void setCompulsorys(List positions)
//清空必选项，只有在多项模式下，这个方法才有效
public void clearCompulsorys()
//设置标签背景
public void setLabelBackgroundResource(int resId);
//设置标签的文字颜色
public void setLabelTextColor(int color);
public void setLabelTextColor(ColorStateList color);
//设置标签的文字大小（单位是px）
public void setLabelTextSize(float size);
//设置标签内边距
public void setLabelTextPadding(int left, int top, int right, int bottom);
//设置行间隔
public void setLineMargin(int margin);
//设置标签的间隔
public void setWordMargin(int margin);
// 设置最大显示行数，小于等于0则不限行数。
public void setMaxLines(int maxLines);
// 设置最大显示列数，小于等于0则不限行数。
public void setMaxColumns(int maxColumns)
// 设置标签文本显示方向
public void setLabelGravity(int gravity)；
// 设置是否单行显示
public void setMaxLines(int maxLines)；
// 设置标签字体是否为粗体
public void setTextBold(boolean isBold);
// 获取标签的行数
public int getLines();
```
所有的set方法都有对应的get方法，这里就不说了。
### 效果图：
想要了解该控件的具体实现的同学，欢迎访问[我的博客](http://blog.csdn.net/u010177022)
[Android自定义标签列表控件LabelsView解析](http://blog.csdn.net/u010177022/article/details/60324117)