ViewPagerIndicator README

The project's README from github.com/JakeWharton/ViewPagerIndicator. As one markdown file: README.md.

Android ViewPagerIndicator

Paging indicator widgets that are compatible with the ViewPager from the Android Support Library to improve discoverability of content.

Try out the sample application on the Android Market.

ViewPagerIndicator Sample Screenshots

These widgets can also be used in conjunction with ActionBarSherlock!

Usage

For a working implementation of this project see the sample/ folder.

  1. Include one of the widgets in your view. This should usually be placed adjacent to the ViewPager it represents.

    <com.viewpagerindicator.TitlePageIndicator android:id="@+id/titles" android:layout_height="wrap_content" android:layout_width="fill_parent" />

  2. In your onCreate method (or onCreateView for a fragment), bind the indicator to the ViewPager.

    //Set the pager with an adapter
ViewPager pager = (ViewPager)findViewById(R.id.pager);
pager.setAdapter(new TestAdapter(getSupportFragmentManager()));

//Bind the title indicator to the adapter
TitlePageIndicator titleIndicator = (TitlePageIndicator)findViewById(R.id.titles);
titleIndicator.setViewPager(pager);

  3. (Optional) If you use an OnPageChangeListener with your view pager you should set it in the indicator rather than on the pager directly.

    //continued from above
titleIndicator.setOnPageChangeListener(mPageChangeListener);

Theming

There are three ways to style the look of the indicators.

  1. Theme XML. An attribute for each type of indicator is provided in which you can specify a custom style.
  2. Layout XML. Through the use of a custom namespace you can include any desired styles.
  3. Object methods. Both styles have getters and setters for each style attribute which can be changed at any point.

Each indicator has a demo which creates the same look using each of these methods.

Including In Your Project

Android-ViewPagerIndicator is presented as an Android library project. A standalone JAR is not possible due to the theming capabilities offered by the indicator widgets.

You can include this project by referencing it as a library project in Eclipse or ant.

If you are a Maven user you can easily include the library by specifying it as a dependency:

<dependency>
  <groupId>com.viewpagerindicator</groupId>
  <artifactId>library</artifactId>
  <version>2.4.1</version>
  <type>apklib</type>
</dependency>

This project depends on the ViewPager class which is available in the Android Support Library or ActionBarSherlock. Details for including one of those libraries is available on their respecitve web sites.

Developed By

Credits

License

Copyright 2012 Jake Wharton
Copyright 2011 Patrik Åkerfeldt
Copyright 2011 Francisco Figueiredo Jr.

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.

ViewPagerIndicator (JakeWharton/ViewPagerIndicator)

Searching Database…

10.1K ·GitHub
ViewPagerIndicator
archived
What is this?A set of paging indicator widgets for Android that sit alongside a ViewPager from the Android Support Library or ActionBarSherlock, showing where the user is to improve discoverability of content.
Is it an app or something I add to my own Android project?An Android library project you include in your own app, not a standalone JAR — a JAR is not possible because the theming requires the library's resources.
How do I add it to my project?Reference it as an Android library project in Eclipse or ant, or add the Maven dependency com.viewpagerindicator:library:2.4.1 (apklib). The sample/ folder in the repo holds a complete working implementation.
Does my app need anything else for these indicators to work?Yes — your project must also include whatever provides the ViewPager class: the Android Support Library or ActionBarSherlock. Setup details for those are on their respective sites.
Is this still actively maintained?No — the GitHub repository is archived and read-only, and the code dates from 2011-2012, targeting the Eclipse/ant and Maven era. Expect to adapt it before using it in a modern Android build.
How do I hook an indicator up to my ViewPager?Add the widget to your layout next to the ViewPager, then in onCreate (or onCreateView for a fragment) call indicator.setViewPager(pager). If you use an OnPageChangeListener, set it on the indicator rather than on the pager directly.
Can I change how the indicators look?Yes, three ways: a style attribute in your theme XML, styles through a custom namespace in layout XML, or getters and setters on the indicator object at runtime.
Which indicator styles does it include?The usage example shows TitlePageIndicator, and the credits note the title and circle indicators originally came from Patrik Åkerfeldt's ViewFlow. An attribute is provided for each type of indicator, and each type has its own demo in the sample app.
Does it support fragments?Yes — the credits list Francisco Figueiredo Jr. for the idea and first implementation of fragment support via ViewPager, and the sample binds its pager with getSupportFragmentManager().
What are similar projects?banner, flexbox-layout, vlayout, CircleImageView, SlidingMenu, material-dialogs, material-components-android, MaterialDrawer
Which topics is it in?pagination, xml, widgets, layout, android-library, mobile-development, ui-components, deprecated, java, mobile, ui, android
Creator
JakeWharton
Size
8.5 MB
Stars
10.1K
Updated
CommitSep 12
Age
15y
Commits · 90 Days