Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JakeWharton/ViewPagerIndicator

Paging indicator widgets compatible with the ViewPager from the Android Support Library and ActionBarSherlock.
https://github.com/JakeWharton/ViewPagerIndicator

Last synced: 18 days ago
JSON representation

Paging indicator widgets compatible with the ViewPager from the Android Support Library and ActionBarSherlock.

Awesome Lists containing this project

README 

        
Android ViewPagerIndicator

==========================



Paging indicator widgets that are compatible with the `ViewPager` from the

[Android Support Library][2] to improve discoverability of content.



Try out the sample application [on the Android Market][10].



![ViewPagerIndicator Sample Screenshots][9]



These widgets can also be used in conjunction with [ActionBarSherlock][3]!



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.



        



  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][7]. 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][8] in

Eclipse or ant.



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

a dependency:



    

      com.viewpagerindicator

      library

      2.4.1

      apklib

    



This project depends on the `ViewPager` class which is available in the

[Android Support Library][2] or [ActionBarSherlock][3]. Details for

including one of those libraries is available on their respecitve web sites.



Developed By

============



 * Jake Wharton - 



Credits

-------



 * [Patrik Åkerfeldt][1] - Author of [ViewFlow][4], a precursor to the ViewPager,

   which supports paged views and is the original source of both the title

   and circle indicators.

 * [Francisco Figueiredo Jr.][5] - Idea and [first implementation][6] for

   fragment support via ViewPager.



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.



 [1]: https://github.com/pakerfeldt

 [2]: http://developer.android.com/sdk/compatibility-library.html

 [3]: http://actionbarsherlock.com

 [4]: https://github.com/pakerfeldt/android-viewflow

 [5]: https://github.com/franciscojunior

 [6]: https://gist.github.com/1122947

 [7]: http://developer.android.com/guide/developing/projects/projects-eclipse.html

 [8]: http://developer.android.com/guide/developing/projects/projects-eclipse.html#ReferencingLibraryProject

 [9]: https://raw.github.com/JakeWharton/Android-ViewPagerIndicator/master/sample/screens.png

 [10]: https://play.google.com/store/apps/details?id=com.viewpagerindicator.sample