FragmentStatePagerAdapter.java revision 0574ca37da4619afe4e26753f5a1b4de314b6565
1ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn/* 2ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * Copyright (C) 2011 The Android Open Source Project 3ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * 4ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * Licensed under the Apache License, Version 2.0 (the "License"); 5ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * you may not use this file except in compliance with the License. 6ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * You may obtain a copy of the License at 7ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * 8ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * http://www.apache.org/licenses/LICENSE-2.0 9ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * 10ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * Unless required by applicable law or agreed to in writing, software 11ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * distributed under the License is distributed on an "AS IS" BASIS, 12ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * See the License for the specific language governing permissions and 14ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * limitations under the License. 15ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn */ 16ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 17ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornpackage android.support.v13.app; 18ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 19ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.app.Fragment; 20ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.app.FragmentManager; 21ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.app.FragmentTransaction; 22ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.os.Bundle; 23ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.os.Parcelable; 245c1637087453de15e31861f073eae5133c4e9f7bDianne Hackbornimport android.support.v4.view.PagerAdapter; 25ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.util.Log; 26ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackbornimport android.view.View; 27583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powellimport android.view.ViewGroup; 28583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powell 29583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powellimport java.util.ArrayList; 30ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 310574ca37da4619afe4e26753f5a1b4de314b6565Svetoslav Ganov/** 320574ca37da4619afe4e26753f5a1b4de314b6565Svetoslav Ganov * Implementation of {@link android.support.v4.view.PagerAdapter} that 330574ca37da4619afe4e26753f5a1b4de314b6565Svetoslav Ganov * uses a {@link Fragment} to manage each page. This class also handles 340574ca37da4619afe4e26753f5a1b4de314b6565Svetoslav Ganov * saving and restoring of fragment's state. 350574ca37da4619afe4e26753f5a1b4de314b6565Svetoslav Ganov */ 365c1637087453de15e31861f073eae5133c4e9f7bDianne Hackbornpublic abstract class FragmentStatePagerAdapter extends PagerAdapter { 37ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn private static final String TAG = "FragmentStatePagerAdapter"; 38ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn private static final boolean DEBUG = false; 39ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 40ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn private final FragmentManager mFragmentManager; 41ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn private FragmentTransaction mCurTransaction = null; 42ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 43ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn private ArrayList<Fragment.SavedState> mSavedState = new ArrayList<Fragment.SavedState>(); 44ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn private ArrayList<Fragment> mFragments = new ArrayList<Fragment>(); 452a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn private Fragment mCurrentPrimaryItem = null; 46ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 47ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn public FragmentStatePagerAdapter(FragmentManager fm) { 48ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragmentManager = fm; 49ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 50ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 51ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn /** 52ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn * Return the Fragment associated with a specified position. 53ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn */ 54ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn public abstract Fragment getItem(int position); 55ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 565c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn @Override 57583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powell public void startUpdate(ViewGroup container) { 58ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 59ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 605c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn @Override 61583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powell public Object instantiateItem(ViewGroup container, int position) { 62ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn // If we already have this item instantiated, there is nothing 63ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn // to do. This can happen when we are restoring the entire pager 64ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn // from its saved state, where the fragment manager has already 65ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn // taken care of restoring the fragments we previously had instantiated. 66ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (mFragments.size() > position) { 67ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment f = mFragments.get(position); 68ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (f != null) { 69ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn return f; 70ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 71ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 72ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 73ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (mCurTransaction == null) { 74ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mCurTransaction = mFragmentManager.beginTransaction(); 75ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 76ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 77ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment fragment = getItem(position); 78ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (DEBUG) Log.v(TAG, "Adding item #" + position + ": f=" + fragment); 79ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (mSavedState.size() > position) { 80ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment.SavedState fss = mSavedState.get(position); 81ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (fss != null) { 82ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn fragment.setInitialSavedState(fss); 83ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 84ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 85ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn while (mFragments.size() <= position) { 86ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragments.add(null); 87ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 882a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn FragmentCompat.setMenuVisibility(fragment, false); 89ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragments.set(position, fragment); 905c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn mCurTransaction.add(container.getId(), fragment); 91ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 92ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn return fragment; 93ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 94ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 955c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn @Override 96583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powell public void destroyItem(ViewGroup container, int position, Object object) { 97ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment fragment = (Fragment)object; 98ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 99ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (mCurTransaction == null) { 100ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mCurTransaction = mFragmentManager.beginTransaction(); 101ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 102ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (DEBUG) Log.v(TAG, "Removing item #" + position + ": f=" + object 103ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn + " v=" + ((Fragment)object).getView()); 104ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn while (mSavedState.size() <= position) { 105ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mSavedState.add(null); 106ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 107ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mSavedState.set(position, mFragmentManager.saveFragmentInstanceState(fragment)); 108ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragments.set(position, null); 109ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 110ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mCurTransaction.remove(fragment); 111ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 112ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 1135c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn @Override 114583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powell public void setPrimaryItem(ViewGroup container, int position, Object object) { 1152a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn Fragment fragment = (Fragment)object; 1162a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn if (fragment != mCurrentPrimaryItem) { 1172a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn if (mCurrentPrimaryItem != null) { 1182a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn FragmentCompat.setMenuVisibility(mCurrentPrimaryItem, false); 1192a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn } 1202a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn if (fragment != null) { 1212a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn FragmentCompat.setMenuVisibility(fragment, true); 1222a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn } 1232a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn mCurrentPrimaryItem = fragment; 1242a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn } 1252a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn } 1262a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn 1272a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn @Override 128583d8a1ff64c7c59dd4e11759f3d8e994ce878d9Adam Powell public void finishUpdate(ViewGroup container) { 129ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (mCurTransaction != null) { 1302a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn mCurTransaction.commitAllowingStateLoss(); 131ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mCurTransaction = null; 132ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragmentManager.executePendingTransactions(); 133ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 134ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 135ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 1365c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn @Override 137ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn public boolean isViewFromObject(View view, Object object) { 138ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn return ((Fragment)object).getView() == view; 139ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 140ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 141ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn @Override 142ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn public Parcelable saveState() { 143ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Bundle state = null; 144ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (mSavedState.size() > 0) { 145ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn state = new Bundle(); 146ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment.SavedState[] fss = new Fragment.SavedState[mSavedState.size()]; 147ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mSavedState.toArray(fss); 148ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn state.putParcelableArray("states", fss); 149ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 150ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn for (int i=0; i<mFragments.size(); i++) { 151ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment f = mFragments.get(i); 152ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (f != null) { 153ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (state == null) { 154ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn state = new Bundle(); 155ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 156ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn String key = "f" + i; 157ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragmentManager.putFragment(state, key, f); 158ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 159ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 160ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn return state; 161ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 162ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn 163ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn @Override 1645c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn public void restoreState(Parcelable state, ClassLoader loader) { 165ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (state != null) { 166ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Bundle bundle = (Bundle)state; 1675c1637087453de15e31861f073eae5133c4e9f7bDianne Hackborn bundle.setClassLoader(loader); 168ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Parcelable[] fss = bundle.getParcelableArray("states"); 169ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mSavedState.clear(); 170ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragments.clear(); 171ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (fss != null) { 172ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn for (int i=0; i<fss.length; i++) { 173ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mSavedState.add((Fragment.SavedState)fss[i]); 174ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 175ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 176ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Iterable<String> keys = bundle.keySet(); 177ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn for (String key: keys) { 178ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (key.startsWith("f")) { 179ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn int index = Integer.parseInt(key.substring(1)); 180ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Fragment f = mFragmentManager.getFragment(bundle, key); 181ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn if (f != null) { 182ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn while (mFragments.size() <= index) { 183ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragments.add(null); 184ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 1852a4d8518f36346ea25a22a736453ff28f2954165Dianne Hackborn FragmentCompat.setMenuVisibility(f, false); 186ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn mFragments.set(index, f); 187ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } else { 188ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn Log.w(TAG, "Bad fragment at key " + key); 189ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 190ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 191ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 192ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 193ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn } 194ea2c91b0198855073983b4a8437aa71cbd83872fDianne Hackborn} 195