FragmentController.java revision 44ba79e47d6db54e5501f994880fa09eb880c185
1a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy/* 2a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Copyright (C) 2015 The Android Open Source Project 3a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 4a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Licensed under the Apache License, Version 2.0 (the "License"); 5a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * you may not use this file except in compliance with the License. 6a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * You may obtain a copy of the License at 7a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 8a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * http://www.apache.org/licenses/LICENSE-2.0 9a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 10a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Unless required by applicable law or agreed to in writing, software 11a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * distributed under the License is distributed on an "AS IS" BASIS, 12a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * See the License for the specific language governing permissions and 14a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * limitations under the License. 15a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 16a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 17a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedypackage android.app; 18a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 19a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.annotation.Nullable; 20a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.content.Context; 21a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.content.res.Configuration; 22a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.os.Bundle; 23a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.os.Parcelable; 24a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.util.ArrayMap; 25a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.util.AttributeSet; 26a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.view.Menu; 27a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.view.MenuInflater; 28a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.view.MenuItem; 29a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport android.view.View; 30a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 31a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport java.io.FileDescriptor; 32a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport java.io.PrintWriter; 33a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedyimport java.util.List; 34a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 35a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy/** 36a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Provides integration points with a {@link FragmentManager} for a fragment host. 37a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p> 38a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * It is the responsibility of the host to take care of the Fragment's lifecycle. 39a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * The methods provided by {@link FragmentController} are for that purpose. 40a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 41a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedypublic class FragmentController { 42a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy private final FragmentHostCallback<?> mHost; 43a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 44a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 45a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Returns a {@link FragmentController}. 46a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 47a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public static final FragmentController createController(FragmentHostCallback<?> callbacks) { 48a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return new FragmentController(callbacks); 49a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 50a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 51a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy private FragmentController(FragmentHostCallback<?> callbacks) { 52a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost = callbacks; 53a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 54a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 55a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 56a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Returns a {@link FragmentManager} for this controller. 57a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 58a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public FragmentManager getFragmentManager() { 59a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.getFragmentManagerImpl(); 60a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 61a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 62a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 63a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Returns a {@link LoaderManager}. 64a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 65a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public LoaderManager getLoaderManager() { 66a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.getLoaderManagerImpl(); 67a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 68a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 69a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 70a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Returns a fragment with the given identifier. 71a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 72a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy @Nullable 73a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public Fragment findFragmentByWho(String who) { 74a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.findFragmentByWho(who); 75a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 76a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 77a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 78a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Attaches the host to the FragmentManager for this controller. The host must be 79a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * attached before the FragmentManager can be used to manage Fragments. 80a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * */ 81a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void attachHost(Fragment parent) { 82a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.attachController( 83a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost, mHost /*container*/, parent); 84a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 85a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 86a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 87a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Instantiates a Fragment's view. 88a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 89a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @param parent The parent that the created view will be placed 90a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * in; <em>note that this may be null</em>. 91a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @param name Tag name to be inflated. 92a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @param context The context the view is being created in. 93a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @param attrs Inflation attributes as specified in XML file. 94a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 95a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @return view the newly created view 96a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 97a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public View onCreateView(View parent, String name, Context context, AttributeSet attrs) { 98a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.onCreateView(parent, name, context, attrs); 99a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 100a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 101a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 102a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Marks the fragment state as unsaved. This allows for "state loss" detection. 103a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 104a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void noteStateNotSaved() { 105a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.noteStateNotSaved(); 106a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 107a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 108a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 109a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Saves the state for all Fragments. 110a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 111a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public Parcelable saveAllState() { 112a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.saveAllState(); 113a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 114a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 115a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 116a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Restores the saved state for all Fragments. The given Fragment list are Fragment 117a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * instances retained across configuration changes. 118a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 119a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see #retainNonConfig() 12044ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * 12144ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * @deprecated use {@link #restoreAllState(Parcelable, FragmentManagerNonConfig)} 122a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 123a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void restoreAllState(Parcelable state, List<Fragment> nonConfigList) { 12444ba79e47d6db54e5501f994880fa09eb880c185Adam Powell mHost.mFragmentManager.restoreAllState(state, 12544ba79e47d6db54e5501f994880fa09eb880c185Adam Powell new FragmentManagerNonConfig(nonConfigList, null)); 12644ba79e47d6db54e5501f994880fa09eb880c185Adam Powell } 12744ba79e47d6db54e5501f994880fa09eb880c185Adam Powell 12844ba79e47d6db54e5501f994880fa09eb880c185Adam Powell /** 12944ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * Restores the saved state for all Fragments. The given FragmentManagerNonConfig are Fragment 13044ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * instances retained across configuration changes, including nested fragments 13144ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * 13244ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * @see #retainNestedNonConfig() 13344ba79e47d6db54e5501f994880fa09eb880c185Adam Powell */ 13444ba79e47d6db54e5501f994880fa09eb880c185Adam Powell public void restoreAllState(Parcelable state, FragmentManagerNonConfig nonConfig) { 13544ba79e47d6db54e5501f994880fa09eb880c185Adam Powell mHost.mFragmentManager.restoreAllState(state, nonConfig); 136a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 137a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 138a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 139a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Returns a list of Fragments that have opted to retain their instance across 140a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * configuration changes. 14144ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * 14244ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * @deprecated use {@link #retainNestedNonConfig()} to also track retained 14344ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * nested child fragments 144a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 145a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public List<Fragment> retainNonConfig() { 14644ba79e47d6db54e5501f994880fa09eb880c185Adam Powell return mHost.mFragmentManager.retainNonConfig().getFragments(); 14744ba79e47d6db54e5501f994880fa09eb880c185Adam Powell } 14844ba79e47d6db54e5501f994880fa09eb880c185Adam Powell 14944ba79e47d6db54e5501f994880fa09eb880c185Adam Powell /** 15044ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * Returns a nested tree of Fragments that have opted to retain their instance across 15144ba79e47d6db54e5501f994880fa09eb880c185Adam Powell * configuration changes. 15244ba79e47d6db54e5501f994880fa09eb880c185Adam Powell */ 15344ba79e47d6db54e5501f994880fa09eb880c185Adam Powell public FragmentManagerNonConfig retainNestedNonConfig() { 154a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.retainNonConfig(); 155a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 156a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 157a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 158a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 159a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the create state. 160a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be created. 161a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 162a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onCreate(Bundle) 163a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 164a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchCreate() { 165a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchCreate(); 166a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 167a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 168a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 169a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 170a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the activity created state. 171a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be informed their host has been created. 172a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 173a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onActivityCreated(Bundle) 174a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 175a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchActivityCreated() { 176a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchActivityCreated(); 177a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 178a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 179a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 180a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 181a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the start state. 182a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be started. 183a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 184a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onStart() 185a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 186a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchStart() { 187a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchStart(); 188a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 189a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 190a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 191a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 192a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the resume state. 193a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be resumed. 194a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 195a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onResume() 196a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 197a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchResume() { 198a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchResume(); 199a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 200a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 201a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 202a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 203a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the pause state. 204a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be paused. 205a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 206a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onPause() 207a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 208a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchPause() { 209a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchPause(); 210a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 211a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 212a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 213a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 214a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the stop state. 215a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be stopped. 216a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 217a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onStop() 218a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 219a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchStop() { 220a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchStop(); 221a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 222a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 223a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 224a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 225a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the destroy view state. 226a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when the Fragment's views should be destroyed. 227a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 228a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onDestroyView() 229a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 230a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchDestroyView() { 231a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchDestroyView(); 232a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 233a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 234a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 235a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Moves all Fragments managed by the controller's FragmentManager 236a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * into the destroy state. 237a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when Fragments should be destroyed. 238a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 239a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onDestroy() 240a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 241a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchDestroy() { 242a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchDestroy(); 243a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 244a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 245a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 2467c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * Lets all Fragments managed by the controller's FragmentManager know the multi-window mode of 2477c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * the activity changed. 2487c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * <p>Call when the multi-window mode of the activity changed. 2497c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * 2507c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * @see Fragment#onMultiWindowChanged 2517c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale */ 2527c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale public void dispatchMultiWindowChanged(boolean inMultiWindow) { 2537c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale mHost.mFragmentManager.dispatchMultiWindowChanged(inMultiWindow); 2547c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale } 2557c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale 2567c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale /** 2577c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * Lets all Fragments managed by the controller's FragmentManager know the picture-in-picture 2587c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * mode of the activity changed. 2597c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * <p>Call when the picture-in-picture mode of the activity changed. 2607c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * 2617c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale * @see Fragment#onPictureInPictureChanged 2627c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale */ 2637c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale public void dispatchPictureInPictureChanged(boolean inPictureInPicture) { 2647c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale mHost.mFragmentManager.dispatchPictureInPictureChanged(inPictureInPicture); 2657c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale } 2667c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale 2677c796811c040a3b9c189d49f138028c5e44466a4Wale Ogunwale /** 268a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets all Fragments managed by the controller's FragmentManager 269a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * know a configuration change occurred. 270a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when there is a configuration change. 271a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 272a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onConfigurationChanged(Configuration) 273a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 274a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchConfigurationChanged(Configuration newConfig) { 275a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchConfigurationChanged(newConfig); 276a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 277a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 278a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 279a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets all Fragments managed by the controller's FragmentManager 280a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * know the device is in a low memory condition. 281a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when the device is low on memory and Fragment's should trim 282a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * their memory usage. 283a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 284a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onLowMemory() 285a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 286a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchLowMemory() { 287a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchLowMemory(); 288a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 289a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 290a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 291a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets all Fragments managed by the controller's FragmentManager 292a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * know they should trim their memory usage. 293a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when the Fragment can release allocated memory [such as if 294a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * the Fragment is in the background]. 295a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 296a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onTrimMemory(int) 297a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 298a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchTrimMemory(int level) { 299a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchTrimMemory(level); 300a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 301a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 302a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 303a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets all Fragments managed by the controller's FragmentManager 304a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * know they should create an options menu. 305a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when the Fragment should create an options menu. 306a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 307a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @return {@code true} if the options menu contains items to display 308a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onCreateOptionsMenu(Menu, MenuInflater) 309a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 310a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public boolean dispatchCreateOptionsMenu(Menu menu, MenuInflater inflater) { 311a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.dispatchCreateOptionsMenu(menu, inflater); 312a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 313a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 314a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 315a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets all Fragments managed by the controller's FragmentManager 316a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * know they should prepare their options menu for display. 317a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call immediately before displaying the Fragment's options menu. 318a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 319a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @return {@code true} if the options menu contains items to display 320a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onPrepareOptionsMenu(Menu) 321a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 322a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public boolean dispatchPrepareOptionsMenu(Menu menu) { 323a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.dispatchPrepareOptionsMenu(menu); 324a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 325a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 326a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 327a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Sends an option item selection event to the Fragments managed by the 328a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * controller's FragmentManager. Once the event has been consumed, 329a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * no additional handling will be performed. 330a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call immediately after an options menu item has been selected 331a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 332a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @return {@code true} if the options menu selection event was consumed 333a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onOptionsItemSelected(MenuItem) 334a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 335a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public boolean dispatchOptionsItemSelected(MenuItem item) { 336a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.dispatchOptionsItemSelected(item); 337a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 338a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 339a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 340a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Sends a context item selection event to the Fragments managed by the 341a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * controller's FragmentManager. Once the event has been consumed, 342a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * no additional handling will be performed. 343a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call immediately after an options menu item has been selected 344a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 345a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @return {@code true} if the context menu selection event was consumed 346a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onContextItemSelected(MenuItem) 347a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 348a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public boolean dispatchContextItemSelected(MenuItem item) { 349a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.dispatchContextItemSelected(item); 350a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 351a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 352a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 353a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets all Fragments managed by the controller's FragmentManager 354a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * know their options menu has closed. 355a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call immediately after closing the Fragment's options menu. 356a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 357a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see Fragment#onOptionsMenuClosed(Menu) 358a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 359a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dispatchOptionsMenuClosed(Menu menu) { 360a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.mFragmentManager.dispatchOptionsMenuClosed(menu); 361a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 362a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 363a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 364a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Execute any pending actions for the Fragments managed by the 365a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * controller's FragmentManager. 366a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * <p>Call when queued actions can be performed [eg when the 367a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Fragment moves into a start or resume state]. 368a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @return {@code true} if queued actions were performed 369a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 370a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public boolean execPendingActions() { 371a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.mFragmentManager.execPendingActions(); 372a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 373a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 374a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 375a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Starts the loaders. 376a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 377a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void doLoaderStart() { 378a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.doLoaderStart(); 379a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 380a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 381a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 382a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Stops the loaders, optionally retaining their state. This is useful for keeping the 383a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * loader state across configuration changes. 384a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 385a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @param retain When {@code true}, the loaders aren't stopped, but, their instances 386a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * are retained in a started state 387a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 388a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void doLoaderStop(boolean retain) { 389a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.doLoaderStop(retain); 390a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 391a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 392a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 393a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Destroys the loaders and, if their state is not being retained, removes them. 394a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 395a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void doLoaderDestroy() { 396a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.doLoaderDestroy(); 397a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 398a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 399a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 400a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Lets the loaders know the host is ready to receive notifications. 401a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 402a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void reportLoaderStart() { 403a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.reportLoaderStart(); 404a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 405a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 406a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 407a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Returns a list of LoaderManagers that have opted to retain their instance across 408a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * configuration changes. 409a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 410a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public ArrayMap<String, LoaderManager> retainLoaderNonConfig() { 411a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy return mHost.retainLoaderNonConfig(); 412a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 413a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 414a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 415a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Restores the saved state for all LoaderManagers. The given LoaderManager list are 416a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * LoaderManager instances retained across configuration changes. 417a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * 418a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * @see #retainLoaderNonConfig() 419a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 420a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void restoreLoaderNonConfig(ArrayMap<String, LoaderManager> loaderManagers) { 421a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.restoreLoaderNonConfig(loaderManagers); 422a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 423a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy 424a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy /** 425a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy * Dumps the current state of the loaders. 426a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy */ 427a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy public void dumpLoaders(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { 428a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy mHost.dumpLoaders(prefix, fd, writer, args); 429a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy } 430a5fc6f006f67867417b7a427de6e7394c4312decTodd Kennedy} 431