IndicatorView

KO | EN

gitlite — search

#python #javascript #golang #react #go #deep-learning #reactjs #csharp #pentesting #bulma #jekyll #lua

★ 55 Open GitHub ↗

IndicatorView on Android platform to indicator the current index of pages

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# IndicatorView
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-IndicatorView-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/3821)<br>

* [English](#english)

Android平台的IndicatorView用来指示当前page所在index的状态

## 概述
Android IndicatorView的灵感来源于SlidingTabView，虽然有句“不重复”造轮子在先，本着练手的目的，还是写了一个功能较为简单的类似view。
其比SlidingTabView在功能上欠缺的一点是：暂时没有添加“当内容显示不开时自动向左右滑动”的功能。

## 应用场景
可以胜任一屏显示所有tab标题的情况。

## 效果图

![Example Image][1]

所有效果如上图所示。

![Example Image][2]

左侧图片为所有效果的截图包括IndicatorView和SimpleIndicatorView，右侧图片为SimpleIndicatorView单独示例。

## 功能
1. 均等Indicator显示；
2. 不均等Indicator显示，根据tab标题的字宽度自动适配；
3. Indicator可以添加indicator两端相对多增加的长度；
4. 可以设置颜色渐变，一般可用来做tab切换，增加美感；
5. 文字也可以随Indicator的颜色变化而变化，具有渐变效果；
6. SimpleIndicatorView可以设置indicator的宽度相对每个等长单元的宽度比值；
7. SimpleIndicatorView可以设置滑动方向，即水平方向或者竖直方向，同时可以设置底部线条的位置；
7. 可与ViewPager联动；
8. 可首尾循环；
9. 支持padding，支持自定义点击效果等；
10. 可一同设置文字；
11. java代码控制非常简单，如果和ViewPager联动，那么只需要一行代码。

## 加入项目
```
  compile 'cn.carbs.android:IndicatorView:1.0.1'
```

## 使用方法
### xml布局文件中声明：
SimpleIndicatorView和IndicatorView采用了两种不同的属性，原因是两者差距稍大，索性采用两套属性。由于属性较多，因此xml中的声明稍微复杂。之所以写了两个view，是因为竖直方向显示时，一般没有文字描述，另外SimpleIndicatorView较为轻量化，便于降低耦合。

1.对于IndicatorView，xml中这样声明：
```
  <cn.carbs.android.indicatorview.library.IndicatorView
        android:id="@+id/indicator_view"
        android:layout_width="match_parent"
        android:layout_height="60dp"
        android:layout_marginTop="20dp"
        android:background="#ffeeeeee"
        android:paddingLeft="2dp"
        android:paddingRight="2dp"
        app:iv_IndicatorColorEnd="#ffee5544"
        app:iv_IndicatorColorGradient="true"
        app:iv_IndicatorColorStart="#ff3388ff"
        app:iv_IndicatorEven="false"
        app:iv_IndicatorLengthExtra="3dp"
        app:iv_IndicatorTextArray="@array/text_arrays_2"
        app:iv_IndicatorTextGap="20dp"
        app:iv_IndicatorTextSize="20dp"/>
```
2.对于SimpleIndicatorView，xml中这样声明：
```
<cn.carbs.android.indicatorview.library.SimpleIndicatorView
        android:id="@+id/simple_indicator_view_v"
        android:layout_width="4dp"
        android:layout_height="match_parent"
        android:layout_alignParentLeft="true"
        app:iv_SimpleIndicatorColorEnd="#ffee5544"
        app:iv_SimpleIndicatorColorGradient="true"
        app:iv_SimpleIndicatorColorStart="#ff3388ff"
        app:iv_SimpleIndicatorCount="4"
        app:iv_SimpleIndicatorLinePosition="start"
        app:iv_SimpleIndicatorOrientation="vertical"
        app:iv_SimpleIndicatorWidthRation="0.8"/>
```
各个属性作用，见说明末尾。

### java文件中的控制：

如果想和ViewPager联动，那么Java代码只有一句：
```
  mIndicatorView.setViewPager(mViewpager);
```
如果想主动改变其显示的索引值，可通过多种方式：
```
  //使IndicatorView当前指示的索引值加1
  mIndicatorView.increaseSelectedIndexWithViewPager();
  
  //使IndicatorView当前指示的索引值减1
  mIndicatorView.decreaseSelectedIndexWithViewPager();
  
  //使IndicatorView指向任意的索引值
  mIndicatorView.setIndexWithViewPager(int indexDest);
```

IndicatorView状态改变后的回调函数：
```
  mIndicatorView.setOnIndicatorChangedListener(new IndicatorView.OnIndicatorChangedListener() {
            @Override
            public void onIndicatorChanged(int oldSelectedIndex, int newSelectedIndex) {
                //如果已经和ViewPager关联了，那么不要在此处改变ViewPager的状态
            }
        });
```

## 注意事项
1. IndicatorLengthExtra属性请暂时使用大于等于0的dimension值，因为我暂时没有对负值做限制，如果负值过小，可能显示会有问题;
2. 不支持在Java代码中生成此view;
3. IndicatorView只能水平方向显示，而SimpleIndicatorView可以竖直方向显示。
4. IndicatorView能与ViewPager联动，而SimpleIndicatorView不能。

## 属性说明
### IndicatorView的相关属性
```
<declare-styleable name="IndicatorView">
        <attr name="iv_IndicatorEven" format="reference|boolean" /> //每个单元是否是等宽的
        <attr name="iv_IndicatorColor" format="reference|color" />  //indicator的颜色
        <attr name="iv_IndicatorColorStart" format="reference|color" /> //indicator的起始颜色，indicator的颜色随着滑动而进行改变，iv_IndicatorColorGradient属性开启后有效
        <attr name="iv_IndicatorColorEnd" format="reference|color" />   //indicator的终止颜色，iv_IndicatorColorGradient属性开启后有效
        <attr name="iv_IndicatorColorGradient" format="reference|boolean" />//是否允许indicator随着滑动而改变颜色
        <attr name="iv_IndicatorTextGap" format="reference|dimension" />  //每个text之间的间距，在单元非等宽的条件下有效(iv_IndicatorEven="false")
        <attr name="iv_IndicatorTextArray" format="reference" />//显示的tab标题
        <attr name="iv_IndicatorTextSize" format="reference|dimension" />//显示的tab标题的文字大小
        <attr name="iv_IndicatorTextColorNormal" format="reference|color" />//显示的tab标题的非选中状态文字颜色(iv_IndicatorColorGradient="false"条件下有效)
        <attr name="iv_IndicatorTextColorSelected" format="reference|color" />//显示的tab标题的选中状态文字颜色(iv_IndicatorColorGradient="false"条件下有效)
        <attr name="iv_IndicatorLengthExtra" format="reference|dimension" />//indicator长于每个tab标题的长度的一半
        <attr name="iv_IndicatorDuration" format="reference|integer" />//indicator切换时的动画持续时间
        <attr name="iv_IndicatorSelectedIndex" format="reference|integer" />//默认的选中索引
        <attr name="iv_IndicatorHeight" format="reference|dimension" />//indicator的高度
        <attr name="iv_IndicatorBgTouchedColor" format="reference|color" />//按下某个tab标题时的背景颜色
        <attr name="iv_IndicatorViewPagerAnim" format="reference|boolean" />//按下tab后，与之联动的ViewPager是否需要有动画效果，默认true
    </declare-styleable>
    
```

### SimpleIndicatorView的相关属性
```
    <declare-styleable name="SimpleIndicatorView">
        <attr name="iv_SimpleIndicatorColor" format="reference|color" />//indicator的颜色
        <attr name="iv_SimpleIndicatorColorStart" format="reference|color" />//indicator的起始颜色，indicator的颜色随着滑动而进行改变，iv_IndicatorColorGradient属性开启后有效
        <attr name="iv_SimpleIndicatorColorEnd" format="reference|color" />//indicator的终止颜色，iv_IndicatorColorGradient属性开启后有效
        <attr name="iv_SimpleIndicatorColorGradient" format="reference|boolean" />//是否允许indicator随着滑动而改变颜色
        <attr name="iv_SimpleIndicatorCount" format="reference|integer" />//一共包含的单元数目
        <attr name="iv_SimpleIndicatorWidthRation" format="reference|float" />//indicator宽度与均分的单元的宽度比值
        <attr name="iv_SimpleIndicatorDuration" format="reference|integer" />//indicator切换时的动画持续时间
        <attr name="iv_SimpleIndicatorDefaultIndex" format="reference|integer" />//默认的选中索引
        <attr name="iv_SimpleIndicatorLineColor" format="reference|color" />//底部的线条的颜色
        <attr name="iv_SimpleIndicatorLineShow" format="reference|boolean" />//底部线条是否显示
        <attr name="iv_SimpleIndicatorLineThickness" format="reference|dimension" />//底部线条的高度
        <attr name="iv_SimpleIndicatorOrientation" format="enum">//indicator水平显示还是竖直显示
            <enum name="horizontal" value="0" />
            <enum name="vertical" value="1" />
        </attr>
        <attr name="iv_SimpleIndicatorLinePosition" format="enum">//底部线条的位置：水平方向，可以在顶部，可以在底部。竖直方向，可以在左侧，可以在右侧。
            <enum name="start" value="0" />
            <enum name="end" value="1" />
        </attr>
    </declare-styleable>
```

#English

IndicatorView on Android platform to indicator the current index of pages

## Abstract
Android `IndicatorView` inspired by `SlidingTabView`, this project was to practice customizing view, but as i kept working on it, now it has some interesting attributes. <br>
This view's defects compared to SlidingTabView is it cannot scroll the Strings to adjust the content to the center when pressed content is not shown completely, and in parttime i will refine this funtion.<br>
BTW, it donot have ripple effect neither.<br>

## Application Scenarios
tabs not fill the width of screen.

## Screenshot

![Example Image][1]

![Example Image][2]

left picture includes IndicatorView and SimpleIndicatorView, right one just presents SimpleIndicatorView sample.

## Functions and Attributes
0. can change position gradually correspondding to ViewPager;
1. show even Indicators；
2. show uneven Indicators, can adjust width of indicator automatically correspondding to the current text
3. can set the extra length of indicator compared to each text;
4. can set Gradient color of indicator when indicator changing its position, making UI more friendly; 
5. can set Gradient color of text when indicator changing its position, making UI more friendly; 
6. can set SimpleIndicatorView's width ratio, correspondding to each Unit's width;
7. can set SimpleIndicatorView's orientation, horizontal or vertical. can add a line at start or end of this SimpleIndicatorView.
8. can change position from first item to last one, vice versa.
9. support padding, support pressed effect.
10. can set texts at once.
11. can control IndicatorView by using only one line of java code, if you want it to move correspondding to ViewPager.

## Add to project
```
  compile 'cn.carbs.android:IndicatorView:1.0.1'
```

## How to use
### add view in xml
Since SimpleIndicatorView and IndicatorView are in different style and have many different attributes, I made two attr xml files. and SimpleIndicatorView is of Low Coupling compared with IndicatorView.

1.as to IndicatorView, in xml:
```
  <cn.carbs.android.indicatorview.library.IndicatorView
        android:id="@+id/indicator_view"
        android:layout_width="match_parent"
        android:layout_height="60dp"
        android:layout_marginTop="20dp"
        android:background="#ffeeeeee"
        android:paddingLeft="2dp"
        android:paddingRight="2dp"
        app:iv_IndicatorColorEnd="#ffee5544"
        app:iv_IndicatorColorGradient="true"
        app:iv_IndicatorColorStart="#ff3388ff"
        app:iv_IndicatorEven="false"
        app:iv_IndicatorLengthExtra="3dp"
        app:iv_IndicatorTextArray="@array/text_arrays_2"
        app:iv_IndicatorTextGap="20dp"
        app:iv_IndicatorTextSize="20dp"/>
```
2.as to SimpleIndicatorView, in xml
```
<cn.carbs.android.indicatorview.library.SimpleIndicatorView
        android:id="@+id/simple_indicator_view_v"
        android:layout_width="4dp"
        android:layout_height="match_parent"
        android:layout_alignParentLeft="true"
        app:iv_SimpleIndicatorColorEnd="#ffee5544"
        app:iv_SimpleIndicatorColorGradient="true"
        app:iv_SimpleIndicatorColorStart="#ff3388ff"
        app:iv_SimpleIndicatorCount="4"
        app:iv_SimpleIndicatorLinePosition="start"
        app:iv_SimpleIndicatorOrientation="vertical"
        app:iv_SimpleIndicatorWidthRation="0.8"/>
```
attrs' introduction is at the end of this file

### control view by java code:

if you want IndicatorView move correspondding to ViewPager, add code :
```
  mIndicatorView.setViewPager(mViewpager);
```
if you want to change its index, you can use one of these three mothods:
```
  //increase IndicatorView's index by 1
  mIndicatorView.increaseSelectedIndexWithViewPager();
  
  //decrease IndicatorView's index by 1
  mIndicatorView.decreaseSelectedIndexWithViewPager();
  
  //make IndicatorView refer to random index
  mIndicatorView.setIndexWithViewPager(int indexDest);
```

set callback when IndicatorView's state changed:
```
  mIndicatorView.setOnIndicatorChangedListener(new IndicatorView.OnIndicatorChangedListener() {
            @Override
            public void onIndicatorChanged(int oldSelectedIndex, int newSelectedIndex) {
				//if has set interaction with viewpager, donot set ViewPager's state here
            }
        });
```

## Attention
1. the attribute IndicatorLengthExtra should be larger than 0dp, i didnot set limitation of this value.
2. not support generate this view by java code, only support add view in xml; 
3. IndicatorView can only move in horizontal, SimpleIndicatorView can move in both horizontal and vertical;
4. IndicatorView can move correspondding to ViewPager, but SimpleIndicatorView cannot.

## Attributes
### IndicatorView's attributes
```
<declare-styleable name="IndicatorView">
        <attr name="iv_IndicatorEven" format="reference|boolean" /> //set if each item's width is equal
        <attr name="iv_IndicatorColor" format="reference|color" />  //indicator's color
        <attr name="iv_IndicatorColorStart" format="reference|color" /> //indicator's color when it start to move, color will change as indicator moving, valid if iv_IndicatorColorGradient is true
        <attr name="iv_IndicatorColorEnd" format="reference|color" /> //indicator's color when it end, color will change as indicator moving, valid if iv_IndicatorColorGradient is true
        <attr name="iv_IndicatorColorGradient" format="reference|boolean" />//if use gradient color effect
        <attr name="iv_IndicatorTextGap" format="reference|dimension" />// each text's gap to the next one, valid if  iv_IndicatorEven is false(only in uneven mode)
        <attr name="iv_IndicatorTextArray" format="reference" />//show tab's title
        <attr name="iv_IndicatorTextSize" format="reference|dimension" />//tab's text size
        <attr name="iv_IndicatorTextColorNormal" format="reference|color" />//tab's text color when not selected. valid when iv_IndicatorColorGradient="false"
        <attr name="iv_IndicatorTextColorSelected" format="reference|color" />//tab's text color when not select. valid when iv_IndicatorColorGradient="false"
        <attr name="iv_IndicatorLengthExtra" format="reference|dimension" />//equal to half of (indicator's length minus each tab's width)
        <attr name="iv_IndicatorDuration" format="reference|integer" />//duration of switching indicator from one index to another
        <attr name="iv_IndicatorSelectedIndex" format="reference|integer" />//default selected index
        <attr name="iv_IndicatorHeight" format="reference|dimension" />//indicator's height
        <attr name="iv_IndicatorBgTouchedColor" format="reference|color" />//background color when pressed one tab
        <attr name="iv_IndicatorViewPagerAnim" format="reference|boolean" />//when selected a tab, set true to make the correspondding ViewPager scroll with animation,false without animation. this value is the argument in setCurrentItem(int, boolean) of ViewPager    </declare-styleable>
    
```

### SimpleIndicatorView's attrs
```
    <declare-styleable name="SimpleIndicatorView">
        <attr name="iv_SimpleIndicatorColor" format="reference|color" />//indicator's color
        <attr name="iv_SimpleIndicatorColorStart" format="reference|color" />//indicator's color when it start to move, color will change as indicator moving, valid if iv_SimpleIndicatorColorGradient is true
        <attr name="iv_SimpleIndicatorColorEnd" format="reference|color" />//indicator's color when it end, color will change as indicator moving, valid if iv_SimpleIndicatorColorGradient is true
        <attr name="iv_SimpleIndicatorColorGradient" format="reference|boolean" />//if use gradient color effect
        <attr name="iv_SimpleIndicatorCount" format="reference|integer" />//count number of units
        <attr name="iv_SimpleIndicatorWidthRation" format="reference|float" />//ratio of indicator width divided by each even unit's width
        <attr name="iv_SimpleIndicatorDuration" format="reference|integer" />//duration of switching indicator from one index to another
        <attr name="iv_SimpleIndicatorDefaultIndex" format="reference|integer" />//default selected index
        <attr name="iv_SimpleIndicatorLineColor" format="reference|color" />//hint line's color
        <attr name="iv_SimpleIndicatorLineShow" format="reference|boolean" />//if show hint line
        <attr name="iv_SimpleIndicatorLineThickness" format="reference|dimension" />//height of hint line
        <attr name="iv_SimpleIndicatorOrientation" format="enum">//indicator in horizontal or vertical
            <enum name="horizontal" value="0" />
            <enum name="vertical" value="1" />
        </attr>
        <attr name="iv_SimpleIndicatorLinePosition" format="enum">//hint line's position, when indicator is in horizontal, hint line can be at bottom or top of indicator; when indicator is in vertical, hint line can be at left or right of the indicator.
            <enum name="start" value="0" />
            <enum name="end" value="1" />
        </attr>
    </declare-styleable>
```

## License

Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

[1]: https://github.com/Carbs0126/Screenshot/blob/master/indicator_view.gif
 [2]: https://github.com/Carbs0126/Screenshot/blob/master/indicator_view_uneven.png
 [3]: https://github.com/Carbs0126/Screenshot/blob/master/indicator_view_sample.jpg

IndicatorView

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README