Fragment.java revision b963c99c3a1d896c45587c997e5293738c0a8a80
1/* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.app; 18 19import android.animation.Animator; 20import android.annotation.NonNull; 21import android.annotation.Nullable; 22import android.annotation.StringRes; 23import android.content.ComponentCallbacks2; 24import android.content.Context; 25import android.content.Intent; 26import android.content.res.Configuration; 27import android.content.res.Resources; 28import android.content.res.TypedArray; 29import android.os.Build; 30import android.os.Bundle; 31import android.os.Parcel; 32import android.os.Parcelable; 33import android.transition.Transition; 34import android.transition.TransitionInflater; 35import android.transition.TransitionSet; 36import android.util.AndroidRuntimeException; 37import android.util.ArrayMap; 38import android.util.AttributeSet; 39import android.util.DebugUtils; 40import android.util.Log; 41import android.util.SparseArray; 42import android.util.SuperNotCalledException; 43import android.view.ContextMenu; 44import android.view.ContextMenu.ContextMenuInfo; 45import android.view.LayoutInflater; 46import android.view.Menu; 47import android.view.MenuInflater; 48import android.view.MenuItem; 49import android.view.View; 50import android.view.View.OnCreateContextMenuListener; 51import android.view.ViewGroup; 52import android.widget.AdapterView; 53 54import java.io.FileDescriptor; 55import java.io.PrintWriter; 56 57final class FragmentState implements Parcelable { 58 final String mClassName; 59 final int mIndex; 60 final boolean mFromLayout; 61 final int mFragmentId; 62 final int mContainerId; 63 final String mTag; 64 final boolean mRetainInstance; 65 final boolean mDetached; 66 final Bundle mArguments; 67 final boolean mHidden; 68 69 Bundle mSavedFragmentState; 70 71 Fragment mInstance; 72 73 public FragmentState(Fragment frag) { 74 mClassName = frag.getClass().getName(); 75 mIndex = frag.mIndex; 76 mFromLayout = frag.mFromLayout; 77 mFragmentId = frag.mFragmentId; 78 mContainerId = frag.mContainerId; 79 mTag = frag.mTag; 80 mRetainInstance = frag.mRetainInstance; 81 mDetached = frag.mDetached; 82 mArguments = frag.mArguments; 83 mHidden = frag.mHidden; 84 } 85 86 public FragmentState(Parcel in) { 87 mClassName = in.readString(); 88 mIndex = in.readInt(); 89 mFromLayout = in.readInt() != 0; 90 mFragmentId = in.readInt(); 91 mContainerId = in.readInt(); 92 mTag = in.readString(); 93 mRetainInstance = in.readInt() != 0; 94 mDetached = in.readInt() != 0; 95 mArguments = in.readBundle(); 96 mHidden = in.readInt() != 0; 97 mSavedFragmentState = in.readBundle(); 98 } 99 100 public Fragment instantiate(FragmentHostCallback host, Fragment parent, 101 FragmentManagerNonConfig childNonConfig) { 102 if (mInstance == null) { 103 final Context context = host.getContext(); 104 if (mArguments != null) { 105 mArguments.setClassLoader(context.getClassLoader()); 106 } 107 108 mInstance = Fragment.instantiate(context, mClassName, mArguments); 109 110 if (mSavedFragmentState != null) { 111 mSavedFragmentState.setClassLoader(context.getClassLoader()); 112 mInstance.mSavedFragmentState = mSavedFragmentState; 113 } 114 mInstance.setIndex(mIndex, parent); 115 mInstance.mFromLayout = mFromLayout; 116 mInstance.mRestored = true; 117 mInstance.mFragmentId = mFragmentId; 118 mInstance.mContainerId = mContainerId; 119 mInstance.mTag = mTag; 120 mInstance.mRetainInstance = mRetainInstance; 121 mInstance.mDetached = mDetached; 122 mInstance.mHidden = mHidden; 123 mInstance.mFragmentManager = host.mFragmentManager; 124 if (FragmentManagerImpl.DEBUG) Log.v(FragmentManagerImpl.TAG, 125 "Instantiated fragment " + mInstance); 126 } 127 mInstance.mChildNonConfig = childNonConfig; 128 return mInstance; 129 } 130 131 public int describeContents() { 132 return 0; 133 } 134 135 public void writeToParcel(Parcel dest, int flags) { 136 dest.writeString(mClassName); 137 dest.writeInt(mIndex); 138 dest.writeInt(mFromLayout ? 1 : 0); 139 dest.writeInt(mFragmentId); 140 dest.writeInt(mContainerId); 141 dest.writeString(mTag); 142 dest.writeInt(mRetainInstance ? 1 : 0); 143 dest.writeInt(mDetached ? 1 : 0); 144 dest.writeBundle(mArguments); 145 dest.writeInt(mHidden ? 1 : 0); 146 dest.writeBundle(mSavedFragmentState); 147 } 148 149 public static final Parcelable.Creator<FragmentState> CREATOR 150 = new Parcelable.Creator<FragmentState>() { 151 public FragmentState createFromParcel(Parcel in) { 152 return new FragmentState(in); 153 } 154 155 public FragmentState[] newArray(int size) { 156 return new FragmentState[size]; 157 } 158 }; 159} 160 161/** 162 * A Fragment is a piece of an application's user interface or behavior 163 * that can be placed in an {@link Activity}. Interaction with fragments 164 * is done through {@link FragmentManager}, which can be obtained via 165 * {@link Activity#getFragmentManager() Activity.getFragmentManager()} and 166 * {@link Fragment#getFragmentManager() Fragment.getFragmentManager()}. 167 * 168 * <p>The Fragment class can be used many ways to achieve a wide variety of 169 * results. In its core, it represents a particular operation or interface 170 * that is running within a larger {@link Activity}. A Fragment is closely 171 * tied to the Activity it is in, and can not be used apart from one. Though 172 * Fragment defines its own lifecycle, that lifecycle is dependent on its 173 * activity: if the activity is stopped, no fragments inside of it can be 174 * started; when the activity is destroyed, all fragments will be destroyed. 175 * 176 * <p>All subclasses of Fragment must include a public no-argument constructor. 177 * The framework will often re-instantiate a fragment class when needed, 178 * in particular during state restore, and needs to be able to find this 179 * constructor to instantiate it. If the no-argument constructor is not 180 * available, a runtime exception will occur in some cases during state 181 * restore. 182 * 183 * <p>Topics covered here: 184 * <ol> 185 * <li><a href="#OlderPlatforms">Older Platforms</a> 186 * <li><a href="#Lifecycle">Lifecycle</a> 187 * <li><a href="#Layout">Layout</a> 188 * <li><a href="#BackStack">Back Stack</a> 189 * </ol> 190 * 191 * <div class="special reference"> 192 * <h3>Developer Guides</h3> 193 * <p>For more information about using fragments, read the 194 * <a href="{@docRoot}guide/topics/fundamentals/fragments.html">Fragments</a> developer guide.</p> 195 * </div> 196 * 197 * <a name="OlderPlatforms"></a> 198 * <h3>Older Platforms</h3> 199 * 200 * While the Fragment API was introduced in 201 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, a version of the API 202 * at is also available for use on older platforms through 203 * {@link android.support.v4.app.FragmentActivity}. See the blog post 204 * <a href="http://android-developers.blogspot.com/2011/03/fragments-for-all.html"> 205 * Fragments For All</a> for more details. 206 * 207 * <a name="Lifecycle"></a> 208 * <h3>Lifecycle</h3> 209 * 210 * <p>Though a Fragment's lifecycle is tied to its owning activity, it has 211 * its own wrinkle on the standard activity lifecycle. It includes basic 212 * activity lifecycle methods such as {@link #onResume}, but also important 213 * are methods related to interactions with the activity and UI generation. 214 * 215 * <p>The core series of lifecycle methods that are called to bring a fragment 216 * up to resumed state (interacting with the user) are: 217 * 218 * <ol> 219 * <li> {@link #onAttach} called once the fragment is associated with its activity. 220 * <li> {@link #onCreate} called to do initial creation of the fragment. 221 * <li> {@link #onCreateView} creates and returns the view hierarchy associated 222 * with the fragment. 223 * <li> {@link #onActivityCreated} tells the fragment that its activity has 224 * completed its own {@link Activity#onCreate Activity.onCreate()}. 225 * <li> {@link #onViewStateRestored} tells the fragment that all of the saved 226 * state of its view hierarchy has been restored. 227 * <li> {@link #onStart} makes the fragment visible to the user (based on its 228 * containing activity being started). 229 * <li> {@link #onResume} makes the fragment begin interacting with the user 230 * (based on its containing activity being resumed). 231 * </ol> 232 * 233 * <p>As a fragment is no longer being used, it goes through a reverse 234 * series of callbacks: 235 * 236 * <ol> 237 * <li> {@link #onPause} fragment is no longer interacting with the user either 238 * because its activity is being paused or a fragment operation is modifying it 239 * in the activity. 240 * <li> {@link #onStop} fragment is no longer visible to the user either 241 * because its activity is being stopped or a fragment operation is modifying it 242 * in the activity. 243 * <li> {@link #onDestroyView} allows the fragment to clean up resources 244 * associated with its View. 245 * <li> {@link #onDestroy} called to do final cleanup of the fragment's state. 246 * <li> {@link #onDetach} called immediately prior to the fragment no longer 247 * being associated with its activity. 248 * </ol> 249 * 250 * <a name="Layout"></a> 251 * <h3>Layout</h3> 252 * 253 * <p>Fragments can be used as part of your application's layout, allowing 254 * you to better modularize your code and more easily adjust your user 255 * interface to the screen it is running on. As an example, we can look 256 * at a simple program consisting of a list of items, and display of the 257 * details of each item.</p> 258 * 259 * <p>An activity's layout XML can include <code><fragment></code> tags 260 * to embed fragment instances inside of the layout. For example, here is 261 * a simple layout that embeds one fragment:</p> 262 * 263 * {@sample development/samples/ApiDemos/res/layout/fragment_layout.xml layout} 264 * 265 * <p>The layout is installed in the activity in the normal way:</p> 266 * 267 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentLayout.java 268 * main} 269 * 270 * <p>The titles fragment, showing a list of titles, is fairly simple, relying 271 * on {@link ListFragment} for most of its work. Note the implementation of 272 * clicking an item: depending on the current activity's layout, it can either 273 * create and display a new fragment to show the details in-place (more about 274 * this later), or start a new activity to show the details.</p> 275 * 276 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentLayout.java 277 * titles} 278 * 279 * <p>The details fragment showing the contents of a selected item just 280 * displays a string of text based on an index of a string array built in to 281 * the app:</p> 282 * 283 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentLayout.java 284 * details} 285 * 286 * <p>In this case when the user clicks on a title, there is no details 287 * container in the current activity, so the titles fragment's click code will 288 * launch a new activity to display the details fragment:</p> 289 * 290 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentLayout.java 291 * details_activity} 292 * 293 * <p>However the screen may be large enough to show both the list of titles 294 * and details about the currently selected title. To use such a layout on 295 * a landscape screen, this alternative layout can be placed under layout-land:</p> 296 * 297 * {@sample development/samples/ApiDemos/res/layout-land/fragment_layout.xml layout} 298 * 299 * <p>Note how the prior code will adjust to this alternative UI flow: the titles 300 * fragment will now embed the details fragment inside of this activity, and the 301 * details activity will finish itself if it is running in a configuration 302 * where the details can be shown in-place. 303 * 304 * <p>When a configuration change causes the activity hosting these fragments 305 * to restart, its new instance may use a different layout that doesn't 306 * include the same fragments as the previous layout. In this case all of 307 * the previous fragments will still be instantiated and running in the new 308 * instance. However, any that are no longer associated with a <fragment> 309 * tag in the view hierarchy will not have their content view created 310 * and will return false from {@link #isInLayout}. (The code here also shows 311 * how you can determine if a fragment placed in a container is no longer 312 * running in a layout with that container and avoid creating its view hierarchy 313 * in that case.) 314 * 315 * <p>The attributes of the <fragment> tag are used to control the 316 * LayoutParams provided when attaching the fragment's view to the parent 317 * container. They can also be parsed by the fragment in {@link #onInflate} 318 * as parameters. 319 * 320 * <p>The fragment being instantiated must have some kind of unique identifier 321 * so that it can be re-associated with a previous instance if the parent 322 * activity needs to be destroyed and recreated. This can be provided these 323 * ways: 324 * 325 * <ul> 326 * <li>If nothing is explicitly supplied, the view ID of the container will 327 * be used. 328 * <li><code>android:tag</code> can be used in <fragment> to provide 329 * a specific tag name for the fragment. 330 * <li><code>android:id</code> can be used in <fragment> to provide 331 * a specific identifier for the fragment. 332 * </ul> 333 * 334 * <a name="BackStack"></a> 335 * <h3>Back Stack</h3> 336 * 337 * <p>The transaction in which fragments are modified can be placed on an 338 * internal back-stack of the owning activity. When the user presses back 339 * in the activity, any transactions on the back stack are popped off before 340 * the activity itself is finished. 341 * 342 * <p>For example, consider this simple fragment that is instantiated with 343 * an integer argument and displays that in a TextView in its UI:</p> 344 * 345 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentStack.java 346 * fragment} 347 * 348 * <p>A function that creates a new instance of the fragment, replacing 349 * whatever current fragment instance is being shown and pushing that change 350 * on to the back stack could be written as: 351 * 352 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentStack.java 353 * add_stack} 354 * 355 * <p>After each call to this function, a new entry is on the stack, and 356 * pressing back will pop it to return the user to whatever previous state 357 * the activity UI was in. 358 */ 359public class Fragment implements ComponentCallbacks2, OnCreateContextMenuListener { 360 private static final ArrayMap<String, Class<?>> sClassMap = 361 new ArrayMap<String, Class<?>>(); 362 363 static final int INVALID_STATE = -1; // Invalid state used as a null value. 364 static final int INITIALIZING = 0; // Not yet created. 365 static final int CREATED = 1; // Created. 366 static final int ACTIVITY_CREATED = 2; // The activity has finished its creation. 367 static final int STOPPED = 3; // Fully created, not started. 368 static final int STARTED = 4; // Created and started, not resumed. 369 static final int RESUMED = 5; // Created started and resumed. 370 371 private static final Transition USE_DEFAULT_TRANSITION = new TransitionSet(); 372 373 int mState = INITIALIZING; 374 375 // Non-null if the fragment's view hierarchy is currently animating away, 376 // meaning we need to wait a bit on completely destroying it. This is the 377 // animation that is running. 378 Animator mAnimatingAway; 379 380 // If mAnimatingAway != null, this is the state we should move to once the 381 // animation is done. 382 int mStateAfterAnimating; 383 384 // When instantiated from saved state, this is the saved state. 385 Bundle mSavedFragmentState; 386 SparseArray<Parcelable> mSavedViewState; 387 388 // Index into active fragment array. 389 int mIndex = -1; 390 391 // Internal unique name for this fragment; 392 String mWho; 393 394 // Construction arguments; 395 Bundle mArguments; 396 397 // Target fragment. 398 Fragment mTarget; 399 400 // For use when retaining a fragment: this is the index of the last mTarget. 401 int mTargetIndex = -1; 402 403 // Target request code. 404 int mTargetRequestCode; 405 406 // True if the fragment is in the list of added fragments. 407 boolean mAdded; 408 409 // If set this fragment is being removed from its activity. 410 boolean mRemoving; 411 412 // Set to true if this fragment was instantiated from a layout file. 413 boolean mFromLayout; 414 415 // Set to true when the view has actually been inflated in its layout. 416 boolean mInLayout; 417 418 // True if this fragment has been restored from previously saved state. 419 boolean mRestored; 420 421 // Number of active back stack entries this fragment is in. 422 int mBackStackNesting; 423 424 // The fragment manager we are associated with. Set as soon as the 425 // fragment is used in a transaction; cleared after it has been removed 426 // from all transactions. 427 FragmentManagerImpl mFragmentManager; 428 429 // Activity this fragment is attached to. 430 FragmentHostCallback mHost; 431 432 // Private fragment manager for child fragments inside of this one. 433 FragmentManagerImpl mChildFragmentManager; 434 435 // For use when restoring fragment state and descendant fragments are retained. 436 // This state is set by FragmentState.instantiate and cleared in onCreate. 437 FragmentManagerNonConfig mChildNonConfig; 438 439 // If this Fragment is contained in another Fragment, this is that container. 440 Fragment mParentFragment; 441 442 // The optional identifier for this fragment -- either the container ID if it 443 // was dynamically added to the view hierarchy, or the ID supplied in 444 // layout. 445 int mFragmentId; 446 447 // When a fragment is being dynamically added to the view hierarchy, this 448 // is the identifier of the parent container it is being added to. 449 int mContainerId; 450 451 // The optional named tag for this fragment -- usually used to find 452 // fragments that are not part of the layout. 453 String mTag; 454 455 // Set to true when the app has requested that this fragment be hidden 456 // from the user. 457 boolean mHidden; 458 459 // Set to true when the app has requested that this fragment be detached. 460 boolean mDetached; 461 462 // If set this fragment would like its instance retained across 463 // configuration changes. 464 boolean mRetainInstance; 465 466 // If set this fragment is being retained across the current config change. 467 boolean mRetaining; 468 469 // If set this fragment has menu items to contribute. 470 boolean mHasMenu; 471 472 // Set to true to allow the fragment's menu to be shown. 473 boolean mMenuVisible = true; 474 475 // Used to verify that subclasses call through to super class. 476 boolean mCalled; 477 478 // If app has requested a specific animation, this is the one to use. 479 int mNextAnim; 480 481 // The parent container of the fragment after dynamically added to UI. 482 ViewGroup mContainer; 483 484 // The View generated for this fragment. 485 View mView; 486 487 // Whether this fragment should defer starting until after other fragments 488 // have been started and their loaders are finished. 489 boolean mDeferStart; 490 491 // Hint provided by the app that this fragment is currently visible to the user. 492 boolean mUserVisibleHint = true; 493 494 LoaderManagerImpl mLoaderManager; 495 boolean mLoadersStarted; 496 boolean mCheckedForLoaderManager; 497 498 private Transition mEnterTransition = null; 499 private Transition mReturnTransition = USE_DEFAULT_TRANSITION; 500 private Transition mExitTransition = null; 501 private Transition mReenterTransition = USE_DEFAULT_TRANSITION; 502 private Transition mSharedElementEnterTransition = null; 503 private Transition mSharedElementReturnTransition = USE_DEFAULT_TRANSITION; 504 private Boolean mAllowReturnTransitionOverlap; 505 private Boolean mAllowEnterTransitionOverlap; 506 507 SharedElementCallback mEnterTransitionCallback = SharedElementCallback.NULL_CALLBACK; 508 SharedElementCallback mExitTransitionCallback = SharedElementCallback.NULL_CALLBACK; 509 510 /** 511 * State information that has been retrieved from a fragment instance 512 * through {@link FragmentManager#saveFragmentInstanceState(Fragment) 513 * FragmentManager.saveFragmentInstanceState}. 514 */ 515 public static class SavedState implements Parcelable { 516 final Bundle mState; 517 518 SavedState(Bundle state) { 519 mState = state; 520 } 521 522 SavedState(Parcel in, ClassLoader loader) { 523 mState = in.readBundle(); 524 if (loader != null && mState != null) { 525 mState.setClassLoader(loader); 526 } 527 } 528 529 @Override 530 public int describeContents() { 531 return 0; 532 } 533 534 @Override 535 public void writeToParcel(Parcel dest, int flags) { 536 dest.writeBundle(mState); 537 } 538 539 public static final Parcelable.ClassLoaderCreator<SavedState> CREATOR 540 = new Parcelable.ClassLoaderCreator<SavedState>() { 541 public SavedState createFromParcel(Parcel in) { 542 return new SavedState(in, null); 543 } 544 545 public SavedState createFromParcel(Parcel in, ClassLoader loader) { 546 return new SavedState(in, loader); 547 } 548 549 public SavedState[] newArray(int size) { 550 return new SavedState[size]; 551 } 552 }; 553 } 554 555 /** 556 * Thrown by {@link Fragment#instantiate(Context, String, Bundle)} when 557 * there is an instantiation failure. 558 */ 559 static public class InstantiationException extends AndroidRuntimeException { 560 public InstantiationException(String msg, Exception cause) { 561 super(msg, cause); 562 } 563 } 564 565 /** 566 * Default constructor. <strong>Every</strong> fragment must have an 567 * empty constructor, so it can be instantiated when restoring its 568 * activity's state. It is strongly recommended that subclasses do not 569 * have other constructors with parameters, since these constructors 570 * will not be called when the fragment is re-instantiated; instead, 571 * arguments can be supplied by the caller with {@link #setArguments} 572 * and later retrieved by the Fragment with {@link #getArguments}. 573 * 574 * <p>Applications should generally not implement a constructor. The 575 * first place application code can run where the fragment is ready to 576 * be used is in {@link #onAttach(Activity)}, the point where the fragment 577 * is actually associated with its activity. Some applications may also 578 * want to implement {@link #onInflate} to retrieve attributes from a 579 * layout resource, though should take care here because this happens for 580 * the fragment is attached to its activity. 581 */ 582 public Fragment() { 583 } 584 585 /** 586 * Like {@link #instantiate(Context, String, Bundle)} but with a null 587 * argument Bundle. 588 */ 589 public static Fragment instantiate(Context context, String fname) { 590 return instantiate(context, fname, null); 591 } 592 593 /** 594 * Create a new instance of a Fragment with the given class name. This is 595 * the same as calling its empty constructor. 596 * 597 * @param context The calling context being used to instantiate the fragment. 598 * This is currently just used to get its ClassLoader. 599 * @param fname The class name of the fragment to instantiate. 600 * @param args Bundle of arguments to supply to the fragment, which it 601 * can retrieve with {@link #getArguments()}. May be null. 602 * @return Returns a new fragment instance. 603 * @throws InstantiationException If there is a failure in instantiating 604 * the given fragment class. This is a runtime exception; it is not 605 * normally expected to happen. 606 */ 607 public static Fragment instantiate(Context context, String fname, @Nullable Bundle args) { 608 try { 609 Class<?> clazz = sClassMap.get(fname); 610 if (clazz == null) { 611 // Class not found in the cache, see if it's real, and try to add it 612 clazz = context.getClassLoader().loadClass(fname); 613 if (!Fragment.class.isAssignableFrom(clazz)) { 614 throw new InstantiationException("Trying to instantiate a class " + fname 615 + " that is not a Fragment", new ClassCastException()); 616 } 617 sClassMap.put(fname, clazz); 618 } 619 Fragment f = (Fragment)clazz.newInstance(); 620 if (args != null) { 621 args.setClassLoader(f.getClass().getClassLoader()); 622 f.mArguments = args; 623 } 624 return f; 625 } catch (ClassNotFoundException e) { 626 throw new InstantiationException("Unable to instantiate fragment " + fname 627 + ": make sure class name exists, is public, and has an" 628 + " empty constructor that is public", e); 629 } catch (java.lang.InstantiationException e) { 630 throw new InstantiationException("Unable to instantiate fragment " + fname 631 + ": make sure class name exists, is public, and has an" 632 + " empty constructor that is public", e); 633 } catch (IllegalAccessException e) { 634 throw new InstantiationException("Unable to instantiate fragment " + fname 635 + ": make sure class name exists, is public, and has an" 636 + " empty constructor that is public", e); 637 } 638 } 639 640 final void restoreViewState(Bundle savedInstanceState) { 641 if (mSavedViewState != null) { 642 mView.restoreHierarchyState(mSavedViewState); 643 mSavedViewState = null; 644 } 645 mCalled = false; 646 onViewStateRestored(savedInstanceState); 647 if (!mCalled) { 648 throw new SuperNotCalledException("Fragment " + this 649 + " did not call through to super.onViewStateRestored()"); 650 } 651 } 652 653 final void setIndex(int index, Fragment parent) { 654 mIndex = index; 655 if (parent != null) { 656 mWho = parent.mWho + ":" + mIndex; 657 } else { 658 mWho = "android:fragment:" + mIndex; 659 } 660 } 661 662 final boolean isInBackStack() { 663 return mBackStackNesting > 0; 664 } 665 666 /** 667 * Subclasses can not override equals(). 668 */ 669 @Override final public boolean equals(Object o) { 670 return super.equals(o); 671 } 672 673 /** 674 * Subclasses can not override hashCode(). 675 */ 676 @Override final public int hashCode() { 677 return super.hashCode(); 678 } 679 680 @Override 681 public String toString() { 682 StringBuilder sb = new StringBuilder(128); 683 DebugUtils.buildShortClassTag(this, sb); 684 if (mIndex >= 0) { 685 sb.append(" #"); 686 sb.append(mIndex); 687 } 688 if (mFragmentId != 0) { 689 sb.append(" id=0x"); 690 sb.append(Integer.toHexString(mFragmentId)); 691 } 692 if (mTag != null) { 693 sb.append(" "); 694 sb.append(mTag); 695 } 696 sb.append('}'); 697 return sb.toString(); 698 } 699 700 /** 701 * Return the identifier this fragment is known by. This is either 702 * the android:id value supplied in a layout or the container view ID 703 * supplied when adding the fragment. 704 */ 705 final public int getId() { 706 return mFragmentId; 707 } 708 709 /** 710 * Get the tag name of the fragment, if specified. 711 */ 712 final public String getTag() { 713 return mTag; 714 } 715 716 /** 717 * Supply the construction arguments for this fragment. This can only 718 * be called before the fragment has been attached to its activity; that 719 * is, you should call it immediately after constructing the fragment. The 720 * arguments supplied here will be retained across fragment destroy and 721 * creation. 722 */ 723 public void setArguments(Bundle args) { 724 if (mIndex >= 0) { 725 throw new IllegalStateException("Fragment already active"); 726 } 727 mArguments = args; 728 } 729 730 /** 731 * Return the arguments supplied to {@link #setArguments}, if any. 732 */ 733 final public Bundle getArguments() { 734 return mArguments; 735 } 736 737 /** 738 * Set the initial saved state that this Fragment should restore itself 739 * from when first being constructed, as returned by 740 * {@link FragmentManager#saveFragmentInstanceState(Fragment) 741 * FragmentManager.saveFragmentInstanceState}. 742 * 743 * @param state The state the fragment should be restored from. 744 */ 745 public void setInitialSavedState(SavedState state) { 746 if (mIndex >= 0) { 747 throw new IllegalStateException("Fragment already active"); 748 } 749 mSavedFragmentState = state != null && state.mState != null 750 ? state.mState : null; 751 } 752 753 /** 754 * Optional target for this fragment. This may be used, for example, 755 * if this fragment is being started by another, and when done wants to 756 * give a result back to the first. The target set here is retained 757 * across instances via {@link FragmentManager#putFragment 758 * FragmentManager.putFragment()}. 759 * 760 * @param fragment The fragment that is the target of this one. 761 * @param requestCode Optional request code, for convenience if you 762 * are going to call back with {@link #onActivityResult(int, int, Intent)}. 763 */ 764 public void setTargetFragment(Fragment fragment, int requestCode) { 765 mTarget = fragment; 766 mTargetRequestCode = requestCode; 767 } 768 769 /** 770 * Return the target fragment set by {@link #setTargetFragment}. 771 */ 772 final public Fragment getTargetFragment() { 773 return mTarget; 774 } 775 776 /** 777 * Return the target request code set by {@link #setTargetFragment}. 778 */ 779 final public int getTargetRequestCode() { 780 return mTargetRequestCode; 781 } 782 783 /** 784 * Return the {@link Context} this fragment is currently associated with. 785 */ 786 public Context getContext() { 787 return mHost == null ? null : mHost.getContext(); 788 } 789 790 /** 791 * Return the Activity this fragment is currently associated with. 792 */ 793 final public Activity getActivity() { 794 return mHost == null ? null : mHost.getActivity(); 795 } 796 797 /** 798 * Return the host object of this fragment. May return {@code null} if the fragment 799 * isn't currently being hosted. 800 */ 801 @Nullable 802 final public Object getHost() { 803 return mHost == null ? null : mHost.onGetHost(); 804 } 805 806 /** 807 * Return <code>getActivity().getResources()</code>. 808 */ 809 final public Resources getResources() { 810 if (mHost == null) { 811 throw new IllegalStateException("Fragment " + this + " not attached to Activity"); 812 } 813 return mHost.getContext().getResources(); 814 } 815 816 /** 817 * Return a localized, styled CharSequence from the application's package's 818 * default string table. 819 * 820 * @param resId Resource id for the CharSequence text 821 */ 822 public final CharSequence getText(@StringRes int resId) { 823 return getResources().getText(resId); 824 } 825 826 /** 827 * Return a localized string from the application's package's 828 * default string table. 829 * 830 * @param resId Resource id for the string 831 */ 832 public final String getString(@StringRes int resId) { 833 return getResources().getString(resId); 834 } 835 836 /** 837 * Return a localized formatted string from the application's package's 838 * default string table, substituting the format arguments as defined in 839 * {@link java.util.Formatter} and {@link java.lang.String#format}. 840 * 841 * @param resId Resource id for the format string 842 * @param formatArgs The format arguments that will be used for substitution. 843 */ 844 845 public final String getString(@StringRes int resId, Object... formatArgs) { 846 return getResources().getString(resId, formatArgs); 847 } 848 849 /** 850 * Return the FragmentManager for interacting with fragments associated 851 * with this fragment's activity. Note that this will be non-null slightly 852 * before {@link #getActivity()}, during the time from when the fragment is 853 * placed in a {@link FragmentTransaction} until it is committed and 854 * attached to its activity. 855 * 856 * <p>If this Fragment is a child of another Fragment, the FragmentManager 857 * returned here will be the parent's {@link #getChildFragmentManager()}. 858 */ 859 final public FragmentManager getFragmentManager() { 860 return mFragmentManager; 861 } 862 863 /** 864 * Return a private FragmentManager for placing and managing Fragments 865 * inside of this Fragment. 866 */ 867 final public FragmentManager getChildFragmentManager() { 868 if (mChildFragmentManager == null) { 869 instantiateChildFragmentManager(); 870 if (mState >= RESUMED) { 871 mChildFragmentManager.dispatchResume(); 872 } else if (mState >= STARTED) { 873 mChildFragmentManager.dispatchStart(); 874 } else if (mState >= ACTIVITY_CREATED) { 875 mChildFragmentManager.dispatchActivityCreated(); 876 } else if (mState >= CREATED) { 877 mChildFragmentManager.dispatchCreate(); 878 } 879 } 880 return mChildFragmentManager; 881 } 882 883 /** 884 * Returns the parent Fragment containing this Fragment. If this Fragment 885 * is attached directly to an Activity, returns null. 886 */ 887 final public Fragment getParentFragment() { 888 return mParentFragment; 889 } 890 891 /** 892 * Return true if the fragment is currently added to its activity. 893 */ 894 final public boolean isAdded() { 895 return mHost != null && mAdded; 896 } 897 898 /** 899 * Return true if the fragment has been explicitly detached from the UI. 900 * That is, {@link FragmentTransaction#detach(Fragment) 901 * FragmentTransaction.detach(Fragment)} has been used on it. 902 */ 903 final public boolean isDetached() { 904 return mDetached; 905 } 906 907 /** 908 * Return true if this fragment is currently being removed from its 909 * activity. This is <em>not</em> whether its activity is finishing, but 910 * rather whether it is in the process of being removed from its activity. 911 */ 912 final public boolean isRemoving() { 913 return mRemoving; 914 } 915 916 /** 917 * Return true if the layout is included as part of an activity view 918 * hierarchy via the <fragment> tag. This will always be true when 919 * fragments are created through the <fragment> tag, <em>except</em> 920 * in the case where an old fragment is restored from a previous state and 921 * it does not appear in the layout of the current state. 922 */ 923 final public boolean isInLayout() { 924 return mInLayout; 925 } 926 927 /** 928 * Return true if the fragment is in the resumed state. This is true 929 * for the duration of {@link #onResume()} and {@link #onPause()} as well. 930 */ 931 final public boolean isResumed() { 932 return mState >= RESUMED; 933 } 934 935 /** 936 * Return true if the fragment is currently visible to the user. This means 937 * it: (1) has been added, (2) has its view attached to the window, and 938 * (3) is not hidden. 939 */ 940 final public boolean isVisible() { 941 return isAdded() && !isHidden() && mView != null 942 && mView.getWindowToken() != null && mView.getVisibility() == View.VISIBLE; 943 } 944 945 /** 946 * Return true if the fragment has been hidden. By default fragments 947 * are shown. You can find out about changes to this state with 948 * {@link #onHiddenChanged}. Note that the hidden state is orthogonal 949 * to other states -- that is, to be visible to the user, a fragment 950 * must be both started and not hidden. 951 */ 952 final public boolean isHidden() { 953 return mHidden; 954 } 955 956 /** 957 * Called when the hidden state (as returned by {@link #isHidden()} of 958 * the fragment has changed. Fragments start out not hidden; this will 959 * be called whenever the fragment changes state from that. 960 * @param hidden True if the fragment is now hidden, false if it is not 961 * visible. 962 */ 963 public void onHiddenChanged(boolean hidden) { 964 } 965 966 /** 967 * Control whether a fragment instance is retained across Activity 968 * re-creation (such as from a configuration change). This can only 969 * be used with fragments not in the back stack. If set, the fragment 970 * lifecycle will be slightly different when an activity is recreated: 971 * <ul> 972 * <li> {@link #onDestroy()} will not be called (but {@link #onDetach()} still 973 * will be, because the fragment is being detached from its current activity). 974 * <li> {@link #onCreate(Bundle)} will not be called since the fragment 975 * is not being re-created. 976 * <li> {@link #onAttach(Activity)} and {@link #onActivityCreated(Bundle)} <b>will</b> 977 * still be called. 978 * </ul> 979 */ 980 public void setRetainInstance(boolean retain) { 981 mRetainInstance = retain; 982 } 983 984 final public boolean getRetainInstance() { 985 return mRetainInstance; 986 } 987 988 /** 989 * Report that this fragment would like to participate in populating 990 * the options menu by receiving a call to {@link #onCreateOptionsMenu} 991 * and related methods. 992 * 993 * @param hasMenu If true, the fragment has menu items to contribute. 994 */ 995 public void setHasOptionsMenu(boolean hasMenu) { 996 if (mHasMenu != hasMenu) { 997 mHasMenu = hasMenu; 998 if (isAdded() && !isHidden()) { 999 mFragmentManager.invalidateOptionsMenu(); 1000 } 1001 } 1002 } 1003 1004 /** 1005 * Set a hint for whether this fragment's menu should be visible. This 1006 * is useful if you know that a fragment has been placed in your view 1007 * hierarchy so that the user can not currently seen it, so any menu items 1008 * it has should also not be shown. 1009 * 1010 * @param menuVisible The default is true, meaning the fragment's menu will 1011 * be shown as usual. If false, the user will not see the menu. 1012 */ 1013 public void setMenuVisibility(boolean menuVisible) { 1014 if (mMenuVisible != menuVisible) { 1015 mMenuVisible = menuVisible; 1016 if (mHasMenu && isAdded() && !isHidden()) { 1017 mFragmentManager.invalidateOptionsMenu(); 1018 } 1019 } 1020 } 1021 1022 /** 1023 * Set a hint to the system about whether this fragment's UI is currently visible 1024 * to the user. This hint defaults to true and is persistent across fragment instance 1025 * state save and restore. 1026 * 1027 * <p>An app may set this to false to indicate that the fragment's UI is 1028 * scrolled out of visibility or is otherwise not directly visible to the user. 1029 * This may be used by the system to prioritize operations such as fragment lifecycle updates 1030 * or loader ordering behavior.</p> 1031 * 1032 * @param isVisibleToUser true if this fragment's UI is currently visible to the user (default), 1033 * false if it is not. 1034 */ 1035 public void setUserVisibleHint(boolean isVisibleToUser) { 1036 if (!mUserVisibleHint && isVisibleToUser && mState < STARTED && isAdded()) { 1037 mFragmentManager.performPendingDeferredStart(this); 1038 } 1039 mUserVisibleHint = isVisibleToUser; 1040 mDeferStart = mState < STARTED && !isVisibleToUser; 1041 } 1042 1043 /** 1044 * @return The current value of the user-visible hint on this fragment. 1045 * @see #setUserVisibleHint(boolean) 1046 */ 1047 public boolean getUserVisibleHint() { 1048 return mUserVisibleHint; 1049 } 1050 1051 /** 1052 * Return the LoaderManager for this fragment, creating it if needed. 1053 */ 1054 public LoaderManager getLoaderManager() { 1055 if (mLoaderManager != null) { 1056 return mLoaderManager; 1057 } 1058 if (mHost == null) { 1059 throw new IllegalStateException("Fragment " + this + " not attached to Activity"); 1060 } 1061 mCheckedForLoaderManager = true; 1062 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, true); 1063 return mLoaderManager; 1064 } 1065 1066 /** 1067 * Call {@link Activity#startActivity(Intent)} from the fragment's 1068 * containing Activity. 1069 * 1070 * @param intent The intent to start. 1071 */ 1072 public void startActivity(Intent intent) { 1073 startActivity(intent, null); 1074 } 1075 1076 /** 1077 * Call {@link Activity#startActivity(Intent, Bundle)} from the fragment's 1078 * containing Activity. 1079 * 1080 * @param intent The intent to start. 1081 * @param options Additional options for how the Activity should be started. 1082 * See {@link android.content.Context#startActivity(Intent, Bundle) 1083 * Context.startActivity(Intent, Bundle)} for more details. 1084 */ 1085 public void startActivity(Intent intent, Bundle options) { 1086 if (mHost == null) { 1087 throw new IllegalStateException("Fragment " + this + " not attached to Activity"); 1088 } 1089 if (options != null) { 1090 mHost.onStartActivityFromFragment(this, intent, -1, options); 1091 } else { 1092 // Note we want to go through this call for compatibility with 1093 // applications that may have overridden the method. 1094 mHost.onStartActivityFromFragment(this, intent, -1, null /*options*/); 1095 } 1096 } 1097 1098 /** 1099 * Call {@link Activity#startActivityForResult(Intent, int)} from the fragment's 1100 * containing Activity. 1101 */ 1102 public void startActivityForResult(Intent intent, int requestCode) { 1103 startActivityForResult(intent, requestCode, null); 1104 } 1105 1106 /** 1107 * Call {@link Activity#startActivityForResult(Intent, int, Bundle)} from the fragment's 1108 * containing Activity. 1109 */ 1110 public void startActivityForResult(Intent intent, int requestCode, Bundle options) { 1111 if (mHost == null) { 1112 throw new IllegalStateException("Fragment " + this + " not attached to Activity"); 1113 } 1114 mHost.onStartActivityFromFragment(this, intent, requestCode, options); 1115 } 1116 1117 /** 1118 * Receive the result from a previous call to 1119 * {@link #startActivityForResult(Intent, int)}. This follows the 1120 * related Activity API as described there in 1121 * {@link Activity#onActivityResult(int, int, Intent)}. 1122 * 1123 * @param requestCode The integer request code originally supplied to 1124 * startActivityForResult(), allowing you to identify who this 1125 * result came from. 1126 * @param resultCode The integer result code returned by the child activity 1127 * through its setResult(). 1128 * @param data An Intent, which can return result data to the caller 1129 * (various data can be attached to Intent "extras"). 1130 */ 1131 public void onActivityResult(int requestCode, int resultCode, Intent data) { 1132 } 1133 1134 /** 1135 * Requests permissions to be granted to this application. These permissions 1136 * must be requested in your manifest, they should not be granted to your app, 1137 * and they should have protection level {@link android.content.pm.PermissionInfo 1138 * #PROTECTION_DANGEROUS dangerous}, regardless whether they are declared by 1139 * the platform or a third-party app. 1140 * <p> 1141 * Normal permissions {@link android.content.pm.PermissionInfo#PROTECTION_NORMAL} 1142 * are granted at install time if requested in the manifest. Signature permissions 1143 * {@link android.content.pm.PermissionInfo#PROTECTION_SIGNATURE} are granted at 1144 * install time if requested in the manifest and the signature of your app matches 1145 * the signature of the app declaring the permissions. 1146 * </p> 1147 * <p> 1148 * If your app does not have the requested permissions the user will be presented 1149 * with UI for accepting them. After the user has accepted or rejected the 1150 * requested permissions you will receive a callback on {@link 1151 * #onRequestPermissionsResult(int, String[], int[])} reporting whether the 1152 * permissions were granted or not. 1153 * </p> 1154 * <p> 1155 * Note that requesting a permission does not guarantee it will be granted and 1156 * your app should be able to run without having this permission. 1157 * </p> 1158 * <p> 1159 * This method may start an activity allowing the user to choose which permissions 1160 * to grant and which to reject. Hence, you should be prepared that your activity 1161 * may be paused and resumed. Further, granting some permissions may require 1162 * a restart of you application. In such a case, the system will recreate the 1163 * activity stack before delivering the result to {@link 1164 * #onRequestPermissionsResult(int, String[], int[])}. 1165 * </p> 1166 * <p> 1167 * When checking whether you have a permission you should use {@link 1168 * android.content.Context#checkSelfPermission(String)}. 1169 * </p> 1170 * <p> 1171 * Calling this API for permissions already granted to your app would show UI 1172 * to the user to decide whether the app can still hold these permissions. This 1173 * can be useful if the way your app uses data guarded by the permissions 1174 * changes significantly. 1175 * </p> 1176 * <p> 1177 * You cannot request a permission if your activity sets {@link 1178 * android.R.styleable#AndroidManifestActivity_noHistory noHistory} to 1179 * <code>true</code> because in this case the activity would not receive 1180 * result callbacks including {@link #onRequestPermissionsResult(int, String[], int[])}. 1181 * </p> 1182 * <p> 1183 * A sample permissions request looks like this: 1184 * </p> 1185 * <code><pre><p> 1186 * private void showContacts() { 1187 * if (getActivity().checkSelfPermission(Manifest.permission.READ_CONTACTS) 1188 * != PackageManager.PERMISSION_GRANTED) { 1189 * requestPermissions(new String[]{Manifest.permission.READ_CONTACTS}, 1190 * PERMISSIONS_REQUEST_READ_CONTACTS); 1191 * } else { 1192 * doShowContacts(); 1193 * } 1194 * } 1195 * 1196 * {@literal @}Override 1197 * public void onRequestPermissionsResult(int requestCode, String[] permissions, 1198 * int[] grantResults) { 1199 * if (requestCode == PERMISSIONS_REQUEST_READ_CONTACTS 1200 * && grantResults[0] == PackageManager.PERMISSION_GRANTED) { 1201 * doShowContacts(); 1202 * } 1203 * } 1204 * </code></pre></p> 1205 * 1206 * @param permissions The requested permissions. Must me non-null and not empty. 1207 * @param requestCode Application specific request code to match with a result 1208 * reported to {@link #onRequestPermissionsResult(int, String[], int[])}. 1209 * Should be >= 0. 1210 * 1211 * @see #onRequestPermissionsResult(int, String[], int[]) 1212 * @see android.content.Context#checkSelfPermission(String) 1213 */ 1214 public final void requestPermissions(@NonNull String[] permissions, int requestCode) { 1215 if (mHost == null) { 1216 throw new IllegalStateException("Fragment " + this + " not attached to Activity"); 1217 } 1218 mHost.onRequestPermissionsFromFragment(this, permissions,requestCode); 1219 } 1220 1221 /** 1222 * Callback for the result from requesting permissions. This method 1223 * is invoked for every call on {@link #requestPermissions(String[], int)}. 1224 * <p> 1225 * <strong>Note:</strong> It is possible that the permissions request interaction 1226 * with the user is interrupted. In this case you will receive empty permissions 1227 * and results arrays which should be treated as a cancellation. 1228 * </p> 1229 * 1230 * @param requestCode The request code passed in {@link #requestPermissions(String[], int)}. 1231 * @param permissions The requested permissions. Never null. 1232 * @param grantResults The grant results for the corresponding permissions 1233 * which is either {@link android.content.pm.PackageManager#PERMISSION_GRANTED} 1234 * or {@link android.content.pm.PackageManager#PERMISSION_DENIED}. Never null. 1235 * 1236 * @see #requestPermissions(String[], int) 1237 */ 1238 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, 1239 @NonNull int[] grantResults) { 1240 /* callback - do nothing */ 1241 } 1242 1243 /** 1244 * Gets whether you should show UI with rationale for requesting a permission. 1245 * You should do this only if you do not have the permission and the context in 1246 * which the permission is requested does not clearly communicate to the user 1247 * what would be the benefit from granting this permission. 1248 * <p> 1249 * For example, if you write a camera app, requesting the camera permission 1250 * would be expected by the user and no rationale for why it is requested is 1251 * needed. If however, the app needs location for tagging photos then a non-tech 1252 * savvy user may wonder how location is related to taking photos. In this case 1253 * you may choose to show UI with rationale of requesting this permission. 1254 * </p> 1255 * 1256 * @param permission A permission your app wants to request. 1257 * @return Whether you can show permission rationale UI. 1258 * 1259 * @see Context#checkSelfPermission(String) 1260 * @see #requestPermissions(String[], int) 1261 * @see #onRequestPermissionsResult(int, String[], int[]) 1262 */ 1263 public boolean shouldShowRequestPermissionRationale(@NonNull String permission) { 1264 if (mHost != null) { 1265 return mHost.getContext().getPackageManager() 1266 .shouldShowRequestPermissionRationale(permission); 1267 } 1268 return false; 1269 } 1270 1271 /** 1272 * @hide Hack so that DialogFragment can make its Dialog before creating 1273 * its views, and the view construction can use the dialog's context for 1274 * inflation. Maybe this should become a public API. Note sure. 1275 */ 1276 public LayoutInflater getLayoutInflater(Bundle savedInstanceState) { 1277 final LayoutInflater result = mHost.onGetLayoutInflater(); 1278 if (mHost.onUseFragmentManagerInflaterFactory()) { 1279 getChildFragmentManager(); // Init if needed; use raw implementation below. 1280 result.setPrivateFactory(mChildFragmentManager.getLayoutInflaterFactory()); 1281 } 1282 return result; 1283 } 1284 1285 /** 1286 * @deprecated Use {@link #onInflate(Context, AttributeSet, Bundle)} instead. 1287 */ 1288 @Deprecated 1289 public void onInflate(AttributeSet attrs, Bundle savedInstanceState) { 1290 mCalled = true; 1291 } 1292 1293 /** 1294 * Called when a fragment is being created as part of a view layout 1295 * inflation, typically from setting the content view of an activity. This 1296 * may be called immediately after the fragment is created from a <fragment> 1297 * tag in a layout file. Note this is <em>before</em> the fragment's 1298 * {@link #onAttach(Activity)} has been called; all you should do here is 1299 * parse the attributes and save them away. 1300 * 1301 * <p>This is called every time the fragment is inflated, even if it is 1302 * being inflated into a new instance with saved state. It typically makes 1303 * sense to re-parse the parameters each time, to allow them to change with 1304 * different configurations.</p> 1305 * 1306 * <p>Here is a typical implementation of a fragment that can take parameters 1307 * both through attributes supplied here as well from {@link #getArguments()}:</p> 1308 * 1309 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentArguments.java 1310 * fragment} 1311 * 1312 * <p>Note that parsing the XML attributes uses a "styleable" resource. The 1313 * declaration for the styleable used here is:</p> 1314 * 1315 * {@sample development/samples/ApiDemos/res/values/attrs.xml fragment_arguments} 1316 * 1317 * <p>The fragment can then be declared within its activity's content layout 1318 * through a tag like this:</p> 1319 * 1320 * {@sample development/samples/ApiDemos/res/layout/fragment_arguments.xml from_attributes} 1321 * 1322 * <p>This fragment can also be created dynamically from arguments given 1323 * at runtime in the arguments Bundle; here is an example of doing so at 1324 * creation of the containing activity:</p> 1325 * 1326 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentArguments.java 1327 * create} 1328 * 1329 * @param context The Context that is inflating this fragment. 1330 * @param attrs The attributes at the tag where the fragment is 1331 * being created. 1332 * @param savedInstanceState If the fragment is being re-created from 1333 * a previous saved state, this is the state. 1334 */ 1335 public void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState) { 1336 onInflate(attrs, savedInstanceState); 1337 mCalled = true; 1338 1339 TypedArray a = context.obtainStyledAttributes(attrs, 1340 com.android.internal.R.styleable.Fragment); 1341 mEnterTransition = loadTransition(context, a, mEnterTransition, null, 1342 com.android.internal.R.styleable.Fragment_fragmentEnterTransition); 1343 mReturnTransition = loadTransition(context, a, mReturnTransition, USE_DEFAULT_TRANSITION, 1344 com.android.internal.R.styleable.Fragment_fragmentReturnTransition); 1345 mExitTransition = loadTransition(context, a, mExitTransition, null, 1346 com.android.internal.R.styleable.Fragment_fragmentExitTransition); 1347 mReenterTransition = loadTransition(context, a, mReenterTransition, USE_DEFAULT_TRANSITION, 1348 com.android.internal.R.styleable.Fragment_fragmentReenterTransition); 1349 mSharedElementEnterTransition = loadTransition(context, a, mSharedElementEnterTransition, 1350 null, com.android.internal.R.styleable.Fragment_fragmentSharedElementEnterTransition); 1351 mSharedElementReturnTransition = loadTransition(context, a, mSharedElementReturnTransition, 1352 USE_DEFAULT_TRANSITION, 1353 com.android.internal.R.styleable.Fragment_fragmentSharedElementReturnTransition); 1354 if (mAllowEnterTransitionOverlap == null) { 1355 mAllowEnterTransitionOverlap = a.getBoolean( 1356 com.android.internal.R.styleable.Fragment_fragmentAllowEnterTransitionOverlap, true); 1357 } 1358 if (mAllowReturnTransitionOverlap == null) { 1359 mAllowReturnTransitionOverlap = a.getBoolean( 1360 com.android.internal.R.styleable.Fragment_fragmentAllowReturnTransitionOverlap, true); 1361 } 1362 a.recycle(); 1363 1364 final Activity hostActivity = mHost == null ? null : mHost.getActivity(); 1365 if (hostActivity != null) { 1366 mCalled = false; 1367 onInflate(hostActivity, attrs, savedInstanceState); 1368 } 1369 } 1370 1371 /** 1372 * @deprecated Use {@link #onInflate(Context, AttributeSet, Bundle)} instead. 1373 */ 1374 @Deprecated 1375 public void onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) { 1376 mCalled = true; 1377 } 1378 1379 /** 1380 * Called when a fragment is first attached to its context. 1381 * {@link #onCreate(Bundle)} will be called after this. 1382 */ 1383 public void onAttach(Context context) { 1384 mCalled = true; 1385 final Activity hostActivity = mHost == null ? null : mHost.getActivity(); 1386 if (hostActivity != null) { 1387 mCalled = false; 1388 onAttach(hostActivity); 1389 } 1390 } 1391 1392 /** 1393 * @deprecated Use {@link #onAttach(Context)} instead. 1394 */ 1395 @Deprecated 1396 public void onAttach(Activity activity) { 1397 mCalled = true; 1398 } 1399 1400 /** 1401 * Called when a fragment loads an animation. 1402 */ 1403 public Animator onCreateAnimator(int transit, boolean enter, int nextAnim) { 1404 return null; 1405 } 1406 1407 /** 1408 * Called to do initial creation of a fragment. This is called after 1409 * {@link #onAttach(Activity)} and before 1410 * {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}, but is not called if the fragment 1411 * instance is retained across Activity re-creation (see {@link #setRetainInstance(boolean)}). 1412 * 1413 * <p>Note that this can be called while the fragment's activity is 1414 * still in the process of being created. As such, you can not rely 1415 * on things like the activity's content view hierarchy being initialized 1416 * at this point. If you want to do work once the activity itself is 1417 * created, see {@link #onActivityCreated(Bundle)}. 1418 * 1419 * <p>If your app's <code>targetSdkVersion</code> is 23 or lower, child fragments 1420 * being restored from the savedInstanceState are restored after <code>onCreate</code> 1421 * returns. When targeting N or above and running on an N or newer platform version 1422 * they are restored by <code>Fragment.onCreate</code>.</p> 1423 * 1424 * @param savedInstanceState If the fragment is being re-created from 1425 * a previous saved state, this is the state. 1426 */ 1427 public void onCreate(@Nullable Bundle savedInstanceState) { 1428 mCalled = true; 1429 final Context context = getContext(); 1430 final int version = context != null ? context.getApplicationInfo().targetSdkVersion : 0; 1431 if (version >= Build.VERSION_CODES.N) { 1432 restoreChildFragmentState(savedInstanceState, true); 1433 } 1434 } 1435 1436 void restoreChildFragmentState(@Nullable Bundle savedInstanceState, boolean provideNonConfig) { 1437 if (savedInstanceState != null) { 1438 Parcelable p = savedInstanceState.getParcelable(Activity.FRAGMENTS_TAG); 1439 if (p != null) { 1440 if (mChildFragmentManager == null) { 1441 instantiateChildFragmentManager(); 1442 } 1443 mChildFragmentManager.restoreAllState(p, provideNonConfig ? mChildNonConfig : null); 1444 mChildNonConfig = null; 1445 mChildFragmentManager.dispatchCreate(); 1446 } 1447 } 1448 } 1449 1450 /** 1451 * Called to have the fragment instantiate its user interface view. 1452 * This is optional, and non-graphical fragments can return null (which 1453 * is the default implementation). This will be called between 1454 * {@link #onCreate(Bundle)} and {@link #onActivityCreated(Bundle)}. 1455 * 1456 * <p>If you return a View from here, you will later be called in 1457 * {@link #onDestroyView} when the view is being released. 1458 * 1459 * @param inflater The LayoutInflater object that can be used to inflate 1460 * any views in the fragment, 1461 * @param container If non-null, this is the parent view that the fragment's 1462 * UI should be attached to. The fragment should not add the view itself, 1463 * but this can be used to generate the LayoutParams of the view. 1464 * @param savedInstanceState If non-null, this fragment is being re-constructed 1465 * from a previous saved state as given here. 1466 * 1467 * @return Return the View for the fragment's UI, or null. 1468 */ 1469 @Nullable 1470 public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, 1471 Bundle savedInstanceState) { 1472 return null; 1473 } 1474 1475 /** 1476 * Called immediately after {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)} 1477 * has returned, but before any saved state has been restored in to the view. 1478 * This gives subclasses a chance to initialize themselves once 1479 * they know their view hierarchy has been completely created. The fragment's 1480 * view hierarchy is not however attached to its parent at this point. 1481 * @param view The View returned by {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}. 1482 * @param savedInstanceState If non-null, this fragment is being re-constructed 1483 * from a previous saved state as given here. 1484 */ 1485 public void onViewCreated(View view, @Nullable Bundle savedInstanceState) { 1486 } 1487 1488 /** 1489 * Get the root view for the fragment's layout (the one returned by {@link #onCreateView}), 1490 * if provided. 1491 * 1492 * @return The fragment's root view, or null if it has no layout. 1493 */ 1494 @Nullable 1495 public View getView() { 1496 return mView; 1497 } 1498 1499 /** 1500 * Called when the fragment's activity has been created and this 1501 * fragment's view hierarchy instantiated. It can be used to do final 1502 * initialization once these pieces are in place, such as retrieving 1503 * views or restoring state. It is also useful for fragments that use 1504 * {@link #setRetainInstance(boolean)} to retain their instance, 1505 * as this callback tells the fragment when it is fully associated with 1506 * the new activity instance. This is called after {@link #onCreateView} 1507 * and before {@link #onViewStateRestored(Bundle)}. 1508 * 1509 * @param savedInstanceState If the fragment is being re-created from 1510 * a previous saved state, this is the state. 1511 */ 1512 public void onActivityCreated(@Nullable Bundle savedInstanceState) { 1513 mCalled = true; 1514 } 1515 1516 /** 1517 * Called when all saved state has been restored into the view hierarchy 1518 * of the fragment. This can be used to do initialization based on saved 1519 * state that you are letting the view hierarchy track itself, such as 1520 * whether check box widgets are currently checked. This is called 1521 * after {@link #onActivityCreated(Bundle)} and before 1522 * {@link #onStart()}. 1523 * 1524 * @param savedInstanceState If the fragment is being re-created from 1525 * a previous saved state, this is the state. 1526 */ 1527 public void onViewStateRestored(Bundle savedInstanceState) { 1528 mCalled = true; 1529 } 1530 1531 /** 1532 * Called when the Fragment is visible to the user. This is generally 1533 * tied to {@link Activity#onStart() Activity.onStart} of the containing 1534 * Activity's lifecycle. 1535 */ 1536 public void onStart() { 1537 mCalled = true; 1538 1539 if (!mLoadersStarted) { 1540 mLoadersStarted = true; 1541 if (!mCheckedForLoaderManager) { 1542 mCheckedForLoaderManager = true; 1543 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, false); 1544 } 1545 if (mLoaderManager != null) { 1546 mLoaderManager.doStart(); 1547 } 1548 } 1549 } 1550 1551 /** 1552 * Called when the fragment is visible to the user and actively running. 1553 * This is generally 1554 * tied to {@link Activity#onResume() Activity.onResume} of the containing 1555 * Activity's lifecycle. 1556 */ 1557 public void onResume() { 1558 mCalled = true; 1559 } 1560 1561 /** 1562 * Called to ask the fragment to save its current dynamic state, so it 1563 * can later be reconstructed in a new instance of its process is 1564 * restarted. If a new instance of the fragment later needs to be 1565 * created, the data you place in the Bundle here will be available 1566 * in the Bundle given to {@link #onCreate(Bundle)}, 1567 * {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}, and 1568 * {@link #onActivityCreated(Bundle)}. 1569 * 1570 * <p>This corresponds to {@link Activity#onSaveInstanceState(Bundle) 1571 * Activity.onSaveInstanceState(Bundle)} and most of the discussion there 1572 * applies here as well. Note however: <em>this method may be called 1573 * at any time before {@link #onDestroy()}</em>. There are many situations 1574 * where a fragment may be mostly torn down (such as when placed on the 1575 * back stack with no UI showing), but its state will not be saved until 1576 * its owning activity actually needs to save its state. 1577 * 1578 * @param outState Bundle in which to place your saved state. 1579 */ 1580 public void onSaveInstanceState(Bundle outState) { 1581 } 1582 1583 /** 1584 * Called when the Fragment's activity changes from fullscreen mode to multi-window mode and 1585 * visa-versa. This is generally tied to {@link Activity#onMultiWindowModeChanged} of the 1586 * containing Activity. 1587 * 1588 * @param isInMultiWindowMode True if the activity is in multi-window mode. 1589 */ 1590 public void onMultiWindowModeChanged(boolean isInMultiWindowMode) { 1591 } 1592 1593 /** 1594 * Called by the system when the activity changes to and from picture-in-picture mode. This is 1595 * generally tied to {@link Activity#onPictureInPictureModeChanged} of the containing Activity. 1596 * 1597 * @param isInPictureInPictureMode True if the activity is in picture-in-picture mode. 1598 */ 1599 public void onPictureInPictureModeChanged(boolean isInPictureInPictureMode) { 1600 } 1601 1602 public void onConfigurationChanged(Configuration newConfig) { 1603 mCalled = true; 1604 } 1605 1606 /** 1607 * Called when the Fragment is no longer resumed. This is generally 1608 * tied to {@link Activity#onPause() Activity.onPause} of the containing 1609 * Activity's lifecycle. 1610 */ 1611 public void onPause() { 1612 mCalled = true; 1613 } 1614 1615 /** 1616 * Called when the Fragment is no longer started. This is generally 1617 * tied to {@link Activity#onStop() Activity.onStop} of the containing 1618 * Activity's lifecycle. 1619 */ 1620 public void onStop() { 1621 mCalled = true; 1622 } 1623 1624 public void onLowMemory() { 1625 mCalled = true; 1626 } 1627 1628 public void onTrimMemory(int level) { 1629 mCalled = true; 1630 } 1631 1632 /** 1633 * Called when the view previously created by {@link #onCreateView} has 1634 * been detached from the fragment. The next time the fragment needs 1635 * to be displayed, a new view will be created. This is called 1636 * after {@link #onStop()} and before {@link #onDestroy()}. It is called 1637 * <em>regardless</em> of whether {@link #onCreateView} returned a 1638 * non-null view. Internally it is called after the view's state has 1639 * been saved but before it has been removed from its parent. 1640 */ 1641 public void onDestroyView() { 1642 mCalled = true; 1643 } 1644 1645 /** 1646 * Called when the fragment is no longer in use. This is called 1647 * after {@link #onStop()} and before {@link #onDetach()}. 1648 */ 1649 public void onDestroy() { 1650 mCalled = true; 1651 //Log.v("foo", "onDestroy: mCheckedForLoaderManager=" + mCheckedForLoaderManager 1652 // + " mLoaderManager=" + mLoaderManager); 1653 if (!mCheckedForLoaderManager) { 1654 mCheckedForLoaderManager = true; 1655 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, false); 1656 } 1657 if (mLoaderManager != null) { 1658 mLoaderManager.doDestroy(); 1659 } 1660 } 1661 1662 /** 1663 * Called by the fragment manager once this fragment has been removed, 1664 * so that we don't have any left-over state if the application decides 1665 * to re-use the instance. This only clears state that the framework 1666 * internally manages, not things the application sets. 1667 */ 1668 void initState() { 1669 mIndex = -1; 1670 mWho = null; 1671 mAdded = false; 1672 mRemoving = false; 1673 mFromLayout = false; 1674 mInLayout = false; 1675 mRestored = false; 1676 mBackStackNesting = 0; 1677 mFragmentManager = null; 1678 mChildFragmentManager = null; 1679 mHost = null; 1680 mFragmentId = 0; 1681 mContainerId = 0; 1682 mTag = null; 1683 mHidden = false; 1684 mDetached = false; 1685 mRetaining = false; 1686 mLoaderManager = null; 1687 mLoadersStarted = false; 1688 mCheckedForLoaderManager = false; 1689 } 1690 1691 /** 1692 * Called when the fragment is no longer attached to its activity. This is called after 1693 * {@link #onDestroy()}, except in the cases where the fragment instance is retained across 1694 * Activity re-creation (see {@link #setRetainInstance(boolean)}), in which case it is called 1695 * after {@link #onStop()}. 1696 */ 1697 public void onDetach() { 1698 mCalled = true; 1699 1700 // Destroy the child FragmentManager if we still have it here. 1701 // We won't unless we're retaining our instance and if we do, 1702 // our child FragmentManager instance state will have already been saved. 1703 if (mChildFragmentManager != null) { 1704 if (!mRetaining) { 1705 throw new IllegalStateException("Child FragmentManager of " + this + " was not " 1706 + " destroyed and this fragment is not retaining instance"); 1707 } 1708 mChildFragmentManager.dispatchDestroy(); 1709 mChildFragmentManager = null; 1710 } 1711 } 1712 1713 /** 1714 * Initialize the contents of the Activity's standard options menu. You 1715 * should place your menu items in to <var>menu</var>. For this method 1716 * to be called, you must have first called {@link #setHasOptionsMenu}. See 1717 * {@link Activity#onCreateOptionsMenu(Menu) Activity.onCreateOptionsMenu} 1718 * for more information. 1719 * 1720 * @param menu The options menu in which you place your items. 1721 * 1722 * @see #setHasOptionsMenu 1723 * @see #onPrepareOptionsMenu 1724 * @see #onOptionsItemSelected 1725 */ 1726 public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) { 1727 } 1728 1729 /** 1730 * Prepare the Screen's standard options menu to be displayed. This is 1731 * called right before the menu is shown, every time it is shown. You can 1732 * use this method to efficiently enable/disable items or otherwise 1733 * dynamically modify the contents. See 1734 * {@link Activity#onPrepareOptionsMenu(Menu) Activity.onPrepareOptionsMenu} 1735 * for more information. 1736 * 1737 * @param menu The options menu as last shown or first initialized by 1738 * onCreateOptionsMenu(). 1739 * 1740 * @see #setHasOptionsMenu 1741 * @see #onCreateOptionsMenu 1742 */ 1743 public void onPrepareOptionsMenu(Menu menu) { 1744 } 1745 1746 /** 1747 * Called when this fragment's option menu items are no longer being 1748 * included in the overall options menu. Receiving this call means that 1749 * the menu needed to be rebuilt, but this fragment's items were not 1750 * included in the newly built menu (its {@link #onCreateOptionsMenu(Menu, MenuInflater)} 1751 * was not called). 1752 */ 1753 public void onDestroyOptionsMenu() { 1754 } 1755 1756 /** 1757 * This hook is called whenever an item in your options menu is selected. 1758 * The default implementation simply returns false to have the normal 1759 * processing happen (calling the item's Runnable or sending a message to 1760 * its Handler as appropriate). You can use this method for any items 1761 * for which you would like to do processing without those other 1762 * facilities. 1763 * 1764 * <p>Derived classes should call through to the base class for it to 1765 * perform the default menu handling. 1766 * 1767 * @param item The menu item that was selected. 1768 * 1769 * @return boolean Return false to allow normal menu processing to 1770 * proceed, true to consume it here. 1771 * 1772 * @see #onCreateOptionsMenu 1773 */ 1774 public boolean onOptionsItemSelected(MenuItem item) { 1775 return false; 1776 } 1777 1778 /** 1779 * This hook is called whenever the options menu is being closed (either by the user canceling 1780 * the menu with the back/menu button, or when an item is selected). 1781 * 1782 * @param menu The options menu as last shown or first initialized by 1783 * onCreateOptionsMenu(). 1784 */ 1785 public void onOptionsMenuClosed(Menu menu) { 1786 } 1787 1788 /** 1789 * Called when a context menu for the {@code view} is about to be shown. 1790 * Unlike {@link #onCreateOptionsMenu}, this will be called every 1791 * time the context menu is about to be shown and should be populated for 1792 * the view (or item inside the view for {@link AdapterView} subclasses, 1793 * this can be found in the {@code menuInfo})). 1794 * <p> 1795 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an 1796 * item has been selected. 1797 * <p> 1798 * The default implementation calls up to 1799 * {@link Activity#onCreateContextMenu Activity.onCreateContextMenu}, though 1800 * you can not call this implementation if you don't want that behavior. 1801 * <p> 1802 * It is not safe to hold onto the context menu after this method returns. 1803 * {@inheritDoc} 1804 */ 1805 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { 1806 getActivity().onCreateContextMenu(menu, v, menuInfo); 1807 } 1808 1809 /** 1810 * Registers a context menu to be shown for the given view (multiple views 1811 * can show the context menu). This method will set the 1812 * {@link OnCreateContextMenuListener} on the view to this fragment, so 1813 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be 1814 * called when it is time to show the context menu. 1815 * 1816 * @see #unregisterForContextMenu(View) 1817 * @param view The view that should show a context menu. 1818 */ 1819 public void registerForContextMenu(View view) { 1820 view.setOnCreateContextMenuListener(this); 1821 } 1822 1823 /** 1824 * Prevents a context menu to be shown for the given view. This method will 1825 * remove the {@link OnCreateContextMenuListener} on the view. 1826 * 1827 * @see #registerForContextMenu(View) 1828 * @param view The view that should stop showing a context menu. 1829 */ 1830 public void unregisterForContextMenu(View view) { 1831 view.setOnCreateContextMenuListener(null); 1832 } 1833 1834 /** 1835 * This hook is called whenever an item in a context menu is selected. The 1836 * default implementation simply returns false to have the normal processing 1837 * happen (calling the item's Runnable or sending a message to its Handler 1838 * as appropriate). You can use this method for any items for which you 1839 * would like to do processing without those other facilities. 1840 * <p> 1841 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the 1842 * View that added this menu item. 1843 * <p> 1844 * Derived classes should call through to the base class for it to perform 1845 * the default menu handling. 1846 * 1847 * @param item The context menu item that was selected. 1848 * @return boolean Return false to allow normal context menu processing to 1849 * proceed, true to consume it here. 1850 */ 1851 public boolean onContextItemSelected(MenuItem item) { 1852 return false; 1853 } 1854 1855 /** 1856 * When custom transitions are used with Fragments, the enter transition callback 1857 * is called when this Fragment is attached or detached when not popping the back stack. 1858 * 1859 * @param callback Used to manipulate the shared element transitions on this Fragment 1860 * when added not as a pop from the back stack. 1861 */ 1862 public void setEnterSharedElementCallback(SharedElementCallback callback) { 1863 if (callback == null) { 1864 callback = SharedElementCallback.NULL_CALLBACK; 1865 } 1866 mEnterTransitionCallback = callback; 1867 } 1868 1869 /** 1870 * @hide 1871 */ 1872 public void setEnterSharedElementTransitionCallback(SharedElementCallback callback) { 1873 setEnterSharedElementCallback(callback); 1874 } 1875 1876 /** 1877 * When custom transitions are used with Fragments, the exit transition callback 1878 * is called when this Fragment is attached or detached when popping the back stack. 1879 * 1880 * @param callback Used to manipulate the shared element transitions on this Fragment 1881 * when added as a pop from the back stack. 1882 */ 1883 public void setExitSharedElementCallback(SharedElementCallback callback) { 1884 if (callback == null) { 1885 callback = SharedElementCallback.NULL_CALLBACK; 1886 } 1887 mExitTransitionCallback = callback; 1888 } 1889 1890 /** 1891 * @hide 1892 */ 1893 public void setExitSharedElementTransitionCallback(SharedElementCallback callback) { 1894 setExitSharedElementCallback(callback); 1895 } 1896 1897 /** 1898 * Sets the Transition that will be used to move Views into the initial scene. The entering 1899 * Views will be those that are regular Views or ViewGroups that have 1900 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend 1901 * {@link android.transition.Visibility} as entering is governed by changing visibility from 1902 * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null, 1903 * entering Views will remain unaffected. 1904 * 1905 * @param transition The Transition to use to move Views into the initial Scene. 1906 * @attr ref android.R.styleable#Fragment_fragmentEnterTransition 1907 */ 1908 public void setEnterTransition(Transition transition) { 1909 mEnterTransition = transition; 1910 } 1911 1912 /** 1913 * Returns the Transition that will be used to move Views into the initial scene. The entering 1914 * Views will be those that are regular Views or ViewGroups that have 1915 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend 1916 * {@link android.transition.Visibility} as entering is governed by changing visibility from 1917 * {@link View#INVISIBLE} to {@link View#VISIBLE}. 1918 * 1919 * @return the Transition to use to move Views into the initial Scene. 1920 * @attr ref android.R.styleable#Fragment_fragmentEnterTransition 1921 */ 1922 public Transition getEnterTransition() { 1923 return mEnterTransition; 1924 } 1925 1926 /** 1927 * Sets the Transition that will be used to move Views out of the scene when the Fragment is 1928 * preparing to be removed, hidden, or detached because of popping the back stack. The exiting 1929 * Views will be those that are regular Views or ViewGroups that have 1930 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend 1931 * {@link android.transition.Visibility} as entering is governed by changing visibility from 1932 * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null, 1933 * entering Views will remain unaffected. If nothing is set, the default will be to 1934 * use the same value as set in {@link #setEnterTransition(android.transition.Transition)}. 1935 * 1936 * @param transition The Transition to use to move Views out of the Scene when the Fragment 1937 * is preparing to close. 1938 * @attr ref android.R.styleable#Fragment_fragmentExitTransition 1939 */ 1940 public void setReturnTransition(Transition transition) { 1941 mReturnTransition = transition; 1942 } 1943 1944 /** 1945 * Returns the Transition that will be used to move Views out of the scene when the Fragment is 1946 * preparing to be removed, hidden, or detached because of popping the back stack. The exiting 1947 * Views will be those that are regular Views or ViewGroups that have 1948 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend 1949 * {@link android.transition.Visibility} as entering is governed by changing visibility from 1950 * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null, 1951 * entering Views will remain unaffected. 1952 * 1953 * @return the Transition to use to move Views out of the Scene when the Fragment 1954 * is preparing to close. 1955 * @attr ref android.R.styleable#Fragment_fragmentExitTransition 1956 */ 1957 public Transition getReturnTransition() { 1958 return mReturnTransition == USE_DEFAULT_TRANSITION ? getEnterTransition() 1959 : mReturnTransition; 1960 } 1961 1962 /** 1963 * Sets the Transition that will be used to move Views out of the scene when the 1964 * fragment is removed, hidden, or detached when not popping the back stack. 1965 * The exiting Views will be those that are regular Views or ViewGroups that 1966 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend 1967 * {@link android.transition.Visibility} as exiting is governed by changing visibility 1968 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will 1969 * remain unaffected. 1970 * 1971 * @param transition The Transition to use to move Views out of the Scene when the Fragment 1972 * is being closed not due to popping the back stack. 1973 * @attr ref android.R.styleable#Fragment_fragmentExitTransition 1974 */ 1975 public void setExitTransition(Transition transition) { 1976 mExitTransition = transition; 1977 } 1978 1979 /** 1980 * Returns the Transition that will be used to move Views out of the scene when the 1981 * fragment is removed, hidden, or detached when not popping the back stack. 1982 * The exiting Views will be those that are regular Views or ViewGroups that 1983 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend 1984 * {@link android.transition.Visibility} as exiting is governed by changing visibility 1985 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will 1986 * remain unaffected. 1987 * 1988 * @return the Transition to use to move Views out of the Scene when the Fragment 1989 * is being closed not due to popping the back stack. 1990 * @attr ref android.R.styleable#Fragment_fragmentExitTransition 1991 */ 1992 public Transition getExitTransition() { 1993 return mExitTransition; 1994 } 1995 1996 /** 1997 * Sets the Transition that will be used to move Views in to the scene when returning due 1998 * to popping a back stack. The entering Views will be those that are regular Views 1999 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions 2000 * will extend {@link android.transition.Visibility} as exiting is governed by changing 2001 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, 2002 * the views will remain unaffected. If nothing is set, the default will be to use the same 2003 * transition as {@link #setExitTransition(android.transition.Transition)}. 2004 * 2005 * @param transition The Transition to use to move Views into the scene when reentering from a 2006 * previously-started Activity. 2007 * @attr ref android.R.styleable#Fragment_fragmentReenterTransition 2008 */ 2009 public void setReenterTransition(Transition transition) { 2010 mReenterTransition = transition; 2011 } 2012 2013 /** 2014 * Returns the Transition that will be used to move Views in to the scene when returning due 2015 * to popping a back stack. The entering Views will be those that are regular Views 2016 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions 2017 * will extend {@link android.transition.Visibility} as exiting is governed by changing 2018 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, 2019 * the views will remain unaffected. If nothing is set, the default will be to use the same 2020 * transition as {@link #setExitTransition(android.transition.Transition)}. 2021 * 2022 * @return the Transition to use to move Views into the scene when reentering from a 2023 * previously-started Activity. 2024 * @attr ref android.R.styleable#Fragment_fragmentReenterTransition 2025 */ 2026 public Transition getReenterTransition() { 2027 return mReenterTransition == USE_DEFAULT_TRANSITION ? getExitTransition() 2028 : mReenterTransition; 2029 } 2030 2031 /** 2032 * Sets the Transition that will be used for shared elements transferred into the content 2033 * Scene. Typical Transitions will affect size and location, such as 2034 * {@link android.transition.ChangeBounds}. A null 2035 * value will cause transferred shared elements to blink to the final position. 2036 * 2037 * @param transition The Transition to use for shared elements transferred into the content 2038 * Scene. 2039 * @attr ref android.R.styleable#Fragment_fragmentSharedElementEnterTransition 2040 */ 2041 public void setSharedElementEnterTransition(Transition transition) { 2042 mSharedElementEnterTransition = transition; 2043 } 2044 2045 /** 2046 * Returns the Transition that will be used for shared elements transferred into the content 2047 * Scene. Typical Transitions will affect size and location, such as 2048 * {@link android.transition.ChangeBounds}. A null 2049 * value will cause transferred shared elements to blink to the final position. 2050 * 2051 * @return The Transition to use for shared elements transferred into the content 2052 * Scene. 2053 * @attr ref android.R.styleable#Fragment_fragmentSharedElementEnterTransition 2054 */ 2055 public Transition getSharedElementEnterTransition() { 2056 return mSharedElementEnterTransition; 2057 } 2058 2059 /** 2060 * Sets the Transition that will be used for shared elements transferred back during a 2061 * pop of the back stack. This Transition acts in the leaving Fragment. 2062 * Typical Transitions will affect size and location, such as 2063 * {@link android.transition.ChangeBounds}. A null 2064 * value will cause transferred shared elements to blink to the final position. 2065 * If no value is set, the default will be to use the same value as 2066 * {@link #setSharedElementEnterTransition(android.transition.Transition)}. 2067 * 2068 * @param transition The Transition to use for shared elements transferred out of the content 2069 * Scene. 2070 * @attr ref android.R.styleable#Fragment_fragmentSharedElementReturnTransition 2071 */ 2072 public void setSharedElementReturnTransition(Transition transition) { 2073 mSharedElementReturnTransition = transition; 2074 } 2075 2076 /** 2077 * Return the Transition that will be used for shared elements transferred back during a 2078 * pop of the back stack. This Transition acts in the leaving Fragment. 2079 * Typical Transitions will affect size and location, such as 2080 * {@link android.transition.ChangeBounds}. A null 2081 * value will cause transferred shared elements to blink to the final position. 2082 * If no value is set, the default will be to use the same value as 2083 * {@link #setSharedElementEnterTransition(android.transition.Transition)}. 2084 * 2085 * @return The Transition to use for shared elements transferred out of the content 2086 * Scene. 2087 * @attr ref android.R.styleable#Fragment_fragmentSharedElementReturnTransition 2088 */ 2089 public Transition getSharedElementReturnTransition() { 2090 return mSharedElementReturnTransition == USE_DEFAULT_TRANSITION ? 2091 getSharedElementEnterTransition() : mSharedElementReturnTransition; 2092 } 2093 2094 /** 2095 * Sets whether the the exit transition and enter transition overlap or not. 2096 * When true, the enter transition will start as soon as possible. When false, the 2097 * enter transition will wait until the exit transition completes before starting. 2098 * 2099 * @param allow true to start the enter transition when possible or false to 2100 * wait until the exiting transition completes. 2101 * @attr ref android.R.styleable#Fragment_fragmentAllowEnterTransitionOverlap 2102 */ 2103 public void setAllowEnterTransitionOverlap(boolean allow) { 2104 mAllowEnterTransitionOverlap = allow; 2105 } 2106 2107 /** 2108 * Returns whether the the exit transition and enter transition overlap or not. 2109 * When true, the enter transition will start as soon as possible. When false, the 2110 * enter transition will wait until the exit transition completes before starting. 2111 * 2112 * @return true when the enter transition should start as soon as possible or false to 2113 * when it should wait until the exiting transition completes. 2114 * @attr ref android.R.styleable#Fragment_fragmentAllowEnterTransitionOverlap 2115 */ 2116 public boolean getAllowEnterTransitionOverlap() { 2117 return (mAllowEnterTransitionOverlap == null) ? true : mAllowEnterTransitionOverlap; 2118 } 2119 2120 /** 2121 * Sets whether the the return transition and reenter transition overlap or not. 2122 * When true, the reenter transition will start as soon as possible. When false, the 2123 * reenter transition will wait until the return transition completes before starting. 2124 * 2125 * @param allow true to start the reenter transition when possible or false to wait until the 2126 * return transition completes. 2127 * @attr ref android.R.styleable#Fragment_fragmentAllowReturnTransitionOverlap 2128 */ 2129 public void setAllowReturnTransitionOverlap(boolean allow) { 2130 mAllowReturnTransitionOverlap = allow; 2131 } 2132 2133 /** 2134 * Returns whether the the return transition and reenter transition overlap or not. 2135 * When true, the reenter transition will start as soon as possible. When false, the 2136 * reenter transition will wait until the return transition completes before starting. 2137 * 2138 * @return true to start the reenter transition when possible or false to wait until the 2139 * return transition completes. 2140 * @attr ref android.R.styleable#Fragment_fragmentAllowReturnTransitionOverlap 2141 */ 2142 public boolean getAllowReturnTransitionOverlap() { 2143 return (mAllowReturnTransitionOverlap == null) ? true : mAllowReturnTransitionOverlap; 2144 } 2145 2146 /** 2147 * Print the Fragments's state into the given stream. 2148 * 2149 * @param prefix Text to print at the front of each line. 2150 * @param fd The raw file descriptor that the dump is being sent to. 2151 * @param writer The PrintWriter to which you should dump your state. This will be 2152 * closed for you after you return. 2153 * @param args additional arguments to the dump request. 2154 */ 2155 public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { 2156 writer.print(prefix); writer.print("mFragmentId=#"); 2157 writer.print(Integer.toHexString(mFragmentId)); 2158 writer.print(" mContainerId=#"); 2159 writer.print(Integer.toHexString(mContainerId)); 2160 writer.print(" mTag="); writer.println(mTag); 2161 writer.print(prefix); writer.print("mState="); writer.print(mState); 2162 writer.print(" mIndex="); writer.print(mIndex); 2163 writer.print(" mWho="); writer.print(mWho); 2164 writer.print(" mBackStackNesting="); writer.println(mBackStackNesting); 2165 writer.print(prefix); writer.print("mAdded="); writer.print(mAdded); 2166 writer.print(" mRemoving="); writer.print(mRemoving); 2167 writer.print(" mFromLayout="); writer.print(mFromLayout); 2168 writer.print(" mInLayout="); writer.println(mInLayout); 2169 writer.print(prefix); writer.print("mHidden="); writer.print(mHidden); 2170 writer.print(" mDetached="); writer.print(mDetached); 2171 writer.print(" mMenuVisible="); writer.print(mMenuVisible); 2172 writer.print(" mHasMenu="); writer.println(mHasMenu); 2173 writer.print(prefix); writer.print("mRetainInstance="); writer.print(mRetainInstance); 2174 writer.print(" mRetaining="); writer.print(mRetaining); 2175 writer.print(" mUserVisibleHint="); writer.println(mUserVisibleHint); 2176 if (mFragmentManager != null) { 2177 writer.print(prefix); writer.print("mFragmentManager="); 2178 writer.println(mFragmentManager); 2179 } 2180 if (mHost != null) { 2181 writer.print(prefix); writer.print("mHost="); 2182 writer.println(mHost); 2183 } 2184 if (mParentFragment != null) { 2185 writer.print(prefix); writer.print("mParentFragment="); 2186 writer.println(mParentFragment); 2187 } 2188 if (mArguments != null) { 2189 writer.print(prefix); writer.print("mArguments="); writer.println(mArguments); 2190 } 2191 if (mSavedFragmentState != null) { 2192 writer.print(prefix); writer.print("mSavedFragmentState="); 2193 writer.println(mSavedFragmentState); 2194 } 2195 if (mSavedViewState != null) { 2196 writer.print(prefix); writer.print("mSavedViewState="); 2197 writer.println(mSavedViewState); 2198 } 2199 if (mTarget != null) { 2200 writer.print(prefix); writer.print("mTarget="); writer.print(mTarget); 2201 writer.print(" mTargetRequestCode="); 2202 writer.println(mTargetRequestCode); 2203 } 2204 if (mNextAnim != 0) { 2205 writer.print(prefix); writer.print("mNextAnim="); writer.println(mNextAnim); 2206 } 2207 if (mContainer != null) { 2208 writer.print(prefix); writer.print("mContainer="); writer.println(mContainer); 2209 } 2210 if (mView != null) { 2211 writer.print(prefix); writer.print("mView="); writer.println(mView); 2212 } 2213 if (mAnimatingAway != null) { 2214 writer.print(prefix); writer.print("mAnimatingAway="); writer.println(mAnimatingAway); 2215 writer.print(prefix); writer.print("mStateAfterAnimating="); 2216 writer.println(mStateAfterAnimating); 2217 } 2218 if (mLoaderManager != null) { 2219 writer.print(prefix); writer.println("Loader Manager:"); 2220 mLoaderManager.dump(prefix + " ", fd, writer, args); 2221 } 2222 if (mChildFragmentManager != null) { 2223 writer.print(prefix); writer.println("Child " + mChildFragmentManager + ":"); 2224 mChildFragmentManager.dump(prefix + " ", fd, writer, args); 2225 } 2226 } 2227 2228 Fragment findFragmentByWho(String who) { 2229 if (who.equals(mWho)) { 2230 return this; 2231 } 2232 if (mChildFragmentManager != null) { 2233 return mChildFragmentManager.findFragmentByWho(who); 2234 } 2235 return null; 2236 } 2237 2238 void instantiateChildFragmentManager() { 2239 mChildFragmentManager = new FragmentManagerImpl(); 2240 mChildFragmentManager.attachController(mHost, new FragmentContainer() { 2241 @Override 2242 @Nullable 2243 public View onFindViewById(int id) { 2244 if (mView == null) { 2245 throw new IllegalStateException("Fragment does not have a view"); 2246 } 2247 return mView.findViewById(id); 2248 } 2249 2250 @Override 2251 public boolean onHasView() { 2252 return (mView != null); 2253 } 2254 }, this); 2255 } 2256 2257 void performCreate(Bundle savedInstanceState) { 2258 if (mChildFragmentManager != null) { 2259 mChildFragmentManager.noteStateNotSaved(); 2260 } 2261 mState = CREATED; 2262 mCalled = false; 2263 onCreate(savedInstanceState); 2264 if (!mCalled) { 2265 throw new SuperNotCalledException("Fragment " + this 2266 + " did not call through to super.onCreate()"); 2267 } 2268 final Context context = getContext(); 2269 final int version = context != null ? context.getApplicationInfo().targetSdkVersion : 0; 2270 if (version < Build.VERSION_CODES.N) { 2271 restoreChildFragmentState(savedInstanceState, false); 2272 } 2273 } 2274 2275 View performCreateView(LayoutInflater inflater, ViewGroup container, 2276 Bundle savedInstanceState) { 2277 if (mChildFragmentManager != null) { 2278 mChildFragmentManager.noteStateNotSaved(); 2279 } 2280 return onCreateView(inflater, container, savedInstanceState); 2281 } 2282 2283 void performActivityCreated(Bundle savedInstanceState) { 2284 if (mChildFragmentManager != null) { 2285 mChildFragmentManager.noteStateNotSaved(); 2286 } 2287 mState = ACTIVITY_CREATED; 2288 mCalled = false; 2289 onActivityCreated(savedInstanceState); 2290 if (!mCalled) { 2291 throw new SuperNotCalledException("Fragment " + this 2292 + " did not call through to super.onActivityCreated()"); 2293 } 2294 if (mChildFragmentManager != null) { 2295 mChildFragmentManager.dispatchActivityCreated(); 2296 } 2297 } 2298 2299 void performStart() { 2300 if (mChildFragmentManager != null) { 2301 mChildFragmentManager.noteStateNotSaved(); 2302 mChildFragmentManager.execPendingActions(); 2303 } 2304 mState = STARTED; 2305 mCalled = false; 2306 onStart(); 2307 if (!mCalled) { 2308 throw new SuperNotCalledException("Fragment " + this 2309 + " did not call through to super.onStart()"); 2310 } 2311 if (mChildFragmentManager != null) { 2312 mChildFragmentManager.dispatchStart(); 2313 } 2314 if (mLoaderManager != null) { 2315 mLoaderManager.doReportStart(); 2316 } 2317 } 2318 2319 void performResume() { 2320 if (mChildFragmentManager != null) { 2321 mChildFragmentManager.noteStateNotSaved(); 2322 mChildFragmentManager.execPendingActions(); 2323 } 2324 mState = RESUMED; 2325 mCalled = false; 2326 onResume(); 2327 if (!mCalled) { 2328 throw new SuperNotCalledException("Fragment " + this 2329 + " did not call through to super.onResume()"); 2330 } 2331 if (mChildFragmentManager != null) { 2332 mChildFragmentManager.dispatchResume(); 2333 mChildFragmentManager.execPendingActions(); 2334 } 2335 } 2336 2337 void performMultiWindowModeChanged(boolean isInMultiWindowMode) { 2338 onMultiWindowModeChanged(isInMultiWindowMode); 2339 if (mChildFragmentManager != null) { 2340 mChildFragmentManager.dispatchMultiWindowModeChanged(isInMultiWindowMode); 2341 } 2342 } 2343 2344 void performPictureInPictureModeChanged(boolean isInPictureInPictureMode) { 2345 onPictureInPictureModeChanged(isInPictureInPictureMode); 2346 if (mChildFragmentManager != null) { 2347 mChildFragmentManager.dispatchPictureInPictureModeChanged(isInPictureInPictureMode); 2348 } 2349 } 2350 2351 void performConfigurationChanged(Configuration newConfig) { 2352 onConfigurationChanged(newConfig); 2353 if (mChildFragmentManager != null) { 2354 mChildFragmentManager.dispatchConfigurationChanged(newConfig); 2355 } 2356 } 2357 2358 void performLowMemory() { 2359 onLowMemory(); 2360 if (mChildFragmentManager != null) { 2361 mChildFragmentManager.dispatchLowMemory(); 2362 } 2363 } 2364 2365 void performTrimMemory(int level) { 2366 onTrimMemory(level); 2367 if (mChildFragmentManager != null) { 2368 mChildFragmentManager.dispatchTrimMemory(level); 2369 } 2370 } 2371 2372 boolean performCreateOptionsMenu(Menu menu, MenuInflater inflater) { 2373 boolean show = false; 2374 if (!mHidden) { 2375 if (mHasMenu && mMenuVisible) { 2376 show = true; 2377 onCreateOptionsMenu(menu, inflater); 2378 } 2379 if (mChildFragmentManager != null) { 2380 show |= mChildFragmentManager.dispatchCreateOptionsMenu(menu, inflater); 2381 } 2382 } 2383 return show; 2384 } 2385 2386 boolean performPrepareOptionsMenu(Menu menu) { 2387 boolean show = false; 2388 if (!mHidden) { 2389 if (mHasMenu && mMenuVisible) { 2390 show = true; 2391 onPrepareOptionsMenu(menu); 2392 } 2393 if (mChildFragmentManager != null) { 2394 show |= mChildFragmentManager.dispatchPrepareOptionsMenu(menu); 2395 } 2396 } 2397 return show; 2398 } 2399 2400 boolean performOptionsItemSelected(MenuItem item) { 2401 if (!mHidden) { 2402 if (mHasMenu && mMenuVisible) { 2403 if (onOptionsItemSelected(item)) { 2404 return true; 2405 } 2406 } 2407 if (mChildFragmentManager != null) { 2408 if (mChildFragmentManager.dispatchOptionsItemSelected(item)) { 2409 return true; 2410 } 2411 } 2412 } 2413 return false; 2414 } 2415 2416 boolean performContextItemSelected(MenuItem item) { 2417 if (!mHidden) { 2418 if (onContextItemSelected(item)) { 2419 return true; 2420 } 2421 if (mChildFragmentManager != null) { 2422 if (mChildFragmentManager.dispatchContextItemSelected(item)) { 2423 return true; 2424 } 2425 } 2426 } 2427 return false; 2428 } 2429 2430 void performOptionsMenuClosed(Menu menu) { 2431 if (!mHidden) { 2432 if (mHasMenu && mMenuVisible) { 2433 onOptionsMenuClosed(menu); 2434 } 2435 if (mChildFragmentManager != null) { 2436 mChildFragmentManager.dispatchOptionsMenuClosed(menu); 2437 } 2438 } 2439 } 2440 2441 void performSaveInstanceState(Bundle outState) { 2442 onSaveInstanceState(outState); 2443 if (mChildFragmentManager != null) { 2444 Parcelable p = mChildFragmentManager.saveAllState(); 2445 if (p != null) { 2446 outState.putParcelable(Activity.FRAGMENTS_TAG, p); 2447 } 2448 } 2449 } 2450 2451 void performPause() { 2452 if (mChildFragmentManager != null) { 2453 mChildFragmentManager.dispatchPause(); 2454 } 2455 mState = STARTED; 2456 mCalled = false; 2457 onPause(); 2458 if (!mCalled) { 2459 throw new SuperNotCalledException("Fragment " + this 2460 + " did not call through to super.onPause()"); 2461 } 2462 } 2463 2464 void performStop() { 2465 if (mChildFragmentManager != null) { 2466 mChildFragmentManager.dispatchStop(); 2467 } 2468 mState = STOPPED; 2469 mCalled = false; 2470 onStop(); 2471 if (!mCalled) { 2472 throw new SuperNotCalledException("Fragment " + this 2473 + " did not call through to super.onStop()"); 2474 } 2475 2476 if (mLoadersStarted) { 2477 mLoadersStarted = false; 2478 if (!mCheckedForLoaderManager) { 2479 mCheckedForLoaderManager = true; 2480 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, false); 2481 } 2482 if (mLoaderManager != null) { 2483 if (mHost.getRetainLoaders()) { 2484 mLoaderManager.doRetain(); 2485 } else { 2486 mLoaderManager.doStop(); 2487 } 2488 } 2489 } 2490 } 2491 2492 void performDestroyView() { 2493 if (mChildFragmentManager != null) { 2494 mChildFragmentManager.dispatchDestroyView(); 2495 } 2496 mState = CREATED; 2497 mCalled = false; 2498 onDestroyView(); 2499 if (!mCalled) { 2500 throw new SuperNotCalledException("Fragment " + this 2501 + " did not call through to super.onDestroyView()"); 2502 } 2503 if (mLoaderManager != null) { 2504 mLoaderManager.doReportNextStart(); 2505 } 2506 } 2507 2508 void performDestroy() { 2509 if (mChildFragmentManager != null) { 2510 mChildFragmentManager.dispatchDestroy(); 2511 } 2512 mState = INITIALIZING; 2513 mCalled = false; 2514 onDestroy(); 2515 if (!mCalled) { 2516 throw new SuperNotCalledException("Fragment " + this 2517 + " did not call through to super.onDestroy()"); 2518 } 2519 mChildFragmentManager = null; 2520 } 2521 2522 private static Transition loadTransition(Context context, TypedArray typedArray, 2523 Transition currentValue, Transition defaultValue, int id) { 2524 if (currentValue != defaultValue) { 2525 return currentValue; 2526 } 2527 int transitionId = typedArray.getResourceId(id, 0); 2528 Transition transition = defaultValue; 2529 if (transitionId != 0 && transitionId != com.android.internal.R.transition.no_transition) { 2530 TransitionInflater inflater = TransitionInflater.from(context); 2531 transition = inflater.inflateTransition(transitionId); 2532 if (transition instanceof TransitionSet && 2533 ((TransitionSet)transition).getTransitionCount() == 0) { 2534 transition = null; 2535 } 2536 } 2537 return transition; 2538 } 2539 2540} 2541