blob: e163b1c2ad230ba0e867ca1286ae6cb4547db6fc [file] [log] [blame]
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001/*
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
Chet Haasea18a86b2010-09-07 13:20:00 -070019import android.animation.Animator;
Svetoslavc6d1c342015-02-26 14:44:43 -080020import android.annotation.NonNull;
Tor Norbyed9273d62013-05-30 15:59:53 -070021import android.annotation.Nullable;
Tor Norbye7b9c9122013-05-30 16:48:33 -070022import android.annotation.StringRes;
Dianne Hackbornc68c9132011-07-29 01:25:18 -070023import android.content.ComponentCallbacks2;
Dianne Hackbornb1ad5972010-08-02 17:30:33 -070024import android.content.Context;
Dianne Hackborn6e8304e2010-05-14 00:42:53 -070025import android.content.Intent;
Dianne Hackborn2dedce62010-04-15 14:45:25 -070026import android.content.res.Configuration;
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -080027import android.content.res.Resources;
George Mountc03da0e2014-08-22 17:04:02 -070028import android.content.res.TypedArray;
Dianne Hackborn2dedce62010-04-15 14:45:25 -070029import android.os.Bundle;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070030import android.os.Parcel;
31import android.os.Parcelable;
George Mountc03da0e2014-08-22 17:04:02 -070032import android.transition.Transition;
33import android.transition.TransitionInflater;
34import android.transition.TransitionSet;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -070035import android.util.AndroidRuntimeException;
Dianne Hackborn3e82ba12013-07-16 13:23:55 -070036import android.util.ArrayMap;
Dianne Hackbornba51c3d2010-05-05 18:49:48 -070037import android.util.AttributeSet;
Dianne Hackborna2ea7472010-12-20 12:10:01 -080038import android.util.DebugUtils;
Dianne Hackborn03fcc332012-05-15 12:49:40 -070039import android.util.Log;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070040import android.util.SparseArray;
Adam Powell14874662013-07-18 19:42:41 -070041import android.util.SuperNotCalledException;
Dianne Hackborn5ddd1272010-06-12 10:15:28 -070042import android.view.ContextMenu;
Adam Powellf0f5fff2011-08-01 13:42:50 -070043import android.view.ContextMenu.ContextMenuInfo;
Dianne Hackborn2dedce62010-04-15 14:45:25 -070044import android.view.LayoutInflater;
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -070045import android.view.Menu;
46import android.view.MenuInflater;
47import android.view.MenuItem;
Dianne Hackborn2dedce62010-04-15 14:45:25 -070048import android.view.View;
Dianne Hackborn5ddd1272010-06-12 10:15:28 -070049import android.view.View.OnCreateContextMenuListener;
Adam Powellf0f5fff2011-08-01 13:42:50 -070050import android.view.ViewGroup;
Dianne Hackborn5ddd1272010-06-12 10:15:28 -070051import android.widget.AdapterView;
Dianne Hackborn2dedce62010-04-15 14:45:25 -070052
Dianne Hackborn625ac272010-09-17 18:29:22 -070053import java.io.FileDescriptor;
54import java.io.PrintWriter;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070055
56final class FragmentState implements Parcelable {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070057 final String mClassName;
Dianne Hackborn6e8304e2010-05-14 00:42:53 -070058 final int mIndex;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070059 final boolean mFromLayout;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070060 final int mFragmentId;
61 final int mContainerId;
62 final String mTag;
63 final boolean mRetainInstance;
Dianne Hackborn16f6e892011-04-15 19:00:20 -070064 final boolean mDetached;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -070065 final Bundle mArguments;
Todd Kennedyd6d18582015-07-23 10:19:46 -070066 final boolean mHidden;
George Mountc03da0e2014-08-22 17:04:02 -070067
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070068 Bundle mSavedFragmentState;
George Mountc03da0e2014-08-22 17:04:02 -070069
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070070 Fragment mInstance;
George Mountc03da0e2014-08-22 17:04:02 -070071
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070072 public FragmentState(Fragment frag) {
73 mClassName = frag.getClass().getName();
Dianne Hackborn6e8304e2010-05-14 00:42:53 -070074 mIndex = frag.mIndex;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070075 mFromLayout = frag.mFromLayout;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070076 mFragmentId = frag.mFragmentId;
77 mContainerId = frag.mContainerId;
78 mTag = frag.mTag;
79 mRetainInstance = frag.mRetainInstance;
Dianne Hackborn16f6e892011-04-15 19:00:20 -070080 mDetached = frag.mDetached;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -070081 mArguments = frag.mArguments;
Todd Kennedyd6d18582015-07-23 10:19:46 -070082 mHidden = frag.mHidden;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070083 }
George Mountc03da0e2014-08-22 17:04:02 -070084
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070085 public FragmentState(Parcel in) {
86 mClassName = in.readString();
Dianne Hackborn6e8304e2010-05-14 00:42:53 -070087 mIndex = in.readInt();
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070088 mFromLayout = in.readInt() != 0;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070089 mFragmentId = in.readInt();
90 mContainerId = in.readInt();
91 mTag = in.readString();
92 mRetainInstance = in.readInt() != 0;
Dianne Hackborn16f6e892011-04-15 19:00:20 -070093 mDetached = in.readInt() != 0;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -070094 mArguments = in.readBundle();
Todd Kennedyd6d18582015-07-23 10:19:46 -070095 mHidden = in.readInt() != 0;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070096 mSavedFragmentState = in.readBundle();
97 }
George Mountc03da0e2014-08-22 17:04:02 -070098
Todd Kennedya5fc6f02015-04-14 18:22:54 -070099 public Fragment instantiate(FragmentHostCallback host, Fragment parent) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700100 if (mInstance != null) {
101 return mInstance;
102 }
George Mountc03da0e2014-08-22 17:04:02 -0700103
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700104 final Context context = host.getContext();
Dianne Hackborn51642462010-10-28 10:32:37 -0700105 if (mArguments != null) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700106 mArguments.setClassLoader(context.getClassLoader());
Dianne Hackborn51642462010-10-28 10:32:37 -0700107 }
George Mountc03da0e2014-08-22 17:04:02 -0700108
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700109 mInstance = Fragment.instantiate(context, mClassName, mArguments);
George Mountc03da0e2014-08-22 17:04:02 -0700110
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700111 if (mSavedFragmentState != null) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700112 mSavedFragmentState.setClassLoader(context.getClassLoader());
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700113 mInstance.mSavedFragmentState = mSavedFragmentState;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700114 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700115 mInstance.setIndex(mIndex, parent);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -0700116 mInstance.mFromLayout = mFromLayout;
Dianne Hackborn352cc982011-01-04 11:34:18 -0800117 mInstance.mRestored = true;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700118 mInstance.mFragmentId = mFragmentId;
119 mInstance.mContainerId = mContainerId;
120 mInstance.mTag = mTag;
121 mInstance.mRetainInstance = mRetainInstance;
Dianne Hackborn16f6e892011-04-15 19:00:20 -0700122 mInstance.mDetached = mDetached;
Todd Kennedyd6d18582015-07-23 10:19:46 -0700123 mInstance.mHidden = mHidden;
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700124 mInstance.mFragmentManager = host.mFragmentManager;
Dianne Hackborn03fcc332012-05-15 12:49:40 -0700125 if (FragmentManagerImpl.DEBUG) Log.v(FragmentManagerImpl.TAG,
126 "Instantiated fragment " + mInstance);
127
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700128 return mInstance;
129 }
George Mountc03da0e2014-08-22 17:04:02 -0700130
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700131 public int describeContents() {
132 return 0;
133 }
134
135 public void writeToParcel(Parcel dest, int flags) {
136 dest.writeString(mClassName);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -0700137 dest.writeInt(mIndex);
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700138 dest.writeInt(mFromLayout ? 1 : 0);
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700139 dest.writeInt(mFragmentId);
140 dest.writeInt(mContainerId);
141 dest.writeString(mTag);
142 dest.writeInt(mRetainInstance ? 1 : 0);
Dianne Hackborn16f6e892011-04-15 19:00:20 -0700143 dest.writeInt(mDetached ? 1 : 0);
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700144 dest.writeBundle(mArguments);
Todd Kennedyd6d18582015-07-23 10:19:46 -0700145 dest.writeInt(mHidden ? 1 : 0);
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700146 dest.writeBundle(mSavedFragmentState);
147 }
George Mountc03da0e2014-08-22 17:04:02 -0700148
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700149 public static final Parcelable.Creator<FragmentState> CREATOR
150 = new Parcelable.Creator<FragmentState>() {
151 public FragmentState createFromParcel(Parcel in) {
152 return new FragmentState(in);
153 }
George Mountc03da0e2014-08-22 17:04:02 -0700154
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700155 public FragmentState[] newArray(int size) {
156 return new FragmentState[size];
157 }
158 };
159}
160
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700161/**
162 * A Fragment is a piece of an application's user interface or behavior
Dianne Hackborn291905e2010-08-17 15:17:15 -0700163 * 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
felipeal1b4e4b62012-02-27 12:09:13 -0800169 * results. In its core, it represents a particular operation or interface
Dianne Hackborn291905e2010-08-17 15:17:15 -0700170 * 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 *
Jeff Davidson2a129782014-09-09 18:10:57 -0700176 * <p>All subclasses of Fragment must include a public no-argument constructor.
Dianne Hackborn291905e2010-08-17 15:17:15 -0700177 * 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
Jeff Davidson2a129782014-09-09 18:10:57 -0700179 * 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.
Dianne Hackborn291905e2010-08-17 15:17:15 -0700182 *
183 * <p>Topics covered here:
184 * <ol>
Dianne Hackbornf9dd34f2011-04-19 18:44:03 -0700185 * <li><a href="#OlderPlatforms">Older Platforms</a>
Dianne Hackborn291905e2010-08-17 15:17:15 -0700186 * <li><a href="#Lifecycle">Lifecycle</a>
187 * <li><a href="#Layout">Layout</a>
188 * <li><a href="#BackStack">Back Stack</a>
189 * </ol>
190 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -0700191 * <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 *
Dianne Hackbornf9dd34f2011-04-19 18:44:03 -0700197 * <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
Dianne Hackborn7871bad2011-12-12 15:19:26 -0800202 * at is also available for use on older platforms through
203 * {@link android.support.v4.app.FragmentActivity}. See the blog post
Dianne Hackbornf9dd34f2011-04-19 18:44:03 -0700204 * <a href="http://android-developers.blogspot.com/2011/03/fragments-for-all.html">
205 * Fragments For All</a> for more details.
206 *
Dianne Hackborn291905e2010-08-17 15:17:15 -0700207 * <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
Quddus Chong37900012012-04-11 11:57:50 -0700224 * completed its own {@link Activity#onCreate Activity.onCreate()}.
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700225 * <li> {@link #onViewStateRestored} tells the fragment that all of the saved
226 * state of its view hierarchy has been restored.
Dianne Hackborn291905e2010-08-17 15:17:15 -0700227 * <li> {@link #onStart} makes the fragment visible to the user (based on its
228 * containing activity being started).
Mark Dolinerd0646dc2014-08-27 16:04:02 -0700229 * <li> {@link #onResume} makes the fragment begin interacting with the user
230 * (based on its containing activity being resumed).
Dianne Hackborn291905e2010-08-17 15:17:15 -0700231 * </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>&lt;fragment&gt;</code> tags
260 * to embed fragment instances inside of the layout. For example, here is
Dianne Hackborn625ac272010-09-17 18:29:22 -0700261 * a simple layout that embeds one fragment:</p>
Dianne Hackborn291905e2010-08-17 15:17:15 -0700262 *
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 *
Dianne Hackborn87121ac2011-01-04 17:26:23 -0800270 * <p>The titles fragment, showing a list of titles, is fairly simple, relying
Dianne Hackborn291905e2010-08-17 15:17:15 -0700271 * on {@link ListFragment} for most of its work. Note the implementation of
Dianne Hackborn87121ac2011-01-04 17:26:23 -0800272 * 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
Ben Dodson542f2402011-06-14 16:40:23 -0700274 * this later), or start a new activity to show the details.</p>
Dianne Hackborn291905e2010-08-17 15:17:15 -0700275 *
276 * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/FragmentLayout.java
277 * titles}
278 *
Ben Dodson542f2402011-06-14 16:40:23 -0700279 * <p>The details fragment showing the contents of a selected item just
Dianne Hackborn291905e2010-08-17 15:17:15 -0700280 * 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
Ben Dodson542f2402011-06-14 16:40:23 -0700287 * container in the current activity, so the titles fragment's click code will
Dianne Hackborn291905e2010-08-17 15:17:15 -0700288 * 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 *
Dianne Hackborn87121ac2011-01-04 17:26:23 -0800299 * <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.
Dianne Hackborn291905e2010-08-17 15:17:15 -0700303 *
Dianne Hackborn625ac272010-09-17 18:29:22 -0700304 * <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
Dianne Hackborn87121ac2011-01-04 17:26:23 -0800308 * instance. However, any that are no longer associated with a &lt;fragment&gt;
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.)
George Mountc03da0e2014-08-22 17:04:02 -0700314 *
Dianne Hackborn625ac272010-09-17 18:29:22 -0700315 * <p>The attributes of the &lt;fragment&gt; tag are used to control the
Dianne Hackborn87121ac2011-01-04 17:26:23 -0800316 * LayoutParams provided when attaching the fragment's view to the parent
317 * container. They can also be parsed by the fragment in {@link #onInflate}
Dianne Hackborn625ac272010-09-17 18:29:22 -0700318 * as parameters.
George Mountc03da0e2014-08-22 17:04:02 -0700319 *
Dianne Hackborn625ac272010-09-17 18:29:22 -0700320 * <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:
George Mountc03da0e2014-08-22 17:04:02 -0700324 *
Dianne Hackborn625ac272010-09-17 18:29:22 -0700325 * <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 &lt;fragment&gt; to provide
329 * a specific tag name for the fragment.
330 * <li><code>android:id</code> can be used in &lt;fragment&gt; to provide
331 * a specific identifier for the fragment.
332 * </ul>
George Mountc03da0e2014-08-22 17:04:02 -0700333 *
Dianne Hackborn291905e2010-08-17 15:17:15 -0700334 * <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.
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700358 */
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700359public class Fragment implements ComponentCallbacks2, OnCreateContextMenuListener {
Dianne Hackborn3e82ba12013-07-16 13:23:55 -0700360 private static final ArrayMap<String, Class<?>> sClassMap =
361 new ArrayMap<String, Class<?>>();
George Mountc03da0e2014-08-22 17:04:02 -0700362
Adam Powell635c60a2011-10-26 10:22:16 -0700363 static final int INVALID_STATE = -1; // Invalid state used as a null value.
Dianne Hackbornc8017682010-07-06 13:34:38 -0700364 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.
Dianne Hackborn16f6e892011-04-15 19:00:20 -0700367 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.
George Mountc03da0e2014-08-22 17:04:02 -0700370
371 private static final Transition USE_DEFAULT_TRANSITION = new TransitionSet();
372
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700373 int mState = INITIALIZING;
George Mountc03da0e2014-08-22 17:04:02 -0700374
Dianne Hackbornd173fa32010-12-23 13:58:22 -0800375 // 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
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700384 // When instantiated from saved state, this is the saved state.
385 Bundle mSavedFragmentState;
386 SparseArray<Parcelable> mSavedViewState;
George Mountc03da0e2014-08-22 17:04:02 -0700387
Dianne Hackborn6e8304e2010-05-14 00:42:53 -0700388 // Index into active fragment array.
389 int mIndex = -1;
George Mountc03da0e2014-08-22 17:04:02 -0700390
Dianne Hackborn6e8304e2010-05-14 00:42:53 -0700391 // Internal unique name for this fragment;
392 String mWho;
George Mountc03da0e2014-08-22 17:04:02 -0700393
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700394 // Construction arguments;
395 Bundle mArguments;
396
Dianne Hackborndef15372010-08-15 12:43:52 -0700397 // Target fragment.
398 Fragment mTarget;
399
Dianne Hackbornf9302322011-06-14 18:36:14 -0700400 // For use when retaining a fragment: this is the index of the last mTarget.
401 int mTargetIndex = -1;
402
Dianne Hackborndef15372010-08-15 12:43:52 -0700403 // Target request code.
404 int mTargetRequestCode;
405
Dianne Hackborn6e8304e2010-05-14 00:42:53 -0700406 // True if the fragment is in the list of added fragments.
407 boolean mAdded;
George Mountc03da0e2014-08-22 17:04:02 -0700408
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -0800409 // If set this fragment is being removed from its activity.
410 boolean mRemoving;
411
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700412 // Set to true if this fragment was instantiated from a layout file.
413 boolean mFromLayout;
George Mountc03da0e2014-08-22 17:04:02 -0700414
Dianne Hackborn625ac272010-09-17 18:29:22 -0700415 // Set to true when the view has actually been inflated in its layout.
416 boolean mInLayout;
417
Dianne Hackborn352cc982011-01-04 11:34:18 -0800418 // True if this fragment has been restored from previously saved state.
419 boolean mRestored;
George Mountc03da0e2014-08-22 17:04:02 -0700420
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700421 // Number of active back stack entries this fragment is in.
Dianne Hackbornf121be72010-05-06 14:10:32 -0700422 int mBackStackNesting;
George Mountc03da0e2014-08-22 17:04:02 -0700423
Dianne Hackborn3e449ce2010-09-11 20:52:31 -0700424 // 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.
Adam Powell635c60a2011-10-26 10:22:16 -0700427 FragmentManagerImpl mFragmentManager;
Dianne Hackborn3e449ce2010-09-11 20:52:31 -0700428
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700429 // Activity this fragment is attached to.
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700430 FragmentHostCallback mHost;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700431
432 // Private fragment manager for child fragments inside of this one.
433 FragmentManagerImpl mChildFragmentManager;
434
435 // If this Fragment is contained in another Fragment, this is that container.
436 Fragment mParentFragment;
437
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700438 // The optional identifier for this fragment -- either the container ID if it
439 // was dynamically added to the view hierarchy, or the ID supplied in
440 // layout.
441 int mFragmentId;
George Mountc03da0e2014-08-22 17:04:02 -0700442
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700443 // When a fragment is being dynamically added to the view hierarchy, this
444 // is the identifier of the parent container it is being added to.
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700445 int mContainerId;
George Mountc03da0e2014-08-22 17:04:02 -0700446
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700447 // The optional named tag for this fragment -- usually used to find
448 // fragments that are not part of the layout.
449 String mTag;
George Mountc03da0e2014-08-22 17:04:02 -0700450
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700451 // Set to true when the app has requested that this fragment be hidden
452 // from the user.
453 boolean mHidden;
George Mountc03da0e2014-08-22 17:04:02 -0700454
Dianne Hackborn16f6e892011-04-15 19:00:20 -0700455 // Set to true when the app has requested that this fragment be detached.
456 boolean mDetached;
457
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700458 // If set this fragment would like its instance retained across
459 // configuration changes.
460 boolean mRetainInstance;
George Mountc03da0e2014-08-22 17:04:02 -0700461
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700462 // If set this fragment is being retained across the current config change.
463 boolean mRetaining;
George Mountc03da0e2014-08-22 17:04:02 -0700464
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700465 // If set this fragment has menu items to contribute.
466 boolean mHasMenu;
Dianne Hackborn6c285972011-08-29 16:53:49 -0700467
468 // Set to true to allow the fragment's menu to be shown.
469 boolean mMenuVisible = true;
470
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700471 // Used to verify that subclasses call through to super class.
472 boolean mCalled;
George Mountc03da0e2014-08-22 17:04:02 -0700473
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700474 // If app has requested a specific animation, this is the one to use.
475 int mNextAnim;
George Mountc03da0e2014-08-22 17:04:02 -0700476
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700477 // The parent container of the fragment after dynamically added to UI.
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700478 ViewGroup mContainer;
George Mountc03da0e2014-08-22 17:04:02 -0700479
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700480 // The View generated for this fragment.
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700481 View mView;
George Mountc03da0e2014-08-22 17:04:02 -0700482
Adam Powell635c60a2011-10-26 10:22:16 -0700483 // Whether this fragment should defer starting until after other fragments
484 // have been started and their loaders are finished.
485 boolean mDeferStart;
486
Adam Powell78fed9b2011-11-07 10:45:34 -0800487 // Hint provided by the app that this fragment is currently visible to the user.
488 boolean mUserVisibleHint = true;
489
Dianne Hackborn4911b782010-07-15 12:54:39 -0700490 LoaderManagerImpl mLoaderManager;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700491 boolean mLoadersStarted;
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700492 boolean mCheckedForLoaderManager;
George Mountc03da0e2014-08-22 17:04:02 -0700493
494 private Transition mEnterTransition = null;
495 private Transition mReturnTransition = USE_DEFAULT_TRANSITION;
496 private Transition mExitTransition = null;
497 private Transition mReenterTransition = USE_DEFAULT_TRANSITION;
498 private Transition mSharedElementEnterTransition = null;
499 private Transition mSharedElementReturnTransition = USE_DEFAULT_TRANSITION;
500 private Boolean mAllowReturnTransitionOverlap;
501 private Boolean mAllowEnterTransitionOverlap;
502
George Mount65580562014-08-29 08:15:48 -0700503 SharedElementCallback mEnterTransitionCallback = SharedElementCallback.NULL_CALLBACK;
504 SharedElementCallback mExitTransitionCallback = SharedElementCallback.NULL_CALLBACK;
George Mountc03da0e2014-08-22 17:04:02 -0700505
Dianne Hackbornc8017682010-07-06 13:34:38 -0700506 /**
Dianne Hackbornb46ed762011-06-02 18:33:15 -0700507 * State information that has been retrieved from a fragment instance
508 * through {@link FragmentManager#saveFragmentInstanceState(Fragment)
509 * FragmentManager.saveFragmentInstanceState}.
510 */
511 public static class SavedState implements Parcelable {
512 final Bundle mState;
513
514 SavedState(Bundle state) {
515 mState = state;
516 }
517
518 SavedState(Parcel in, ClassLoader loader) {
519 mState = in.readBundle();
520 if (loader != null && mState != null) {
521 mState.setClassLoader(loader);
522 }
523 }
524
525 @Override
526 public int describeContents() {
527 return 0;
528 }
529
530 @Override
531 public void writeToParcel(Parcel dest, int flags) {
532 dest.writeBundle(mState);
533 }
534
535 public static final Parcelable.ClassLoaderCreator<SavedState> CREATOR
536 = new Parcelable.ClassLoaderCreator<SavedState>() {
537 public SavedState createFromParcel(Parcel in) {
538 return new SavedState(in, null);
539 }
540
541 public SavedState createFromParcel(Parcel in, ClassLoader loader) {
542 return new SavedState(in, loader);
543 }
544
545 public SavedState[] newArray(int size) {
546 return new SavedState[size];
547 }
548 };
549 }
550
551 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700552 * Thrown by {@link Fragment#instantiate(Context, String, Bundle)} when
553 * there is an instantiation failure.
554 */
555 static public class InstantiationException extends AndroidRuntimeException {
556 public InstantiationException(String msg, Exception cause) {
557 super(msg, cause);
558 }
559 }
560
561 /**
Dianne Hackborn291905e2010-08-17 15:17:15 -0700562 * Default constructor. <strong>Every</strong> fragment must have an
Dianne Hackbornc8017682010-07-06 13:34:38 -0700563 * empty constructor, so it can be instantiated when restoring its
564 * activity's state. It is strongly recommended that subclasses do not
565 * have other constructors with parameters, since these constructors
566 * will not be called when the fragment is re-instantiated; instead,
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700567 * arguments can be supplied by the caller with {@link #setArguments}
568 * and later retrieved by the Fragment with {@link #getArguments}.
George Mountc03da0e2014-08-22 17:04:02 -0700569 *
Dianne Hackborn291905e2010-08-17 15:17:15 -0700570 * <p>Applications should generally not implement a constructor. The
Mark Dolinerd0646dc2014-08-27 16:04:02 -0700571 * first place application code can run where the fragment is ready to
Dianne Hackborn291905e2010-08-17 15:17:15 -0700572 * be used is in {@link #onAttach(Activity)}, the point where the fragment
573 * is actually associated with its activity. Some applications may also
574 * want to implement {@link #onInflate} to retrieve attributes from a
575 * layout resource, though should take care here because this happens for
576 * the fragment is attached to its activity.
Dianne Hackbornc8017682010-07-06 13:34:38 -0700577 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700578 public Fragment() {
579 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700580
Dianne Hackbornb1ad5972010-08-02 17:30:33 -0700581 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700582 * Like {@link #instantiate(Context, String, Bundle)} but with a null
583 * argument Bundle.
584 */
585 public static Fragment instantiate(Context context, String fname) {
586 return instantiate(context, fname, null);
587 }
588
589 /**
Dianne Hackbornb1ad5972010-08-02 17:30:33 -0700590 * Create a new instance of a Fragment with the given class name. This is
591 * the same as calling its empty constructor.
592 *
593 * @param context The calling context being used to instantiate the fragment.
594 * This is currently just used to get its ClassLoader.
595 * @param fname The class name of the fragment to instantiate.
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700596 * @param args Bundle of arguments to supply to the fragment, which it
597 * can retrieve with {@link #getArguments()}. May be null.
Dianne Hackbornb1ad5972010-08-02 17:30:33 -0700598 * @return Returns a new fragment instance.
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700599 * @throws InstantiationException If there is a failure in instantiating
600 * the given fragment class. This is a runtime exception; it is not
601 * normally expected to happen.
Dianne Hackbornb1ad5972010-08-02 17:30:33 -0700602 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700603 public static Fragment instantiate(Context context, String fname, @Nullable Bundle args) {
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700604 try {
605 Class<?> clazz = sClassMap.get(fname);
606 if (clazz == null) {
607 // Class not found in the cache, see if it's real, and try to add it
608 clazz = context.getClassLoader().loadClass(fname);
Amith Yamasani364ed4d2013-07-26 13:37:56 -0700609 if (!Fragment.class.isAssignableFrom(clazz)) {
610 throw new InstantiationException("Trying to instantiate a class " + fname
611 + " that is not a Fragment", new ClassCastException());
612 }
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700613 sClassMap.put(fname, clazz);
614 }
615 Fragment f = (Fragment)clazz.newInstance();
616 if (args != null) {
617 args.setClassLoader(f.getClass().getClassLoader());
618 f.mArguments = args;
619 }
620 return f;
621 } catch (ClassNotFoundException e) {
622 throw new InstantiationException("Unable to instantiate fragment " + fname
623 + ": make sure class name exists, is public, and has an"
624 + " empty constructor that is public", e);
625 } catch (java.lang.InstantiationException 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 (IllegalAccessException 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);
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700633 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700634 }
George Mountc03da0e2014-08-22 17:04:02 -0700635
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700636 final void restoreViewState(Bundle savedInstanceState) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700637 if (mSavedViewState != null) {
638 mView.restoreHierarchyState(mSavedViewState);
639 mSavedViewState = null;
640 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700641 mCalled = false;
642 onViewStateRestored(savedInstanceState);
643 if (!mCalled) {
644 throw new SuperNotCalledException("Fragment " + this
645 + " did not call through to super.onViewStateRestored()");
646 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700647 }
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -0700648
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700649 final void setIndex(int index, Fragment parent) {
Dianne Hackborn6e8304e2010-05-14 00:42:53 -0700650 mIndex = index;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700651 if (parent != null) {
652 mWho = parent.mWho + ":" + mIndex;
653 } else {
654 mWho = "android:fragment:" + mIndex;
655 }
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -0700656 }
657
Dianne Hackborn16f6e892011-04-15 19:00:20 -0700658 final boolean isInBackStack() {
659 return mBackStackNesting > 0;
660 }
661
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700662 /**
663 * Subclasses can not override equals().
664 */
665 @Override final public boolean equals(Object o) {
666 return super.equals(o);
667 }
668
669 /**
670 * Subclasses can not override hashCode().
671 */
672 @Override final public int hashCode() {
673 return super.hashCode();
674 }
George Mountc03da0e2014-08-22 17:04:02 -0700675
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700676 @Override
677 public String toString() {
678 StringBuilder sb = new StringBuilder(128);
Dianne Hackborna2ea7472010-12-20 12:10:01 -0800679 DebugUtils.buildShortClassTag(this, sb);
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700680 if (mIndex >= 0) {
681 sb.append(" #");
682 sb.append(mIndex);
683 }
684 if (mFragmentId != 0) {
685 sb.append(" id=0x");
686 sb.append(Integer.toHexString(mFragmentId));
687 }
688 if (mTag != null) {
689 sb.append(" ");
690 sb.append(mTag);
691 }
692 sb.append('}');
693 return sb.toString();
694 }
George Mountc03da0e2014-08-22 17:04:02 -0700695
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700696 /**
697 * Return the identifier this fragment is known by. This is either
698 * the android:id value supplied in a layout or the container view ID
699 * supplied when adding the fragment.
700 */
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700701 final public int getId() {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700702 return mFragmentId;
703 }
George Mountc03da0e2014-08-22 17:04:02 -0700704
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700705 /**
706 * Get the tag name of the fragment, if specified.
707 */
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700708 final public String getTag() {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700709 return mTag;
710 }
George Mountc03da0e2014-08-22 17:04:02 -0700711
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700712 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700713 * Supply the construction arguments for this fragment. This can only
714 * be called before the fragment has been attached to its activity; that
715 * is, you should call it immediately after constructing the fragment. The
716 * arguments supplied here will be retained across fragment destroy and
717 * creation.
718 */
Dianne Hackborndef15372010-08-15 12:43:52 -0700719 public void setArguments(Bundle args) {
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700720 if (mIndex >= 0) {
721 throw new IllegalStateException("Fragment already active");
722 }
723 mArguments = args;
724 }
725
726 /**
Mark Dolinerd0646dc2014-08-27 16:04:02 -0700727 * Return the arguments supplied to {@link #setArguments}, if any.
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700728 */
729 final public Bundle getArguments() {
730 return mArguments;
731 }
732
733 /**
Dianne Hackbornb46ed762011-06-02 18:33:15 -0700734 * Set the initial saved state that this Fragment should restore itself
735 * from when first being constructed, as returned by
736 * {@link FragmentManager#saveFragmentInstanceState(Fragment)
737 * FragmentManager.saveFragmentInstanceState}.
738 *
739 * @param state The state the fragment should be restored from.
740 */
741 public void setInitialSavedState(SavedState state) {
742 if (mIndex >= 0) {
743 throw new IllegalStateException("Fragment already active");
744 }
745 mSavedFragmentState = state != null && state.mState != null
746 ? state.mState : null;
747 }
748
749 /**
Dianne Hackborndef15372010-08-15 12:43:52 -0700750 * Optional target for this fragment. This may be used, for example,
751 * if this fragment is being started by another, and when done wants to
752 * give a result back to the first. The target set here is retained
753 * across instances via {@link FragmentManager#putFragment
754 * FragmentManager.putFragment()}.
755 *
756 * @param fragment The fragment that is the target of this one.
757 * @param requestCode Optional request code, for convenience if you
758 * are going to call back with {@link #onActivityResult(int, int, Intent)}.
759 */
760 public void setTargetFragment(Fragment fragment, int requestCode) {
761 mTarget = fragment;
762 mTargetRequestCode = requestCode;
763 }
764
765 /**
Dianne Hackborn3f00be52010-08-15 18:03:27 -0700766 * Return the target fragment set by {@link #setTargetFragment}.
Dianne Hackborndef15372010-08-15 12:43:52 -0700767 */
768 final public Fragment getTargetFragment() {
769 return mTarget;
770 }
771
772 /**
Dianne Hackborn3f00be52010-08-15 18:03:27 -0700773 * Return the target request code set by {@link #setTargetFragment}.
Dianne Hackborndef15372010-08-15 12:43:52 -0700774 */
775 final public int getTargetRequestCode() {
776 return mTargetRequestCode;
777 }
778
779 /**
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700780 * Return the {@link Context} this fragment is currently associated with.
781 */
782 public Context getContext() {
783 return mHost == null ? null : mHost.getContext();
784 }
785
786 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700787 * Return the Activity this fragment is currently associated with.
788 */
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700789 final public Activity getActivity() {
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700790 return mHost == null ? null : mHost.getActivity();
791 }
792
793 /**
794 * Return the host object of this fragment. May return {@code null} if the fragment
795 * isn't currently being hosted.
796 */
797 @Nullable
798 final public Object getHost() {
799 return mHost == null ? null : mHost.onGetHost();
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700800 }
George Mountc03da0e2014-08-22 17:04:02 -0700801
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700802 /**
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -0800803 * Return <code>getActivity().getResources()</code>.
804 */
805 final public Resources getResources() {
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700806 if (mHost == null) {
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -0800807 throw new IllegalStateException("Fragment " + this + " not attached to Activity");
808 }
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700809 return mHost.getContext().getResources();
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -0800810 }
George Mountc03da0e2014-08-22 17:04:02 -0700811
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -0800812 /**
813 * Return a localized, styled CharSequence from the application's package's
814 * default string table.
815 *
816 * @param resId Resource id for the CharSequence text
817 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700818 public final CharSequence getText(@StringRes int resId) {
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -0800819 return getResources().getText(resId);
820 }
821
822 /**
823 * Return a localized string from the application's package's
824 * default string table.
825 *
826 * @param resId Resource id for the string
827 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700828 public final String getString(@StringRes int resId) {
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -0800829 return getResources().getString(resId);
830 }
831
832 /**
833 * Return a localized formatted string from the application's package's
834 * default string table, substituting the format arguments as defined in
835 * {@link java.util.Formatter} and {@link java.lang.String#format}.
836 *
837 * @param resId Resource id for the format string
838 * @param formatArgs The format arguments that will be used for substitution.
839 */
840
Tor Norbye7b9c9122013-05-30 16:48:33 -0700841 public final String getString(@StringRes int resId, Object... formatArgs) {
Dianne Hackbornbdd19bc2010-11-10 23:27:54 -0800842 return getResources().getString(resId, formatArgs);
843 }
844
845 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700846 * Return the FragmentManager for interacting with fragments associated
Dianne Hackborn3e449ce2010-09-11 20:52:31 -0700847 * with this fragment's activity. Note that this will be non-null slightly
Dianne Hackborn625ac272010-09-17 18:29:22 -0700848 * before {@link #getActivity()}, during the time from when the fragment is
Dianne Hackborn3e449ce2010-09-11 20:52:31 -0700849 * placed in a {@link FragmentTransaction} until it is committed and
850 * attached to its activity.
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700851 *
852 * <p>If this Fragment is a child of another Fragment, the FragmentManager
853 * returned here will be the parent's {@link #getChildFragmentManager()}.
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700854 */
855 final public FragmentManager getFragmentManager() {
Dianne Hackborn3e449ce2010-09-11 20:52:31 -0700856 return mFragmentManager;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700857 }
858
859 /**
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700860 * Return a private FragmentManager for placing and managing Fragments
861 * inside of this Fragment.
862 */
863 final public FragmentManager getChildFragmentManager() {
864 if (mChildFragmentManager == null) {
865 instantiateChildFragmentManager();
866 if (mState >= RESUMED) {
867 mChildFragmentManager.dispatchResume();
868 } else if (mState >= STARTED) {
869 mChildFragmentManager.dispatchStart();
870 } else if (mState >= ACTIVITY_CREATED) {
871 mChildFragmentManager.dispatchActivityCreated();
872 } else if (mState >= CREATED) {
873 mChildFragmentManager.dispatchCreate();
874 }
875 }
876 return mChildFragmentManager;
877 }
878
879 /**
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -0700880 * Returns the parent Fragment containing this Fragment. If this Fragment
881 * is attached directly to an Activity, returns null.
882 */
883 final public Fragment getParentFragment() {
884 return mParentFragment;
885 }
886
887 /**
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700888 * Return true if the fragment is currently added to its activity.
889 */
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700890 final public boolean isAdded() {
Todd Kennedya5fc6f02015-04-14 18:22:54 -0700891 return mHost != null && mAdded;
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -0800892 }
893
894 /**
Dianne Hackbornafc4b282011-06-10 17:03:42 -0700895 * Return true if the fragment has been explicitly detached from the UI.
896 * That is, {@link FragmentTransaction#detach(Fragment)
897 * FragmentTransaction.detach(Fragment)} has been used on it.
898 */
899 final public boolean isDetached() {
900 return mDetached;
901 }
902
903 /**
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -0800904 * Return true if this fragment is currently being removed from its
905 * activity. This is <em>not</em> whether its activity is finishing, but
906 * rather whether it is in the process of being removed from its activity.
907 */
908 final public boolean isRemoving() {
909 return mRemoving;
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700910 }
George Mountc03da0e2014-08-22 17:04:02 -0700911
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700912 /**
Dianne Hackborn625ac272010-09-17 18:29:22 -0700913 * Return true if the layout is included as part of an activity view
914 * hierarchy via the &lt;fragment&gt; tag. This will always be true when
915 * fragments are created through the &lt;fragment&gt; tag, <em>except</em>
916 * in the case where an old fragment is restored from a previous state and
917 * it does not appear in the layout of the current state.
918 */
919 final public boolean isInLayout() {
920 return mInLayout;
921 }
922
923 /**
Dianne Hackborn2707d602010-07-09 18:01:20 -0700924 * Return true if the fragment is in the resumed state. This is true
925 * for the duration of {@link #onResume()} and {@link #onPause()} as well.
926 */
927 final public boolean isResumed() {
Adam Powelld1d4d9c2016-01-12 10:11:42 -0800928 return mState >= RESUMED;
Dianne Hackborn2707d602010-07-09 18:01:20 -0700929 }
George Mountc03da0e2014-08-22 17:04:02 -0700930
Dianne Hackborn2707d602010-07-09 18:01:20 -0700931 /**
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700932 * Return true if the fragment is currently visible to the user. This means
933 * it: (1) has been added, (2) has its view attached to the window, and
934 * (3) is not hidden.
935 */
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700936 final public boolean isVisible() {
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700937 return isAdded() && !isHidden() && mView != null
938 && mView.getWindowToken() != null && mView.getVisibility() == View.VISIBLE;
939 }
George Mountc03da0e2014-08-22 17:04:02 -0700940
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700941 /**
942 * Return true if the fragment has been hidden. By default fragments
943 * are shown. You can find out about changes to this state with
Dianne Hackborncddfa6d2010-05-19 22:56:37 -0700944 * {@link #onHiddenChanged}. Note that the hidden state is orthogonal
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700945 * to other states -- that is, to be visible to the user, a fragment
946 * must be both started and not hidden.
947 */
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700948 final public boolean isHidden() {
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700949 return mHidden;
950 }
George Mountc03da0e2014-08-22 17:04:02 -0700951
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700952 /**
953 * Called when the hidden state (as returned by {@link #isHidden()} of
954 * the fragment has changed. Fragments start out not hidden; this will
955 * be called whenever the fragment changes state from that.
956 * @param hidden True if the fragment is now hidden, false if it is not
957 * visible.
958 */
959 public void onHiddenChanged(boolean hidden) {
960 }
George Mountc03da0e2014-08-22 17:04:02 -0700961
Dianne Hackborn5ae74d62010-05-19 19:14:57 -0700962 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700963 * Control whether a fragment instance is retained across Activity
964 * re-creation (such as from a configuration change). This can only
965 * be used with fragments not in the back stack. If set, the fragment
966 * lifecycle will be slightly different when an activity is recreated:
967 * <ul>
968 * <li> {@link #onDestroy()} will not be called (but {@link #onDetach()} still
969 * will be, because the fragment is being detached from its current activity).
970 * <li> {@link #onCreate(Bundle)} will not be called since the fragment
971 * is not being re-created.
Dianne Hackbornc8017682010-07-06 13:34:38 -0700972 * <li> {@link #onAttach(Activity)} and {@link #onActivityCreated(Bundle)} <b>will</b>
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700973 * still be called.
974 * </ul>
975 */
976 public void setRetainInstance(boolean retain) {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700977 if (retain && mParentFragment != null) {
978 throw new IllegalStateException(
979 "Can't retain fragements that are nested in other fragments");
980 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700981 mRetainInstance = retain;
982 }
George Mountc03da0e2014-08-22 17:04:02 -0700983
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700984 final public boolean getRetainInstance() {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700985 return mRetainInstance;
986 }
George Mountc03da0e2014-08-22 17:04:02 -0700987
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700988 /**
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700989 * Report that this fragment would like to participate in populating
Wink Saville4dc643e2010-06-12 22:16:41 -0700990 * the options menu by receiving a call to {@link #onCreateOptionsMenu}
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700991 * and related methods.
George Mountc03da0e2014-08-22 17:04:02 -0700992 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -0700993 * @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;
Adam Powellf0f5fff2011-08-01 13:42:50 -0700998 if (isAdded() && !isHidden()) {
999 mFragmentManager.invalidateOptionsMenu();
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001000 }
1001 }
1002 }
Dianne Hackborn6c285972011-08-29 16:53:49 -07001003
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
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001022 /**
Adam Powell78fed9b2011-11-07 10:45:34 -08001023 * 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.
Adam Powell635c60a2011-10-26 10:22:16 -07001026 *
Adam Powell78fed9b2011-11-07 10:45:34 -08001027 * <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>
Adam Powell635c60a2011-10-26 10:22:16 -07001031 *
Adam Powell78fed9b2011-11-07 10:45:34 -08001032 * @param isVisibleToUser true if this fragment's UI is currently visible to the user (default),
1033 * false if it is not.
Adam Powell635c60a2011-10-26 10:22:16 -07001034 */
Adam Powell78fed9b2011-11-07 10:45:34 -08001035 public void setUserVisibleHint(boolean isVisibleToUser) {
1036 if (!mUserVisibleHint && isVisibleToUser && mState < STARTED) {
Adam Powell635c60a2011-10-26 10:22:16 -07001037 mFragmentManager.performPendingDeferredStart(this);
1038 }
Adam Powell78fed9b2011-11-07 10:45:34 -08001039 mUserVisibleHint = isVisibleToUser;
1040 mDeferStart = !isVisibleToUser;
Adam Powell635c60a2011-10-26 10:22:16 -07001041 }
1042
1043 /**
Adam Powell78fed9b2011-11-07 10:45:34 -08001044 * @return The current value of the user-visible hint on this fragment.
1045 * @see #setUserVisibleHint(boolean)
Adam Powell635c60a2011-10-26 10:22:16 -07001046 */
Adam Powell78fed9b2011-11-07 10:45:34 -08001047 public boolean getUserVisibleHint() {
1048 return mUserVisibleHint;
Adam Powell635c60a2011-10-26 10:22:16 -07001049 }
1050
1051 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -07001052 * Return the LoaderManager for this fragment, creating it if needed.
1053 */
1054 public LoaderManager getLoaderManager() {
1055 if (mLoaderManager != null) {
1056 return mLoaderManager;
1057 }
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001058 if (mHost == null) {
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -08001059 throw new IllegalStateException("Fragment " + this + " not attached to Activity");
1060 }
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001061 mCheckedForLoaderManager = true;
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001062 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, true);
Dianne Hackbornc8017682010-07-06 13:34:38 -07001063 return mLoaderManager;
1064 }
Dianne Hackborna4972e92012-03-14 10:38:05 -07001065
Dianne Hackbornc8017682010-07-06 13:34:38 -07001066 /**
Scott Main87bff972013-02-27 15:46:34 -08001067 * Call {@link Activity#startActivity(Intent)} from the fragment's
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001068 * containing Activity.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001069 *
1070 * @param intent The intent to start.
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001071 */
1072 public void startActivity(Intent intent) {
Dianne Hackborna4972e92012-03-14 10:38:05 -07001073 startActivity(intent, null);
1074 }
George Mountc03da0e2014-08-22 17:04:02 -07001075
Dianne Hackborna4972e92012-03-14 10:38:05 -07001076 /**
Scott Main87bff972013-02-27 15:46:34 -08001077 * Call {@link Activity#startActivity(Intent, Bundle)} from the fragment's
Dianne Hackborna4972e92012-03-14 10:38:05 -07001078 * containing Activity.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001079 *
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.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001084 */
1085 public void startActivity(Intent intent, Bundle options) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001086 if (mHost == null) {
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -08001087 throw new IllegalStateException("Fragment " + this + " not attached to Activity");
1088 }
Dianne Hackborna4972e92012-03-14 10:38:05 -07001089 if (options != null) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001090 mHost.onStartActivityFromFragment(this, intent, -1, options);
Dianne Hackborna4972e92012-03-14 10:38:05 -07001091 } else {
1092 // Note we want to go through this call for compatibility with
1093 // applications that may have overridden the method.
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001094 mHost.onStartActivityFromFragment(this, intent, -1, null /*options*/);
Dianne Hackborna4972e92012-03-14 10:38:05 -07001095 }
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001096 }
Dianne Hackborna4972e92012-03-14 10:38:05 -07001097
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001098 /**
Scott Main87bff972013-02-27 15:46:34 -08001099 * Call {@link Activity#startActivityForResult(Intent, int)} from the fragment's
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001100 * containing Activity.
1101 */
1102 public void startActivityForResult(Intent intent, int requestCode) {
Dianne Hackborna4972e92012-03-14 10:38:05 -07001103 startActivityForResult(intent, requestCode, null);
1104 }
1105
1106 /**
Scott Main87bff972013-02-27 15:46:34 -08001107 * Call {@link Activity#startActivityForResult(Intent, int, Bundle)} from the fragment's
Dianne Hackborna4972e92012-03-14 10:38:05 -07001108 * containing Activity.
1109 */
1110 public void startActivityForResult(Intent intent, int requestCode, Bundle options) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001111 if (mHost == null) {
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -08001112 throw new IllegalStateException("Fragment " + this + " not attached to Activity");
1113 }
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001114 mHost.onStartActivityFromFragment(this, intent, requestCode, options);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001115 }
George Mountc03da0e2014-08-22 17:04:02 -07001116
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001117 /**
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)}.
George Mountc03da0e2014-08-22 17:04:02 -07001122 *
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001123 * @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 }
George Mountc03da0e2014-08-22 17:04:02 -07001133
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001134 /**
Svetoslavc6d1c342015-02-26 14:44:43 -08001135 * 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>
Svet Ganovd7ad54e2015-08-21 06:18:09 -07001171 * 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>
Svet Ganov255aece2015-07-03 16:03:53 -07001177 * 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>
Svetoslavc6d1c342015-02-26 14:44:43 -08001183 * 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.
1207 * @param requestCode Application specific request code to match with a result
1208 * reported to {@link #onRequestPermissionsResult(int, String[], int[])}.
Svet Ganov255aece2015-07-03 16:03:53 -07001209 * Should be >= 0.
Svetoslavc6d1c342015-02-26 14:44:43 -08001210 *
1211 * @see #onRequestPermissionsResult(int, String[], int[])
1212 * @see android.content.Context#checkSelfPermission(String)
1213 */
1214 public final void requestPermissions(@NonNull String[] permissions, int requestCode) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001215 if (mHost == null) {
Svetoslavc6d1c342015-02-26 14:44:43 -08001216 throw new IllegalStateException("Fragment " + this + " not attached to Activity");
1217 }
Svetoslav970b59c2015-06-09 16:05:21 -07001218 mHost.onRequestPermissionsFromFragment(this, permissions,requestCode);
Svetoslavc6d1c342015-02-26 14:44:43 -08001219 }
1220
1221 /**
1222 * Callback for the result from requesting permissions. This method
1223 * is invoked for every call on {@link #requestPermissions(String[], int)}.
Svet Ganov0f45c7c2015-07-16 16:28:51 -07001224 * <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>
Svetoslavc6d1c342015-02-26 14:44:43 -08001229 *
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 /**
Svetoslava2011d22015-06-03 15:43:59 -07001244 * 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) {
Svet Ganov9e136b82015-07-16 09:58:38 -07001265 return mHost.getContext().getPackageManager()
1266 .shouldShowRequestPermissionRationale(permission);
Svetoslava2011d22015-06-03 15:43:59 -07001267 }
1268 return false;
1269 }
1270
1271 /**
Dianne Hackborn7187ccb2011-01-24 23:58:13 -08001272 * @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) {
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001277 final LayoutInflater result = mHost.onGetLayoutInflater();
1278 if (mHost.onUseFragmentManagerInflaterFactory()) {
Adam Powell371a8092014-06-20 12:51:12 -07001279 getChildFragmentManager(); // Init if needed; use raw implementation below.
1280 result.setPrivateFactory(mChildFragmentManager.getLayoutInflaterFactory());
Adam Powell371a8092014-06-20 12:51:12 -07001281 }
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001282 return result;
Dianne Hackborn7187ccb2011-01-24 23:58:13 -08001283 }
George Mountc03da0e2014-08-22 17:04:02 -07001284
Dianne Hackborn7187ccb2011-01-24 23:58:13 -08001285 /**
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001286 * @deprecated Use {@link #onInflate(Context, AttributeSet, Bundle)} instead.
Dianne Hackborne3a7f622011-03-03 21:48:24 -08001287 */
1288 @Deprecated
1289 public void onInflate(AttributeSet attrs, Bundle savedInstanceState) {
1290 mCalled = true;
1291 }
1292
1293 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001294 * Called when a fragment is being created as part of a view layout
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001295 * inflation, typically from setting the content view of an activity. This
Dianne Hackborne3a7f622011-03-03 21:48:24 -08001296 * may be called immediately after the fragment is created from a <fragment>
Dianne Hackborndef15372010-08-15 12:43:52 -07001297 * 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
Dianne Hackborne3a7f622011-03-03 21:48:24 -08001299 * parse the attributes and save them away.
George Mountc03da0e2014-08-22 17:04:02 -07001300 *
Dianne Hackborndef15372010-08-15 12:43:52 -07001301 * <p>This is called every time the fragment is inflated, even if it is
Dianne Hackborne3a7f622011-03-03 21:48:24 -08001302 * 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}
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001316 *
Dianne Hackborne3a7f622011-03-03 21:48:24 -08001317 * <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 *
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001329 * @param context The Context that is inflating this fragment.
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001330 * @param attrs The attributes at the tag where the fragment is
1331 * being created.
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07001332 * @param savedInstanceState If the fragment is being re-created from
1333 * a previous saved state, this is the state.
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001334 */
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001335 public void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState) {
Dianne Hackborne3a7f622011-03-03 21:48:24 -08001336 onInflate(attrs, savedInstanceState);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07001337 mCalled = true;
George Mountc03da0e2014-08-22 17:04:02 -07001338
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001339 TypedArray a = context.obtainStyledAttributes(attrs,
George Mountc03da0e2014-08-22 17:04:02 -07001340 com.android.internal.R.styleable.Fragment);
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001341 mEnterTransition = loadTransition(context, a, mEnterTransition, null,
George Mountc03da0e2014-08-22 17:04:02 -07001342 com.android.internal.R.styleable.Fragment_fragmentEnterTransition);
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001343 mReturnTransition = loadTransition(context, a, mReturnTransition, USE_DEFAULT_TRANSITION,
George Mountc03da0e2014-08-22 17:04:02 -07001344 com.android.internal.R.styleable.Fragment_fragmentReturnTransition);
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001345 mExitTransition = loadTransition(context, a, mExitTransition, null,
George Mountc03da0e2014-08-22 17:04:02 -07001346 com.android.internal.R.styleable.Fragment_fragmentExitTransition);
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001347 mReenterTransition = loadTransition(context, a, mReenterTransition, USE_DEFAULT_TRANSITION,
George Mountc03da0e2014-08-22 17:04:02 -07001348 com.android.internal.R.styleable.Fragment_fragmentReenterTransition);
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001349 mSharedElementEnterTransition = loadTransition(context, a, mSharedElementEnterTransition,
George Mountc03da0e2014-08-22 17:04:02 -07001350 null, com.android.internal.R.styleable.Fragment_fragmentSharedElementEnterTransition);
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001351 mSharedElementReturnTransition = loadTransition(context, a, mSharedElementReturnTransition,
George Mountc03da0e2014-08-22 17:04:02 -07001352 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();
Todd Kennedy434bd652015-05-04 12:29:50 -07001363
1364 final Activity hostActivity = mHost == null ? null : mHost.getActivity();
1365 if (hostActivity != null) {
1366 mCalled = false;
1367 onInflate(hostActivity, attrs, savedInstanceState);
1368 }
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07001369 }
George Mountc03da0e2014-08-22 17:04:02 -07001370
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001371 /**
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001372 * @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.
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001381 * {@link #onCreate(Bundle)} will be called after this.
1382 */
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001383 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
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001396 public void onAttach(Activity activity) {
1397 mCalled = true;
1398 }
George Mountc03da0e2014-08-22 17:04:02 -07001399
Chet Haase811ed1062010-08-06 10:38:15 -07001400 /**
1401 * Called when a fragment loads an animation.
1402 */
Chet Haasea18a86b2010-09-07 13:20:00 -07001403 public Animator onCreateAnimator(int transit, boolean enter, int nextAnim) {
Dianne Hackbornf121be72010-05-06 14:10:32 -07001404 return null;
1405 }
George Mountc03da0e2014-08-22 17:04:02 -07001406
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001407 /**
1408 * Called to do initial creation of a fragment. This is called after
Dianne Hackbornc8017682010-07-06 13:34:38 -07001409 * {@link #onAttach(Activity)} and before
Felipe Lemeb1444572015-11-03 17:39:07 -08001410 * {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}, but is not called if the fragment
1411 * instance is retained across Activity re-creation (see {@link #setRetainInstance(boolean)}).
George Mountc03da0e2014-08-22 17:04:02 -07001412 *
Dianne Hackbornc8017682010-07-06 13:34:38 -07001413 * <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)}.
George Mountc03da0e2014-08-22 17:04:02 -07001418 *
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001419 * @param savedInstanceState If the fragment is being re-created from
1420 * a previous saved state, this is the state.
1421 */
Scott Kennedy3c32b622015-02-22 16:58:58 -08001422 public void onCreate(@Nullable Bundle savedInstanceState) {
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001423 mCalled = true;
1424 }
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07001425
Dianne Hackborn16f6e892011-04-15 19:00:20 -07001426 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001427 * Called to have the fragment instantiate its user interface view.
1428 * This is optional, and non-graphical fragments can return null (which
1429 * is the default implementation). This will be called between
Dianne Hackbornc8017682010-07-06 13:34:38 -07001430 * {@link #onCreate(Bundle)} and {@link #onActivityCreated(Bundle)}.
George Mountc03da0e2014-08-22 17:04:02 -07001431 *
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001432 * <p>If you return a View from here, you will later be called in
1433 * {@link #onDestroyView} when the view is being released.
George Mountc03da0e2014-08-22 17:04:02 -07001434 *
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001435 * @param inflater The LayoutInflater object that can be used to inflate
1436 * any views in the fragment,
1437 * @param container If non-null, this is the parent view that the fragment's
1438 * UI should be attached to. The fragment should not add the view itself,
1439 * but this can be used to generate the LayoutParams of the view.
1440 * @param savedInstanceState If non-null, this fragment is being re-constructed
1441 * from a previous saved state as given here.
George Mountc03da0e2014-08-22 17:04:02 -07001442 *
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001443 * @return Return the View for the fragment's UI, or null.
1444 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001445 @Nullable
1446 public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001447 Bundle savedInstanceState) {
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001448 return null;
1449 }
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07001450
1451 /**
1452 * Called immediately after {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}
1453 * has returned, but before any saved state has been restored in to the view.
1454 * This gives subclasses a chance to initialize themselves once
1455 * they know their view hierarchy has been completely created. The fragment's
1456 * view hierarchy is not however attached to its parent at this point.
1457 * @param view The View returned by {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}.
1458 * @param savedInstanceState If non-null, this fragment is being re-constructed
1459 * from a previous saved state as given here.
1460 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001461 public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07001462 }
George Mountc03da0e2014-08-22 17:04:02 -07001463
Scott Main662cc7a42011-01-17 15:02:07 -08001464 /**
1465 * Get the root view for the fragment's layout (the one returned by {@link #onCreateView}),
1466 * if provided.
George Mountc03da0e2014-08-22 17:04:02 -07001467 *
Scott Main662cc7a42011-01-17 15:02:07 -08001468 * @return The fragment's root view, or null if it has no layout.
1469 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001470 @Nullable
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001471 public View getView() {
1472 return mView;
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001473 }
George Mountc03da0e2014-08-22 17:04:02 -07001474
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001475 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -07001476 * Called when the fragment's activity has been created and this
1477 * fragment's view hierarchy instantiated. It can be used to do final
1478 * initialization once these pieces are in place, such as retrieving
1479 * views or restoring state. It is also useful for fragments that use
1480 * {@link #setRetainInstance(boolean)} to retain their instance,
1481 * as this callback tells the fragment when it is fully associated with
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001482 * the new activity instance. This is called after {@link #onCreateView}
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07001483 * and before {@link #onViewStateRestored(Bundle)}.
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07001484 *
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001485 * @param savedInstanceState If the fragment is being re-created from
1486 * a previous saved state, this is the state.
1487 */
Scott Kennedy3c32b622015-02-22 16:58:58 -08001488 public void onActivityCreated(@Nullable Bundle savedInstanceState) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001489 mCalled = true;
1490 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07001491
1492 /**
1493 * Called when all saved state has been restored into the view hierarchy
1494 * of the fragment. This can be used to do initialization based on saved
1495 * state that you are letting the view hierarchy track itself, such as
1496 * whether check box widgets are currently checked. This is called
1497 * after {@link #onActivityCreated(Bundle)} and before
1498 * {@link #onStart()}.
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07001499 *
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07001500 * @param savedInstanceState If the fragment is being re-created from
1501 * a previous saved state, this is the state.
1502 */
1503 public void onViewStateRestored(Bundle savedInstanceState) {
1504 mCalled = true;
1505 }
1506
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001507 /**
1508 * Called when the Fragment is visible to the user. This is generally
1509 * tied to {@link Activity#onStart() Activity.onStart} of the containing
1510 * Activity's lifecycle.
1511 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001512 public void onStart() {
1513 mCalled = true;
George Mountc03da0e2014-08-22 17:04:02 -07001514
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07001515 if (!mLoadersStarted) {
1516 mLoadersStarted = true;
1517 if (!mCheckedForLoaderManager) {
1518 mCheckedForLoaderManager = true;
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001519 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, false);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07001520 }
1521 if (mLoaderManager != null) {
1522 mLoaderManager.doStart();
1523 }
Dianne Hackbornc8017682010-07-06 13:34:38 -07001524 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001525 }
George Mountc03da0e2014-08-22 17:04:02 -07001526
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001527 /**
1528 * Called when the fragment is visible to the user and actively running.
1529 * This is generally
1530 * tied to {@link Activity#onResume() Activity.onResume} of the containing
1531 * Activity's lifecycle.
1532 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001533 public void onResume() {
1534 mCalled = true;
1535 }
George Mountc03da0e2014-08-22 17:04:02 -07001536
Dianne Hackborn72778202010-08-20 18:26:01 -07001537 /**
1538 * Called to ask the fragment to save its current dynamic state, so it
1539 * can later be reconstructed in a new instance of its process is
1540 * restarted. If a new instance of the fragment later needs to be
1541 * created, the data you place in the Bundle here will be available
1542 * in the Bundle given to {@link #onCreate(Bundle)},
1543 * {@link #onCreateView(LayoutInflater, ViewGroup, Bundle)}, and
1544 * {@link #onActivityCreated(Bundle)}.
1545 *
1546 * <p>This corresponds to {@link Activity#onSaveInstanceState(Bundle)
Daisuke Miyakawa2f761762010-09-12 16:53:17 -07001547 * Activity.onSaveInstanceState(Bundle)} and most of the discussion there
Dianne Hackborn72778202010-08-20 18:26:01 -07001548 * applies here as well. Note however: <em>this method may be called
1549 * at any time before {@link #onDestroy()}</em>. There are many situations
1550 * where a fragment may be mostly torn down (such as when placed on the
1551 * back stack with no UI showing), but its state will not be saved until
1552 * its owning activity actually needs to save its state.
1553 *
1554 * @param outState Bundle in which to place your saved state.
1555 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001556 public void onSaveInstanceState(Bundle outState) {
1557 }
George Mountc03da0e2014-08-22 17:04:02 -07001558
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001559 public void onConfigurationChanged(Configuration newConfig) {
1560 mCalled = true;
1561 }
George Mountc03da0e2014-08-22 17:04:02 -07001562
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001563 /**
1564 * Called when the Fragment is no longer resumed. This is generally
1565 * tied to {@link Activity#onPause() Activity.onPause} of the containing
1566 * Activity's lifecycle.
1567 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001568 public void onPause() {
1569 mCalled = true;
1570 }
George Mountc03da0e2014-08-22 17:04:02 -07001571
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001572 /**
1573 * Called when the Fragment is no longer started. This is generally
1574 * tied to {@link Activity#onStop() Activity.onStop} of the containing
1575 * Activity's lifecycle.
1576 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001577 public void onStop() {
1578 mCalled = true;
1579 }
George Mountc03da0e2014-08-22 17:04:02 -07001580
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001581 public void onLowMemory() {
1582 mCalled = true;
1583 }
George Mountc03da0e2014-08-22 17:04:02 -07001584
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001585 public void onTrimMemory(int level) {
1586 mCalled = true;
1587 }
1588
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001589 /**
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001590 * Called when the view previously created by {@link #onCreateView} has
1591 * been detached from the fragment. The next time the fragment needs
1592 * to be displayed, a new view will be created. This is called
Dianne Hackborndef15372010-08-15 12:43:52 -07001593 * after {@link #onStop()} and before {@link #onDestroy()}. It is called
1594 * <em>regardless</em> of whether {@link #onCreateView} returned a
1595 * non-null view. Internally it is called after the view's state has
1596 * been saved but before it has been removed from its parent.
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001597 */
1598 public void onDestroyView() {
1599 mCalled = true;
1600 }
George Mountc03da0e2014-08-22 17:04:02 -07001601
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001602 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001603 * Called when the fragment is no longer in use. This is called
1604 * after {@link #onStop()} and before {@link #onDetach()}.
1605 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001606 public void onDestroy() {
1607 mCalled = true;
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001608 //Log.v("foo", "onDestroy: mCheckedForLoaderManager=" + mCheckedForLoaderManager
1609 // + " mLoaderManager=" + mLoaderManager);
1610 if (!mCheckedForLoaderManager) {
1611 mCheckedForLoaderManager = true;
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001612 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, false);
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001613 }
Dianne Hackbornc8017682010-07-06 13:34:38 -07001614 if (mLoaderManager != null) {
1615 mLoaderManager.doDestroy();
1616 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001617 }
Dianne Hackborn5ae74d62010-05-19 19:14:57 -07001618
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001619 /**
Dianne Hackbornafc4b282011-06-10 17:03:42 -07001620 * Called by the fragment manager once this fragment has been removed,
1621 * so that we don't have any left-over state if the application decides
1622 * to re-use the instance. This only clears state that the framework
1623 * internally manages, not things the application sets.
1624 */
1625 void initState() {
1626 mIndex = -1;
1627 mWho = null;
1628 mAdded = false;
1629 mRemoving = false;
Dianne Hackbornafc4b282011-06-10 17:03:42 -07001630 mFromLayout = false;
1631 mInLayout = false;
1632 mRestored = false;
1633 mBackStackNesting = 0;
1634 mFragmentManager = null;
Tim Kilbourn70717862014-02-28 01:00:06 -08001635 mChildFragmentManager = null;
Todd Kennedya5fc6f02015-04-14 18:22:54 -07001636 mHost = null;
Dianne Hackbornafc4b282011-06-10 17:03:42 -07001637 mFragmentId = 0;
1638 mContainerId = 0;
1639 mTag = null;
1640 mHidden = false;
1641 mDetached = false;
1642 mRetaining = false;
1643 mLoaderManager = null;
1644 mLoadersStarted = false;
1645 mCheckedForLoaderManager = false;
1646 }
1647
1648 /**
Felipe Lemeb1444572015-11-03 17:39:07 -08001649 * Called when the fragment is no longer attached to its activity. This is called after
1650 * {@link #onDestroy()}, except in the cases where the fragment instance is retained across
1651 * Activity re-creation (see {@link #setRetainInstance(boolean)}), in which case it is called
1652 * after {@link #onStop()}.
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001653 */
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001654 public void onDetach() {
1655 mCalled = true;
1656 }
George Mountc03da0e2014-08-22 17:04:02 -07001657
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001658 /**
1659 * Initialize the contents of the Activity's standard options menu. You
1660 * should place your menu items in to <var>menu</var>. For this method
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001661 * to be called, you must have first called {@link #setHasOptionsMenu}. See
1662 * {@link Activity#onCreateOptionsMenu(Menu) Activity.onCreateOptionsMenu}
1663 * for more information.
George Mountc03da0e2014-08-22 17:04:02 -07001664 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001665 * @param menu The options menu in which you place your items.
George Mountc03da0e2014-08-22 17:04:02 -07001666 *
Wink Saville4dc643e2010-06-12 22:16:41 -07001667 * @see #setHasOptionsMenu
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001668 * @see #onPrepareOptionsMenu
1669 * @see #onOptionsItemSelected
1670 */
1671 public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
1672 }
1673
1674 /**
1675 * Prepare the Screen's standard options menu to be displayed. This is
1676 * called right before the menu is shown, every time it is shown. You can
1677 * use this method to efficiently enable/disable items or otherwise
1678 * dynamically modify the contents. See
1679 * {@link Activity#onPrepareOptionsMenu(Menu) Activity.onPrepareOptionsMenu}
1680 * for more information.
George Mountc03da0e2014-08-22 17:04:02 -07001681 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001682 * @param menu The options menu as last shown or first initialized by
1683 * onCreateOptionsMenu().
George Mountc03da0e2014-08-22 17:04:02 -07001684 *
Wink Saville4dc643e2010-06-12 22:16:41 -07001685 * @see #setHasOptionsMenu
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001686 * @see #onCreateOptionsMenu
1687 */
1688 public void onPrepareOptionsMenu(Menu menu) {
1689 }
1690
1691 /**
Dianne Hackborn8eb2e242010-11-01 12:31:24 -07001692 * Called when this fragment's option menu items are no longer being
1693 * included in the overall options menu. Receiving this call means that
1694 * the menu needed to be rebuilt, but this fragment's items were not
1695 * included in the newly built menu (its {@link #onCreateOptionsMenu(Menu, MenuInflater)}
1696 * was not called).
1697 */
1698 public void onDestroyOptionsMenu() {
1699 }
George Mountc03da0e2014-08-22 17:04:02 -07001700
Dianne Hackborn8eb2e242010-11-01 12:31:24 -07001701 /**
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001702 * This hook is called whenever an item in your options menu is selected.
1703 * The default implementation simply returns false to have the normal
1704 * processing happen (calling the item's Runnable or sending a message to
1705 * its Handler as appropriate). You can use this method for any items
1706 * for which you would like to do processing without those other
1707 * facilities.
George Mountc03da0e2014-08-22 17:04:02 -07001708 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001709 * <p>Derived classes should call through to the base class for it to
1710 * perform the default menu handling.
George Mountc03da0e2014-08-22 17:04:02 -07001711 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001712 * @param item The menu item that was selected.
George Mountc03da0e2014-08-22 17:04:02 -07001713 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001714 * @return boolean Return false to allow normal menu processing to
1715 * proceed, true to consume it here.
George Mountc03da0e2014-08-22 17:04:02 -07001716 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001717 * @see #onCreateOptionsMenu
1718 */
1719 public boolean onOptionsItemSelected(MenuItem item) {
1720 return false;
1721 }
1722
1723 /**
1724 * This hook is called whenever the options menu is being closed (either by the user canceling
1725 * the menu with the back/menu button, or when an item is selected).
George Mountc03da0e2014-08-22 17:04:02 -07001726 *
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001727 * @param menu The options menu as last shown or first initialized by
1728 * onCreateOptionsMenu().
1729 */
1730 public void onOptionsMenuClosed(Menu menu) {
1731 }
George Mountc03da0e2014-08-22 17:04:02 -07001732
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001733 /**
1734 * Called when a context menu for the {@code view} is about to be shown.
1735 * Unlike {@link #onCreateOptionsMenu}, this will be called every
1736 * time the context menu is about to be shown and should be populated for
1737 * the view (or item inside the view for {@link AdapterView} subclasses,
1738 * this can be found in the {@code menuInfo})).
1739 * <p>
1740 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an
1741 * item has been selected.
1742 * <p>
1743 * The default implementation calls up to
1744 * {@link Activity#onCreateContextMenu Activity.onCreateContextMenu}, though
1745 * you can not call this implementation if you don't want that behavior.
1746 * <p>
1747 * It is not safe to hold onto the context menu after this method returns.
1748 * {@inheritDoc}
1749 */
1750 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
1751 getActivity().onCreateContextMenu(menu, v, menuInfo);
1752 }
1753
1754 /**
1755 * Registers a context menu to be shown for the given view (multiple views
1756 * can show the context menu). This method will set the
1757 * {@link OnCreateContextMenuListener} on the view to this fragment, so
1758 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be
1759 * called when it is time to show the context menu.
George Mountc03da0e2014-08-22 17:04:02 -07001760 *
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001761 * @see #unregisterForContextMenu(View)
1762 * @param view The view that should show a context menu.
1763 */
1764 public void registerForContextMenu(View view) {
1765 view.setOnCreateContextMenuListener(this);
1766 }
George Mountc03da0e2014-08-22 17:04:02 -07001767
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001768 /**
1769 * Prevents a context menu to be shown for the given view. This method will
1770 * remove the {@link OnCreateContextMenuListener} on the view.
George Mountc03da0e2014-08-22 17:04:02 -07001771 *
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001772 * @see #registerForContextMenu(View)
1773 * @param view The view that should stop showing a context menu.
1774 */
1775 public void unregisterForContextMenu(View view) {
1776 view.setOnCreateContextMenuListener(null);
1777 }
George Mountc03da0e2014-08-22 17:04:02 -07001778
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001779 /**
1780 * This hook is called whenever an item in a context menu is selected. The
1781 * default implementation simply returns false to have the normal processing
1782 * happen (calling the item's Runnable or sending a message to its Handler
1783 * as appropriate). You can use this method for any items for which you
1784 * would like to do processing without those other facilities.
1785 * <p>
1786 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the
1787 * View that added this menu item.
1788 * <p>
1789 * Derived classes should call through to the base class for it to perform
1790 * the default menu handling.
George Mountc03da0e2014-08-22 17:04:02 -07001791 *
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07001792 * @param item The context menu item that was selected.
1793 * @return boolean Return false to allow normal context menu processing to
1794 * proceed, true to consume it here.
1795 */
1796 public boolean onContextItemSelected(MenuItem item) {
1797 return false;
1798 }
George Mountc03da0e2014-08-22 17:04:02 -07001799
1800 /**
George Mount65580562014-08-29 08:15:48 -07001801 * When custom transitions are used with Fragments, the enter transition callback
George Mountc03da0e2014-08-22 17:04:02 -07001802 * is called when this Fragment is attached or detached when not popping the back stack.
1803 *
George Mount65580562014-08-29 08:15:48 -07001804 * @param callback Used to manipulate the shared element transitions on this Fragment
George Mountc03da0e2014-08-22 17:04:02 -07001805 * when added not as a pop from the back stack.
1806 */
George Mount85ea4982014-09-12 14:16:18 -07001807 public void setEnterSharedElementCallback(SharedElementCallback callback) {
George Mount65580562014-08-29 08:15:48 -07001808 if (callback == null) {
1809 callback = SharedElementCallback.NULL_CALLBACK;
George Mountc03da0e2014-08-22 17:04:02 -07001810 }
George Mount65580562014-08-29 08:15:48 -07001811 mEnterTransitionCallback = callback;
George Mountc03da0e2014-08-22 17:04:02 -07001812 }
1813
1814 /**
George Mount85ea4982014-09-12 14:16:18 -07001815 * @hide
1816 */
1817 public void setEnterSharedElementTransitionCallback(SharedElementCallback callback) {
1818 setEnterSharedElementCallback(callback);
1819 }
1820
1821 /**
George Mount65580562014-08-29 08:15:48 -07001822 * When custom transitions are used with Fragments, the exit transition callback
George Mountc03da0e2014-08-22 17:04:02 -07001823 * is called when this Fragment is attached or detached when popping the back stack.
1824 *
George Mount65580562014-08-29 08:15:48 -07001825 * @param callback Used to manipulate the shared element transitions on this Fragment
George Mountc03da0e2014-08-22 17:04:02 -07001826 * when added as a pop from the back stack.
1827 */
George Mount85ea4982014-09-12 14:16:18 -07001828 public void setExitSharedElementCallback(SharedElementCallback callback) {
George Mount65580562014-08-29 08:15:48 -07001829 if (callback == null) {
1830 callback = SharedElementCallback.NULL_CALLBACK;
George Mountc03da0e2014-08-22 17:04:02 -07001831 }
George Mount65580562014-08-29 08:15:48 -07001832 mExitTransitionCallback = callback;
George Mountc03da0e2014-08-22 17:04:02 -07001833 }
1834
1835 /**
George Mount85ea4982014-09-12 14:16:18 -07001836 * @hide
1837 */
1838 public void setExitSharedElementTransitionCallback(SharedElementCallback callback) {
1839 setExitSharedElementCallback(callback);
1840 }
1841
1842 /**
George Mountc03da0e2014-08-22 17:04:02 -07001843 * Sets the Transition that will be used to move Views into the initial scene. The entering
1844 * Views will be those that are regular Views or ViewGroups that have
1845 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1846 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1847 * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
1848 * entering Views will remain unaffected.
1849 *
1850 * @param transition The Transition to use to move Views into the initial Scene.
1851 * @attr ref android.R.styleable#Fragment_fragmentEnterTransition
1852 */
1853 public void setEnterTransition(Transition transition) {
1854 mEnterTransition = transition;
1855 }
1856
1857 /**
1858 * Returns the Transition that will be used to move Views into the initial scene. The entering
1859 * Views will be those that are regular Views or ViewGroups that have
1860 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1861 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1862 * {@link View#INVISIBLE} to {@link View#VISIBLE}.
1863 *
1864 * @return the Transition to use to move Views into the initial Scene.
1865 * @attr ref android.R.styleable#Fragment_fragmentEnterTransition
1866 */
1867 public Transition getEnterTransition() {
1868 return mEnterTransition;
1869 }
1870
1871 /**
1872 * Sets the Transition that will be used to move Views out of the scene when the Fragment is
1873 * preparing to be removed, hidden, or detached because of popping the back stack. The exiting
1874 * Views will be those that are regular Views or ViewGroups that have
1875 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1876 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1877 * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null,
1878 * entering Views will remain unaffected. If nothing is set, the default will be to
1879 * use the same value as set in {@link #setEnterTransition(android.transition.Transition)}.
1880 *
1881 * @param transition The Transition to use to move Views out of the Scene when the Fragment
1882 * is preparing to close.
1883 * @attr ref android.R.styleable#Fragment_fragmentExitTransition
1884 */
1885 public void setReturnTransition(Transition transition) {
1886 mReturnTransition = transition;
1887 }
1888
1889 /**
1890 * Returns the Transition that will be used to move Views out of the scene when the Fragment is
1891 * preparing to be removed, hidden, or detached because of popping the back stack. The exiting
1892 * Views will be those that are regular Views or ViewGroups that have
1893 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1894 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1895 * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null,
1896 * entering Views will remain unaffected.
1897 *
1898 * @return the Transition to use to move Views out of the Scene when the Fragment
1899 * is preparing to close.
1900 * @attr ref android.R.styleable#Fragment_fragmentExitTransition
1901 */
1902 public Transition getReturnTransition() {
1903 return mReturnTransition == USE_DEFAULT_TRANSITION ? getEnterTransition()
1904 : mReturnTransition;
1905 }
1906
1907 /**
1908 * Sets the Transition that will be used to move Views out of the scene when the
1909 * fragment is removed, hidden, or detached when not popping the back stack.
1910 * The exiting Views will be those that are regular Views or ViewGroups that
1911 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1912 * {@link android.transition.Visibility} as exiting is governed by changing visibility
1913 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
1914 * remain unaffected.
1915 *
1916 * @param transition The Transition to use to move Views out of the Scene when the Fragment
1917 * is being closed not due to popping the back stack.
1918 * @attr ref android.R.styleable#Fragment_fragmentExitTransition
1919 */
1920 public void setExitTransition(Transition transition) {
1921 mExitTransition = transition;
1922 }
1923
1924 /**
1925 * Returns the Transition that will be used to move Views out of the scene when the
1926 * fragment is removed, hidden, or detached when not popping the back stack.
1927 * The exiting Views will be those that are regular Views or ViewGroups that
1928 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1929 * {@link android.transition.Visibility} as exiting is governed by changing visibility
1930 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
1931 * remain unaffected.
1932 *
1933 * @return the Transition to use to move Views out of the Scene when the Fragment
1934 * is being closed not due to popping the back stack.
1935 * @attr ref android.R.styleable#Fragment_fragmentExitTransition
1936 */
1937 public Transition getExitTransition() {
1938 return mExitTransition;
1939 }
1940
1941 /**
1942 * Sets the Transition that will be used to move Views in to the scene when returning due
1943 * to popping a back stack. The entering Views will be those that are regular Views
1944 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
1945 * will extend {@link android.transition.Visibility} as exiting is governed by changing
1946 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null,
1947 * the views will remain unaffected. If nothing is set, the default will be to use the same
1948 * transition as {@link #setExitTransition(android.transition.Transition)}.
1949 *
1950 * @param transition The Transition to use to move Views into the scene when reentering from a
1951 * previously-started Activity.
1952 * @attr ref android.R.styleable#Fragment_fragmentReenterTransition
1953 */
1954 public void setReenterTransition(Transition transition) {
1955 mReenterTransition = transition;
1956 }
1957
1958 /**
1959 * Returns the Transition that will be used to move Views in to the scene when returning due
1960 * to popping a back stack. The entering Views will be those that are regular Views
1961 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
1962 * will extend {@link android.transition.Visibility} as exiting is governed by changing
1963 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null,
1964 * the views will remain unaffected. If nothing is set, the default will be to use the same
1965 * transition as {@link #setExitTransition(android.transition.Transition)}.
1966 *
1967 * @return the Transition to use to move Views into the scene when reentering from a
1968 * previously-started Activity.
1969 * @attr ref android.R.styleable#Fragment_fragmentReenterTransition
1970 */
1971 public Transition getReenterTransition() {
1972 return mReenterTransition == USE_DEFAULT_TRANSITION ? getExitTransition()
1973 : mReenterTransition;
1974 }
1975
1976 /**
1977 * Sets the Transition that will be used for shared elements transferred into the content
1978 * Scene. Typical Transitions will affect size and location, such as
1979 * {@link android.transition.ChangeBounds}. A null
1980 * value will cause transferred shared elements to blink to the final position.
1981 *
1982 * @param transition The Transition to use for shared elements transferred into the content
1983 * Scene.
1984 * @attr ref android.R.styleable#Fragment_fragmentSharedElementEnterTransition
1985 */
1986 public void setSharedElementEnterTransition(Transition transition) {
1987 mSharedElementEnterTransition = transition;
1988 }
1989
1990 /**
1991 * Returns the Transition that will be used for shared elements transferred into the content
1992 * Scene. Typical Transitions will affect size and location, such as
1993 * {@link android.transition.ChangeBounds}. A null
1994 * value will cause transferred shared elements to blink to the final position.
1995 *
1996 * @return The Transition to use for shared elements transferred into the content
1997 * Scene.
1998 * @attr ref android.R.styleable#Fragment_fragmentSharedElementEnterTransition
1999 */
2000 public Transition getSharedElementEnterTransition() {
2001 return mSharedElementEnterTransition;
2002 }
2003
2004 /**
2005 * Sets the Transition that will be used for shared elements transferred back during a
2006 * pop of the back stack. This Transition acts in the leaving Fragment.
2007 * Typical Transitions will affect size and location, such as
2008 * {@link android.transition.ChangeBounds}. A null
2009 * value will cause transferred shared elements to blink to the final position.
2010 * If no value is set, the default will be to use the same value as
2011 * {@link #setSharedElementEnterTransition(android.transition.Transition)}.
2012 *
2013 * @param transition The Transition to use for shared elements transferred out of the content
2014 * Scene.
2015 * @attr ref android.R.styleable#Fragment_fragmentSharedElementReturnTransition
2016 */
2017 public void setSharedElementReturnTransition(Transition transition) {
2018 mSharedElementReturnTransition = transition;
2019 }
2020
2021 /**
2022 * Return the Transition that will be used for shared elements transferred back during a
2023 * pop of the back stack. This Transition acts in the leaving Fragment.
2024 * Typical Transitions will affect size and location, such as
2025 * {@link android.transition.ChangeBounds}. A null
2026 * value will cause transferred shared elements to blink to the final position.
2027 * If no value is set, the default will be to use the same value as
2028 * {@link #setSharedElementEnterTransition(android.transition.Transition)}.
2029 *
2030 * @return The Transition to use for shared elements transferred out of the content
2031 * Scene.
2032 * @attr ref android.R.styleable#Fragment_fragmentSharedElementReturnTransition
2033 */
2034 public Transition getSharedElementReturnTransition() {
2035 return mSharedElementReturnTransition == USE_DEFAULT_TRANSITION ?
2036 getSharedElementEnterTransition() : mSharedElementReturnTransition;
2037 }
2038
2039 /**
2040 * Sets whether the the exit transition and enter transition overlap or not.
2041 * When true, the enter transition will start as soon as possible. When false, the
2042 * enter transition will wait until the exit transition completes before starting.
2043 *
2044 * @param allow true to start the enter transition when possible or false to
2045 * wait until the exiting transition completes.
2046 * @attr ref android.R.styleable#Fragment_fragmentAllowEnterTransitionOverlap
2047 */
2048 public void setAllowEnterTransitionOverlap(boolean allow) {
2049 mAllowEnterTransitionOverlap = allow;
2050 }
2051
2052 /**
2053 * Returns whether the the exit transition and enter transition overlap or not.
2054 * When true, the enter transition will start as soon as possible. When false, the
2055 * enter transition will wait until the exit transition completes before starting.
2056 *
2057 * @return true when the enter transition should start as soon as possible or false to
2058 * when it should wait until the exiting transition completes.
2059 * @attr ref android.R.styleable#Fragment_fragmentAllowEnterTransitionOverlap
2060 */
2061 public boolean getAllowEnterTransitionOverlap() {
2062 return (mAllowEnterTransitionOverlap == null) ? true : mAllowEnterTransitionOverlap;
2063 }
2064
2065 /**
2066 * Sets whether the the return transition and reenter transition overlap or not.
2067 * When true, the reenter transition will start as soon as possible. When false, the
2068 * reenter transition will wait until the return transition completes before starting.
2069 *
2070 * @param allow true to start the reenter transition when possible or false to wait until the
2071 * return transition completes.
2072 * @attr ref android.R.styleable#Fragment_fragmentAllowReturnTransitionOverlap
2073 */
2074 public void setAllowReturnTransitionOverlap(boolean allow) {
2075 mAllowReturnTransitionOverlap = allow;
2076 }
2077
2078 /**
2079 * Returns whether the the return transition and reenter transition overlap or not.
2080 * When true, the reenter transition will start as soon as possible. When false, the
2081 * reenter transition will wait until the return transition completes before starting.
2082 *
2083 * @return true to start the reenter transition when possible or false to wait until the
2084 * return transition completes.
2085 * @attr ref android.R.styleable#Fragment_fragmentAllowReturnTransitionOverlap
2086 */
2087 public boolean getAllowReturnTransitionOverlap() {
2088 return (mAllowReturnTransitionOverlap == null) ? true : mAllowReturnTransitionOverlap;
2089 }
2090
Dianne Hackborn625ac272010-09-17 18:29:22 -07002091 /**
2092 * Print the Fragments's state into the given stream.
2093 *
2094 * @param prefix Text to print at the front of each line.
2095 * @param fd The raw file descriptor that the dump is being sent to.
2096 * @param writer The PrintWriter to which you should dump your state. This will be
2097 * closed for you after you return.
2098 * @param args additional arguments to the dump request.
2099 */
2100 public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
Dianne Hackborn30d71892010-12-11 10:37:55 -08002101 writer.print(prefix); writer.print("mFragmentId=#");
George Mountc03da0e2014-08-22 17:04:02 -07002102 writer.print(Integer.toHexString(mFragmentId));
2103 writer.print(" mContainerId=#");
2104 writer.print(Integer.toHexString(mContainerId));
2105 writer.print(" mTag="); writer.println(mTag);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002106 writer.print(prefix); writer.print("mState="); writer.print(mState);
George Mountc03da0e2014-08-22 17:04:02 -07002107 writer.print(" mIndex="); writer.print(mIndex);
2108 writer.print(" mWho="); writer.print(mWho);
2109 writer.print(" mBackStackNesting="); writer.println(mBackStackNesting);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002110 writer.print(prefix); writer.print("mAdded="); writer.print(mAdded);
George Mountc03da0e2014-08-22 17:04:02 -07002111 writer.print(" mRemoving="); writer.print(mRemoving);
George Mountc03da0e2014-08-22 17:04:02 -07002112 writer.print(" mFromLayout="); writer.print(mFromLayout);
2113 writer.print(" mInLayout="); writer.println(mInLayout);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002114 writer.print(prefix); writer.print("mHidden="); writer.print(mHidden);
George Mountc03da0e2014-08-22 17:04:02 -07002115 writer.print(" mDetached="); writer.print(mDetached);
2116 writer.print(" mMenuVisible="); writer.print(mMenuVisible);
2117 writer.print(" mHasMenu="); writer.println(mHasMenu);
Dianne Hackborn6c285972011-08-29 16:53:49 -07002118 writer.print(prefix); writer.print("mRetainInstance="); writer.print(mRetainInstance);
George Mountc03da0e2014-08-22 17:04:02 -07002119 writer.print(" mRetaining="); writer.print(mRetaining);
2120 writer.print(" mUserVisibleHint="); writer.println(mUserVisibleHint);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002121 if (mFragmentManager != null) {
2122 writer.print(prefix); writer.print("mFragmentManager=");
George Mountc03da0e2014-08-22 17:04:02 -07002123 writer.println(mFragmentManager);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002124 }
Todd Kennedya5fc6f02015-04-14 18:22:54 -07002125 if (mHost != null) {
2126 writer.print(prefix); writer.print("mHost=");
2127 writer.println(mHost);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002128 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002129 if (mParentFragment != null) {
2130 writer.print(prefix); writer.print("mParentFragment=");
George Mountc03da0e2014-08-22 17:04:02 -07002131 writer.println(mParentFragment);
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002132 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07002133 if (mArguments != null) {
2134 writer.print(prefix); writer.print("mArguments="); writer.println(mArguments);
2135 }
2136 if (mSavedFragmentState != null) {
2137 writer.print(prefix); writer.print("mSavedFragmentState=");
George Mountc03da0e2014-08-22 17:04:02 -07002138 writer.println(mSavedFragmentState);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002139 }
2140 if (mSavedViewState != null) {
2141 writer.print(prefix); writer.print("mSavedViewState=");
George Mountc03da0e2014-08-22 17:04:02 -07002142 writer.println(mSavedViewState);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002143 }
2144 if (mTarget != null) {
2145 writer.print(prefix); writer.print("mTarget="); writer.print(mTarget);
George Mountc03da0e2014-08-22 17:04:02 -07002146 writer.print(" mTargetRequestCode=");
2147 writer.println(mTargetRequestCode);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002148 }
2149 if (mNextAnim != 0) {
2150 writer.print(prefix); writer.print("mNextAnim="); writer.println(mNextAnim);
2151 }
2152 if (mContainer != null) {
2153 writer.print(prefix); writer.print("mContainer="); writer.println(mContainer);
2154 }
2155 if (mView != null) {
2156 writer.print(prefix); writer.print("mView="); writer.println(mView);
2157 }
Dianne Hackbornd173fa32010-12-23 13:58:22 -08002158 if (mAnimatingAway != null) {
2159 writer.print(prefix); writer.print("mAnimatingAway="); writer.println(mAnimatingAway);
2160 writer.print(prefix); writer.print("mStateAfterAnimating=");
George Mountc03da0e2014-08-22 17:04:02 -07002161 writer.println(mStateAfterAnimating);
Dianne Hackbornd173fa32010-12-23 13:58:22 -08002162 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07002163 if (mLoaderManager != null) {
Dianne Hackborn30d71892010-12-11 10:37:55 -08002164 writer.print(prefix); writer.println("Loader Manager:");
2165 mLoaderManager.dump(prefix + " ", fd, writer, args);
Dianne Hackborn625ac272010-09-17 18:29:22 -07002166 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002167 if (mChildFragmentManager != null) {
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07002168 writer.print(prefix); writer.println("Child " + mChildFragmentManager + ":");
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002169 mChildFragmentManager.dump(prefix + " ", fd, writer, args);
2170 }
2171 }
2172
2173 Fragment findFragmentByWho(String who) {
2174 if (who.equals(mWho)) {
2175 return this;
2176 }
2177 if (mChildFragmentManager != null) {
2178 return mChildFragmentManager.findFragmentByWho(who);
2179 }
2180 return null;
2181 }
2182
2183 void instantiateChildFragmentManager() {
2184 mChildFragmentManager = new FragmentManagerImpl();
Todd Kennedya5fc6f02015-04-14 18:22:54 -07002185 mChildFragmentManager.attachController(mHost, new FragmentContainer() {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002186 @Override
Scott Kennedyc0519552015-02-11 15:33:10 -08002187 @Nullable
Todd Kennedya5fc6f02015-04-14 18:22:54 -07002188 public View onFindViewById(int id) {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002189 if (mView == null) {
2190 throw new IllegalStateException("Fragment does not have a view");
2191 }
2192 return mView.findViewById(id);
2193 }
George Mount0b26e4d2014-09-17 16:36:42 -07002194
2195 @Override
Todd Kennedya5fc6f02015-04-14 18:22:54 -07002196 public boolean onHasView() {
George Mount0b26e4d2014-09-17 16:36:42 -07002197 return (mView != null);
2198 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002199 }, this);
2200 }
2201
2202 void performCreate(Bundle savedInstanceState) {
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07002203 if (mChildFragmentManager != null) {
2204 mChildFragmentManager.noteStateNotSaved();
2205 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002206 mState = CREATED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002207 mCalled = false;
2208 onCreate(savedInstanceState);
2209 if (!mCalled) {
2210 throw new SuperNotCalledException("Fragment " + this
2211 + " did not call through to super.onCreate()");
2212 }
2213 if (savedInstanceState != null) {
2214 Parcelable p = savedInstanceState.getParcelable(Activity.FRAGMENTS_TAG);
2215 if (p != null) {
2216 if (mChildFragmentManager == null) {
2217 instantiateChildFragmentManager();
2218 }
2219 mChildFragmentManager.restoreAllState(p, null);
2220 mChildFragmentManager.dispatchCreate();
2221 }
2222 }
2223 }
2224
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07002225 View performCreateView(LayoutInflater inflater, ViewGroup container,
2226 Bundle savedInstanceState) {
2227 if (mChildFragmentManager != null) {
2228 mChildFragmentManager.noteStateNotSaved();
2229 }
2230 return onCreateView(inflater, container, savedInstanceState);
2231 }
2232
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002233 void performActivityCreated(Bundle savedInstanceState) {
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07002234 if (mChildFragmentManager != null) {
2235 mChildFragmentManager.noteStateNotSaved();
2236 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002237 mState = ACTIVITY_CREATED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002238 mCalled = false;
2239 onActivityCreated(savedInstanceState);
2240 if (!mCalled) {
2241 throw new SuperNotCalledException("Fragment " + this
2242 + " did not call through to super.onActivityCreated()");
2243 }
2244 if (mChildFragmentManager != null) {
2245 mChildFragmentManager.dispatchActivityCreated();
2246 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07002247 }
2248
Dianne Hackbornafc4b282011-06-10 17:03:42 -07002249 void performStart() {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002250 if (mChildFragmentManager != null) {
2251 mChildFragmentManager.noteStateNotSaved();
2252 mChildFragmentManager.execPendingActions();
2253 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002254 mState = STARTED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002255 mCalled = false;
Dianne Hackbornafc4b282011-06-10 17:03:42 -07002256 onStart();
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002257 if (!mCalled) {
2258 throw new SuperNotCalledException("Fragment " + this
2259 + " did not call through to super.onStart()");
2260 }
2261 if (mChildFragmentManager != null) {
2262 mChildFragmentManager.dispatchStart();
2263 }
Dianne Hackbornafc4b282011-06-10 17:03:42 -07002264 if (mLoaderManager != null) {
2265 mLoaderManager.doReportStart();
2266 }
2267 }
2268
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002269 void performResume() {
2270 if (mChildFragmentManager != null) {
Dianne Hackborn1b8ecc52012-09-08 17:03:52 -07002271 mChildFragmentManager.noteStateNotSaved();
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002272 mChildFragmentManager.execPendingActions();
2273 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002274 mState = RESUMED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002275 mCalled = false;
2276 onResume();
2277 if (!mCalled) {
2278 throw new SuperNotCalledException("Fragment " + this
2279 + " did not call through to super.onResume()");
2280 }
2281 if (mChildFragmentManager != null) {
2282 mChildFragmentManager.dispatchResume();
2283 mChildFragmentManager.execPendingActions();
2284 }
2285 }
2286
2287 void performConfigurationChanged(Configuration newConfig) {
2288 onConfigurationChanged(newConfig);
2289 if (mChildFragmentManager != null) {
2290 mChildFragmentManager.dispatchConfigurationChanged(newConfig);
2291 }
2292 }
2293
2294 void performLowMemory() {
2295 onLowMemory();
2296 if (mChildFragmentManager != null) {
2297 mChildFragmentManager.dispatchLowMemory();
2298 }
2299 }
2300
2301 void performTrimMemory(int level) {
2302 onTrimMemory(level);
2303 if (mChildFragmentManager != null) {
2304 mChildFragmentManager.dispatchTrimMemory(level);
2305 }
2306 }
2307
2308 boolean performCreateOptionsMenu(Menu menu, MenuInflater inflater) {
2309 boolean show = false;
2310 if (!mHidden) {
2311 if (mHasMenu && mMenuVisible) {
2312 show = true;
2313 onCreateOptionsMenu(menu, inflater);
2314 }
2315 if (mChildFragmentManager != null) {
2316 show |= mChildFragmentManager.dispatchCreateOptionsMenu(menu, inflater);
2317 }
2318 }
2319 return show;
2320 }
2321
2322 boolean performPrepareOptionsMenu(Menu menu) {
2323 boolean show = false;
2324 if (!mHidden) {
2325 if (mHasMenu && mMenuVisible) {
2326 show = true;
2327 onPrepareOptionsMenu(menu);
2328 }
2329 if (mChildFragmentManager != null) {
2330 show |= mChildFragmentManager.dispatchPrepareOptionsMenu(menu);
2331 }
2332 }
2333 return show;
2334 }
2335
2336 boolean performOptionsItemSelected(MenuItem item) {
2337 if (!mHidden) {
2338 if (mHasMenu && mMenuVisible) {
2339 if (onOptionsItemSelected(item)) {
2340 return true;
2341 }
2342 }
2343 if (mChildFragmentManager != null) {
2344 if (mChildFragmentManager.dispatchOptionsItemSelected(item)) {
2345 return true;
2346 }
2347 }
2348 }
2349 return false;
2350 }
2351
2352 boolean performContextItemSelected(MenuItem item) {
2353 if (!mHidden) {
2354 if (onContextItemSelected(item)) {
2355 return true;
2356 }
2357 if (mChildFragmentManager != null) {
2358 if (mChildFragmentManager.dispatchContextItemSelected(item)) {
2359 return true;
2360 }
2361 }
2362 }
2363 return false;
2364 }
2365
2366 void performOptionsMenuClosed(Menu menu) {
2367 if (!mHidden) {
2368 if (mHasMenu && mMenuVisible) {
2369 onOptionsMenuClosed(menu);
2370 }
2371 if (mChildFragmentManager != null) {
2372 mChildFragmentManager.dispatchOptionsMenuClosed(menu);
2373 }
2374 }
2375 }
2376
2377 void performSaveInstanceState(Bundle outState) {
2378 onSaveInstanceState(outState);
2379 if (mChildFragmentManager != null) {
2380 Parcelable p = mChildFragmentManager.saveAllState();
2381 if (p != null) {
2382 outState.putParcelable(Activity.FRAGMENTS_TAG, p);
2383 }
2384 }
2385 }
2386
2387 void performPause() {
2388 if (mChildFragmentManager != null) {
2389 mChildFragmentManager.dispatchPause();
2390 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002391 mState = STARTED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002392 mCalled = false;
2393 onPause();
2394 if (!mCalled) {
2395 throw new SuperNotCalledException("Fragment " + this
2396 + " did not call through to super.onPause()");
2397 }
2398 }
2399
Dianne Hackborn2707d602010-07-09 18:01:20 -07002400 void performStop() {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002401 if (mChildFragmentManager != null) {
2402 mChildFragmentManager.dispatchStop();
2403 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002404 mState = STOPPED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002405 mCalled = false;
Dianne Hackborn2707d602010-07-09 18:01:20 -07002406 onStop();
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002407 if (!mCalled) {
2408 throw new SuperNotCalledException("Fragment " + this
2409 + " did not call through to super.onStop()");
2410 }
George Mountc03da0e2014-08-22 17:04:02 -07002411
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07002412 if (mLoadersStarted) {
2413 mLoadersStarted = false;
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07002414 if (!mCheckedForLoaderManager) {
2415 mCheckedForLoaderManager = true;
Todd Kennedya5fc6f02015-04-14 18:22:54 -07002416 mLoaderManager = mHost.getLoaderManager(mWho, mLoadersStarted, false);
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07002417 }
Dianne Hackborn2707d602010-07-09 18:01:20 -07002418 if (mLoaderManager != null) {
Todd Kennedy2ee19c7f2015-10-19 15:31:51 -07002419 if (mHost.getRetainLoaders()) {
Dianne Hackborn2707d602010-07-09 18:01:20 -07002420 mLoaderManager.doRetain();
Todd Kennedya5fc6f02015-04-14 18:22:54 -07002421 } else {
2422 mLoaderManager.doStop();
Dianne Hackborn2707d602010-07-09 18:01:20 -07002423 }
2424 }
2425 }
2426 }
Dianne Hackbornafc4b282011-06-10 17:03:42 -07002427
2428 void performDestroyView() {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002429 if (mChildFragmentManager != null) {
2430 mChildFragmentManager.dispatchDestroyView();
2431 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002432 mState = CREATED;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002433 mCalled = false;
Dianne Hackbornafc4b282011-06-10 17:03:42 -07002434 onDestroyView();
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002435 if (!mCalled) {
2436 throw new SuperNotCalledException("Fragment " + this
2437 + " did not call through to super.onDestroyView()");
2438 }
Dianne Hackbornafc4b282011-06-10 17:03:42 -07002439 if (mLoaderManager != null) {
2440 mLoaderManager.doReportNextStart();
2441 }
2442 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002443
2444 void performDestroy() {
2445 if (mChildFragmentManager != null) {
2446 mChildFragmentManager.dispatchDestroy();
2447 }
Adam Powelld1d4d9c2016-01-12 10:11:42 -08002448 mState = INITIALIZING;
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07002449 mCalled = false;
2450 onDestroy();
2451 if (!mCalled) {
2452 throw new SuperNotCalledException("Fragment " + this
2453 + " did not call through to super.onDestroy()");
2454 }
2455 }
George Mountc03da0e2014-08-22 17:04:02 -07002456
2457 private static Transition loadTransition(Context context, TypedArray typedArray,
2458 Transition currentValue, Transition defaultValue, int id) {
2459 if (currentValue != defaultValue) {
2460 return currentValue;
2461 }
2462 int transitionId = typedArray.getResourceId(id, 0);
2463 Transition transition = defaultValue;
2464 if (transitionId != 0 && transitionId != com.android.internal.R.transition.no_transition) {
2465 TransitionInflater inflater = TransitionInflater.from(context);
2466 transition = inflater.inflateTransition(transitionId);
2467 if (transition instanceof TransitionSet &&
2468 ((TransitionSet)transition).getTransitionCount() == 0) {
2469 transition = null;
2470 }
2471 }
2472 return transition;
2473 }
2474
Dianne Hackborn2dedce62010-04-15 14:45:25 -07002475}