onPageSelected isn't triggered when calling setCurrentItem(0)

AndroidAndroid Viewpager

Android Problem Overview


I have an Activity with a ViewPager which displays a bunch of pictures. When it starts the ViewPager's position is set based on what the user selected in a previous Activity. Similar to a gallery.

I want the onPageSelected to be called every time a new page is selected, i.e. when the Activity is first opened or when the user slides to a new page.

I set the starting point like so:

 mPager.setCurrentItem(index);

Everything works, except when setCurrentItem called with index set to 0 as this will not trigger onPageSelected.

mPager.setOnPageChangeListener(new OnPageChangeListener() {
  @Override
  public void onPageSelected(int index) {
    Log.d(TAG, "onPageSelected " + index);
  }
  ...
}

So my question is; is this a bug, and if so what can I do about it?

Android Solutions


Solution 1 - Android

The cleanest solution I've found to this so far is to take a reference to the onPageChangeListener you set on the ViewPager (since I don't think there's a ViewPager.getOnPageChangeListener() method), then after you've set the ViewPager's adapter, call:

onPageChangeListener.onPageSelected(viewPager.getCurrentItem());

However, the fragment for the page at the current index won't have been instantiated yet (at least if you're using FragmentStatePagerAdapter), so you may need to wrap it in a runnable, ala:

viewPager.post(new Runnable(){
@Override
    public void run() {
        onPageChangeListener.onPageSelected(viewPager.getCurrentItem());
    }
});

Also, if within the onPageSelected handler you need a reference to the fragment, you'll have to do that yourself. I use an abstract base class for my FragmentStatePagerAdapter which overrides the instantiate and destroy methods, and adds/removes the fragments from a SparseArray.

Solution 2 - Android

Ok, so I haven't been able to figure out whether this is a bug (or a feature). But I thought I'd share how a possible solution to the problem could look..

Write the functionality you wish to perform in a method in the Activity and then call this in the onPageSelected method.

mPager.setOnPageChangeListener(new OnPageChangeListener() {
    @Override
    public void onPageSelected(int index) {
        myOnPageSelectedLogic(index);
    }
    ...
}

And then right after calling

setCurrentItem(index);

in the Activity, add the following if statement

if(index == 0) {
    myOnPageSelectedLogic(0);
}

It's not super pretty but I hope it helps someone :)

Solution 3 - Android

Actually I think this is a BUG. I've check the source code of ViewPager and found the only trigger of onPageSelected:

if (dispatchSelected && mOnPageChangeListener != null) {
			mOnPageChangeListener.onPageSelected(item);
		}

Above, variable dispatchSelected is determined by code:

final boolean dispatchSelected = mCurItem != item; 
//item is what you passed to setCurrentItem(item)

And, variable mCurItem is defined and initialized as:

private int mCurItem; // Index of currently displayed page.

So mCurItem is default to 0. When calling setCurrentItem(0), dispatchSelected will be false thus onPageSelected() will not be dispatched.

Now we should understand why calling setCurrentItem(0) is a problem while setCurrentItem(1, or 2, 3...) is not.

How to solve this problem:

  1. Copy the code of ViewPager to your own project and fix it:

     from 
     final boolean dispatchSelected = mCurItem != item; //the old line
     to
     final boolean dispatchSelected = mCurItem != item || mFirstLayout; //the new line
    

    then use your own ViewPager.

  2. Since you consciously called setCurrentItem(0) and have a refrence to the OnPageChangedListener, dispatch the onPageSelected() by yourself.

  3. 听楼下怎么说...

Solution 4 - Android

The following solution seems to work for me. i.e. I get a callback at position 0 when the viewpager is first loaded and for all subsequent selections either from user scrolling or a setCurrentItem(x) call. I haven't observed any undesired behaviour.

viewPager.addOnPageChangeListener(new ViewPager.OnPageChangeListener() {
            @Override
            public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {

                if (positionOffsetPixels == 0) {
                 //Do something on selected page at position
                }
    
            }

            @Override
            public void onPageSelected(int position) {}

            @Override
            public void onPageScrollStateChanged(int state) {}
        });

Solution 5 - Android

onPageSelected is not triggered for page which is opened first. For this case I manually perform all needed actions. Also, I suppose that call to onPageSelected(0) should work too.

Solution 6 - Android

You can extend the ViewPager and call the Listener by yourself when the position is changed from 0 to 0

public class BetterViewPager extends ViewPager {

	public BetterViewPager(Context context, AttributeSet attrs) {
			super(context, attrs);
		}

		// we some the listner
		protected OnPageChangeListener listener;
		
		@Override
		public void setOnPageChangeListener(OnPageChangeListener listener) {
			super.setOnPageChangeListener(listener);
			this.listener = listener;
		}
		
		@Override
		public void setCurrentItem(int item) {
			// when you pass set current item to 0,
			// the listener won't be called so we call it on our own
			boolean invokeMeLater = false;
			
			if(super.getCurrentItem() == 0 && item == 0)
				invokeMeLater = true;
			
			super.setCurrentItem(item);
			
			if(invokeMeLater && listener != null)
				listener.onPageSelected(0);
		}
		
}

Solution 7 - Android

public class PageChangeListener implements ViewPager.OnPageChangeListener {
    @Override
    public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {

    }

    @Override
    public void onPageSelected(int position) {
    }

    @Override
    public void onPageScrollStateChanged(int state) {
        if (state == ViewPager.SCROLL_STATE_IDLE && getCurrentItem() == 0) {
         //this indicate viewpager finish scroll and page at position 0 is selected.
        }

Solution 8 - Android

The simplest solution will be using of function e.g.

    viewpager.addOnPageChangeListener(new ViewPager.OnPageChangeListener() {

        @Override
        public void onPageScrollStateChanged(int state) {}

        @Override
        public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {}

        @Override
        public void onPageSelected(int position) {
            onPage(position);
        }
    });

    // call first time
    onPage(0); 

    private void onPage(int position) {
        //...
    }

Solution 9 - Android

If the ViewPager is in a fragment, in the onViewCreated method, call mPager.setOnPageChangeListener(this)

Solution 10 - Android

if you don't care screen animotion try

pager.setCurrentItem(1);
pager.setCurrentItem(0);

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionjpihlView Question on Stackoverflow
Solution 1 - AndroidtechnicalflawView Answer on Stackoverflow
Solution 2 - AndroidjpihlView Answer on Stackoverflow
Solution 3 - Androidldn0x7dcView Answer on Stackoverflow
Solution 4 - AndroidmaturecheeseView Answer on Stackoverflow
Solution 5 - AndroidmarwinXXIIView Answer on Stackoverflow
Solution 6 - AndroidKirill KulakovView Answer on Stackoverflow
Solution 7 - AndroidDartan LiView Answer on Stackoverflow
Solution 8 - AndroidVladView Answer on Stackoverflow
Solution 9 - AndroidErik K.View Answer on Stackoverflow
Solution 10 - Android羅旭辰View Answer on Stackoverflow