githubzoujiayun / android-helpviewpager

Show help guide on the app first launched

Android HelpViewPager

Port of ViewPagerIndicator's paging indicators, using for Help Guild.

Try out the [sample application] 2.

Usage

For a working implementation of this project see the sample project

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 indicator to the adapter
   PageIndicator indicator = (PageIndicator)findViewById(R.id.indicator);
   indicator.setViewPager(pager);
   

3. set OnLastPageListener on the indicator, and finish the Help Content Activity when user finish the Help page.

   mIndicator.setOnLastPageListener(new OnLastPageListener() {
      @Override
      public void onLastPage() {
          finish();
      }
   });   
   

4. (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
   indicator.setOnPageChangeListener(mPageChangeListener);
   

Credits

• Patrik Åkerfeldt - Author of ViewFlow, a precursor to the ViewPager, which supports paged views and is the original source of both the title and circle indicators.
• Francisco Figueiredo Jr. - Idea and first implementation for fragment support via ViewPager.

License

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

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.