org.androidannotations.annotations

Annotation Type PageScrolled

@Retention(value=CLASS)
 @Target(value=METHOD)
public @interface PageScrolled

This annotation is intended to be used on methods to receive events defined by android.support.v4.view.ViewPager.OnPageChangeListener.OnPageScrolled when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll.

The annotation value should be one or several R.id.* fields that refers to ViewPager or subclasses of ViewPager. If not set, the method name will be used as the R.id.* field name.

The method MAY have multiple parameters, but the order must be following :

• A ViewPager parameter to know which view has targeted this event.
• An int parameter named position to get position index of the first page currently being displayed. Page position+1 will be visible if positionOffset is nonzero.
• A float parameter is value from [0,1) indicating the offset from the page at position.
• An int parameter named positionOffsetPixels is value in pixels indicating the offset from position.

Examples :

 @PageScrolled(R.id.viewpager)
 void onPageScrolled(ViewPager view, int position, float positionOffset, int positionOffsetPixels) {
        // Something Here
 }

 @PageScrolled
 void viewPager(ViewPager view) {
        // Something Here
 }

 @PageScrolled({R.id.viewpager, R.id.viewpager2})
 void onPageScrolledOnMultipleViewPager(ViewPager v, int position) {
        // Something Here
 }

 @PageScrolled(R.id.viewpager)
 void onPageScrolledNoParam() {
        // Something Here
 }
 

See Also:

PageScrollStateChanged, PageSelected

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	resName The resource names as a strings which refer to the ViewPagers.
int[]	value The R.id.* fields which refer to the ViewPager.

Element Detail

value

public abstract int[] value

The R.id.* fields which refer to the ViewPager.

Returns:

the ids of the ViewPager.

Default:

-1

resName

public abstract String[] resName

The resource names as a strings which refer to the ViewPagers.

Returns:

the resource names of the ViewPagers.

Default:

""