/* * Copyright (C) 2011 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.support.v4.app; import android.app.Activity; import android.content.Context; import android.content.Intent; import android.content.res.Configuration; import android.content.res.Resources; import android.os.Bundle; import android.os.Handler; import android.os.Message; import android.os.Parcelable; import android.support.annotation.NonNull; import android.support.annotation.Nullable; import android.support.v4.util.SimpleArrayMap; import android.util.AttributeSet; import android.util.Log; import android.view.KeyEvent; import android.view.LayoutInflater; import android.view.Menu; import android.view.MenuItem; import android.view.View; import android.view.ViewGroup; import android.view.Window; import java.io.FileDescriptor; import java.io.PrintWriter; import java.util.ArrayList; import java.util.List; /** * Base class for activities that want to use the support-based * {@link android.support.v4.app.Fragment} and * {@link android.support.v4.content.Loader} APIs. * *

When using this class as opposed to new platform's built-in fragment * and loader support, you must use the {@link #getSupportFragmentManager()} * and {@link #getSupportLoaderManager()} methods respectively to access * those features. * *

Note: If you want to implement an activity that includes * an action bar, you should instead use * the {@link android.support.v7.app.ActionBarActivity} class, which is a subclass of this one, * so allows you to use {@link android.support.v4.app.Fragment} APIs on API level 7 and higher.

* *

Known limitations:

* */ public class FragmentActivity extends BaseFragmentActivityHoneycomb implements ActivityCompat.OnRequestPermissionsResultCallback, ActivityCompatApi23.RequestPermissionsRequestCodeValidator { private static final String TAG = "FragmentActivity"; static final String FRAGMENTS_TAG = "android:support:fragments"; // This is the SDK API version of Honeycomb (3.0). private static final int HONEYCOMB = 11; static final int MSG_REALLY_STOPPED = 1; static final int MSG_RESUME_PENDING = 2; final Handler mHandler = new Handler() { @Override public void handleMessage(Message msg) { switch (msg.what) { case MSG_REALLY_STOPPED: if (mStopped) { doReallyStop(false); } break; case MSG_RESUME_PENDING: onResumeFragments(); mFragments.execPendingActions(); break; default: super.handleMessage(msg); } } }; final FragmentController mFragments = FragmentController.createController(new HostCallbacks()); boolean mCreated; boolean mResumed; boolean mStopped; boolean mReallyStopped; boolean mRetaining; boolean mOptionsMenuInvalidated; boolean mRequestedPermissionsFromFragment; static final class NonConfigurationInstances { Object custom; List fragments; SimpleArrayMap loaders; } // ------------------------------------------------------------------------ // HOOKS INTO ACTIVITY // ------------------------------------------------------------------------ /** * Dispatch incoming result to the correct fragment. */ @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { mFragments.noteStateNotSaved(); int index = requestCode>>16; if (index != 0) { index--; final int activeFragmentsCount = mFragments.getActiveFragmentsCount(); if (activeFragmentsCount == 0 || index < 0 || index >= activeFragmentsCount) { Log.w(TAG, "Activity result fragment index out of range: 0x" + Integer.toHexString(requestCode)); return; } final List activeFragments = mFragments.getActiveFragments(new ArrayList(activeFragmentsCount)); Fragment frag = activeFragments.get(index); if (frag == null) { Log.w(TAG, "Activity result no fragment exists for index: 0x" + Integer.toHexString(requestCode)); } else { frag.onActivityResult(requestCode&0xffff, resultCode, data); } return; } super.onActivityResult(requestCode, resultCode, data); } /** * Take care of popping the fragment back stack or finishing the activity * as appropriate. */ public void onBackPressed() { if (!mFragments.getSupportFragmentManager().popBackStackImmediate()) { supportFinishAfterTransition(); } } /** * Reverses the Activity Scene entry Transition and triggers the calling Activity * to reverse its exit Transition. When the exit Transition completes, * {@link #finish()} is called. If no entry Transition was used, finish() is called * immediately and the Activity exit Transition is run. * *

On Android 4.4 or lower, this method only finishes the Activity with no * special exit transition.

*/ public void supportFinishAfterTransition() { ActivityCompat.finishAfterTransition(this); } /** * When {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String)} was used to start an Activity, callback * will be called to handle shared elements on the launched Activity. This requires * {@link Window#FEATURE_CONTENT_TRANSITIONS}. * * @param callback Used to manipulate shared element transitions on the launched Activity. */ public void setEnterSharedElementCallback(SharedElementCallback callback) { ActivityCompat.setEnterSharedElementCallback(this, callback); } /** * When {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, * android.view.View, String)} was used to start an Activity, listener * will be called to handle shared elements on the launching Activity. Most * calls will only come when returning from the started Activity. * This requires {@link Window#FEATURE_CONTENT_TRANSITIONS}. * * @param listener Used to manipulate shared element transitions on the launching Activity. */ public void setExitSharedElementCallback(SharedElementCallback listener) { ActivityCompat.setExitSharedElementCallback(this, listener); } /** * Support library version of {@link android.app.Activity#postponeEnterTransition()} that works * only on API 21 and later. */ public void supportPostponeEnterTransition() { ActivityCompat.postponeEnterTransition(this); } /** * Support library version of {@link android.app.Activity#startPostponedEnterTransition()} * that only works with API 21 and later. */ public void supportStartPostponedEnterTransition() { ActivityCompat.startPostponedEnterTransition(this); } /** * Dispatch configuration change to all fragments. */ @Override public void onConfigurationChanged(Configuration newConfig) { super.onConfigurationChanged(newConfig); mFragments.dispatchConfigurationChanged(newConfig); } /** * Perform initialization of all fragments and loaders. */ @SuppressWarnings("deprecation") @Override protected void onCreate(@Nullable Bundle savedInstanceState) { mFragments.attachHost(null /*parent*/); super.onCreate(savedInstanceState); NonConfigurationInstances nc = (NonConfigurationInstances) getLastNonConfigurationInstance(); if (nc != null) { mFragments.restoreLoaderNonConfig(nc.loaders); } if (savedInstanceState != null) { Parcelable p = savedInstanceState.getParcelable(FRAGMENTS_TAG); mFragments.restoreAllState(p, nc != null ? nc.fragments : null); } mFragments.dispatchCreate(); } /** * Dispatch to Fragment.onCreateOptionsMenu(). */ @Override public boolean onCreatePanelMenu(int featureId, Menu menu) { if (featureId == Window.FEATURE_OPTIONS_PANEL) { boolean show = super.onCreatePanelMenu(featureId, menu); show |= mFragments.dispatchCreateOptionsMenu(menu, getMenuInflater()); if (android.os.Build.VERSION.SDK_INT >= HONEYCOMB) { return show; } // Prior to Honeycomb, the framework can't invalidate the options // menu, so we must always say we have one in case the app later // invalidates it and needs to have it shown. return true; } return super.onCreatePanelMenu(featureId, menu); } @Override final View dispatchFragmentsOnCreateView(View parent, String name, Context context, AttributeSet attrs) { return mFragments.onCreateView(parent, name, context, attrs); } /** * Destroy all fragments and loaders. */ @Override protected void onDestroy() { super.onDestroy(); doReallyStop(false); mFragments.dispatchDestroy(); mFragments.doLoaderDestroy(); } /** * Take care of calling onBackPressed() for pre-Eclair platforms. */ @Override public boolean onKeyDown(int keyCode, KeyEvent event) { if (android.os.Build.VERSION.SDK_INT < 5 /* ECLAIR */ && keyCode == KeyEvent.KEYCODE_BACK && event.getRepeatCount() == 0) { // Take care of calling this method on earlier versions of // the platform where it doesn't exist. onBackPressed(); return true; } return super.onKeyDown(keyCode, event); } /** * Dispatch onLowMemory() to all fragments. */ @Override public void onLowMemory() { super.onLowMemory(); mFragments.dispatchLowMemory(); } /** * Dispatch context and options menu to fragments. */ @Override public boolean onMenuItemSelected(int featureId, MenuItem item) { if (super.onMenuItemSelected(featureId, item)) { return true; } switch (featureId) { case Window.FEATURE_OPTIONS_PANEL: return mFragments.dispatchOptionsItemSelected(item); case Window.FEATURE_CONTEXT_MENU: return mFragments.dispatchContextItemSelected(item); default: return false; } } /** * Call onOptionsMenuClosed() on fragments. */ @Override public void onPanelClosed(int featureId, Menu menu) { switch (featureId) { case Window.FEATURE_OPTIONS_PANEL: mFragments.dispatchOptionsMenuClosed(menu); break; } super.onPanelClosed(featureId, menu); } /** * Dispatch onPause() to fragments. */ @Override protected void onPause() { super.onPause(); mResumed = false; if (mHandler.hasMessages(MSG_RESUME_PENDING)) { mHandler.removeMessages(MSG_RESUME_PENDING); onResumeFragments(); } mFragments.dispatchPause(); } /** * Handle onNewIntent() to inform the fragment manager that the * state is not saved. If you are handling new intents and may be * making changes to the fragment state, you want to be sure to call * through to the super-class here first. Otherwise, if your state * is saved but the activity is not stopped, you could get an * onNewIntent() call which happens before onResume() and trying to * perform fragment operations at that point will throw IllegalStateException * because the fragment manager thinks the state is still saved. */ @Override protected void onNewIntent(Intent intent) { super.onNewIntent(intent); mFragments.noteStateNotSaved(); } /** * Hook in to note that fragment state is no longer saved. */ public void onStateNotSaved() { mFragments.noteStateNotSaved(); } /** * Dispatch onResume() to fragments. Note that for better inter-operation * with older versions of the platform, at the point of this call the * fragments attached to the activity are not resumed. This means * that in some cases the previous state may still be saved, not allowing * fragment transactions that modify the state. To correctly interact * with fragments in their proper state, you should instead override * {@link #onResumeFragments()}. */ @Override protected void onResume() { super.onResume(); mHandler.sendEmptyMessage(MSG_RESUME_PENDING); mResumed = true; mFragments.execPendingActions(); } /** * Dispatch onResume() to fragments. */ @Override protected void onPostResume() { super.onPostResume(); mHandler.removeMessages(MSG_RESUME_PENDING); onResumeFragments(); mFragments.execPendingActions(); } /** * This is the fragment-orientated version of {@link #onResume()} that you * can override to perform operations in the Activity at the same point * where its fragments are resumed. Be sure to always call through to * the super-class. */ protected void onResumeFragments() { mFragments.dispatchResume(); } /** * Dispatch onPrepareOptionsMenu() to fragments. */ @Override public boolean onPreparePanel(int featureId, View view, Menu menu) { if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) { if (mOptionsMenuInvalidated) { mOptionsMenuInvalidated = false; menu.clear(); onCreatePanelMenu(featureId, menu); } boolean goforit = onPrepareOptionsPanel(view, menu); goforit |= mFragments.dispatchPrepareOptionsMenu(menu); return goforit; } return super.onPreparePanel(featureId, view, menu); } /** * @hide */ protected boolean onPrepareOptionsPanel(View view, Menu menu) { return super.onPreparePanel(Window.FEATURE_OPTIONS_PANEL, view, menu); } /** * Retain all appropriate fragment and loader state. You can NOT * override this yourself! Use {@link #onRetainCustomNonConfigurationInstance()} * if you want to retain your own state. */ @Override public final Object onRetainNonConfigurationInstance() { if (mStopped) { doReallyStop(true); } Object custom = onRetainCustomNonConfigurationInstance(); List fragments = mFragments.retainNonConfig(); SimpleArrayMap loaders = mFragments.retainLoaderNonConfig(); if (fragments == null && loaders == null && custom == null) { return null; } NonConfigurationInstances nci = new NonConfigurationInstances(); nci.custom = custom; nci.fragments = fragments; nci.loaders = loaders; return nci; } /** * Save all appropriate fragment state. */ @Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); Parcelable p = mFragments.saveAllState(); if (p != null) { outState.putParcelable(FRAGMENTS_TAG, p); } } /** * Dispatch onStart() to all fragments. Ensure any created loaders are * now started. */ @Override protected void onStart() { super.onStart(); mStopped = false; mReallyStopped = false; mHandler.removeMessages(MSG_REALLY_STOPPED); if (!mCreated) { mCreated = true; mFragments.dispatchActivityCreated(); } mFragments.noteStateNotSaved(); mFragments.execPendingActions(); mFragments.doLoaderStart(); // NOTE: HC onStart goes here. mFragments.dispatchStart(); mFragments.reportLoaderStart(); } /** * Dispatch onStop() to all fragments. Ensure all loaders are stopped. */ @Override protected void onStop() { super.onStop(); mStopped = true; mHandler.sendEmptyMessage(MSG_REALLY_STOPPED); mFragments.dispatchStop(); } // ------------------------------------------------------------------------ // NEW METHODS // ------------------------------------------------------------------------ /** * Use this instead of {@link #onRetainNonConfigurationInstance()}. * Retrieve later with {@link #getLastCustomNonConfigurationInstance()}. */ public Object onRetainCustomNonConfigurationInstance() { return null; } /** * Return the value previously returned from * {@link #onRetainCustomNonConfigurationInstance()}. */ @SuppressWarnings("deprecation") public Object getLastCustomNonConfigurationInstance() { NonConfigurationInstances nc = (NonConfigurationInstances) getLastNonConfigurationInstance(); return nc != null ? nc.custom : null; } /** * Support library version of {@link Activity#invalidateOptionsMenu}. * *

Invalidate the activity's options menu. This will cause relevant presentations * of the menu to fully update via calls to onCreateOptionsMenu and * onPrepareOptionsMenu the next time the menu is requested. */ public void supportInvalidateOptionsMenu() { if (android.os.Build.VERSION.SDK_INT >= HONEYCOMB) { // If we are running on HC or greater, we can use the framework // API to invalidate the options menu. ActivityCompatHoneycomb.invalidateOptionsMenu(this); return; } // Whoops, older platform... we'll use a hack, to manually rebuild // the options menu the next time it is prepared. mOptionsMenuInvalidated = true; } /** * Print the Activity's state into the given stream. This gets invoked if * you run "adb shell dumpsys activity ". * * @param prefix Desired prefix to prepend at each line of output. * @param fd The raw file descriptor that the dump is being sent to. * @param writer The PrintWriter to which you should dump your state. This will be * closed for you after you return. * @param args additional arguments to the dump request. */ public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { if (android.os.Build.VERSION.SDK_INT >= HONEYCOMB) { // XXX This can only work if we can call the super-class impl. :/ //ActivityCompatHoneycomb.dump(this, prefix, fd, writer, args); } writer.print(prefix); writer.print("Local FragmentActivity "); writer.print(Integer.toHexString(System.identityHashCode(this))); writer.println(" State:"); String innerPrefix = prefix + " "; writer.print(innerPrefix); writer.print("mCreated="); writer.print(mCreated); writer.print("mResumed="); writer.print(mResumed); writer.print(" mStopped="); writer.print(mStopped); writer.print(" mReallyStopped="); writer.println(mReallyStopped); mFragments.dumpLoaders(innerPrefix, fd, writer, args); mFragments.getSupportFragmentManager().dump(prefix, fd, writer, args); writer.print(prefix); writer.println("View Hierarchy:"); dumpViewHierarchy(prefix + " ", writer, getWindow().getDecorView()); } private static String viewToString(View view) { StringBuilder out = new StringBuilder(128); out.append(view.getClass().getName()); out.append('{'); out.append(Integer.toHexString(System.identityHashCode(view))); out.append(' '); switch (view.getVisibility()) { case View.VISIBLE: out.append('V'); break; case View.INVISIBLE: out.append('I'); break; case View.GONE: out.append('G'); break; default: out.append('.'); break; } out.append(view.isFocusable() ? 'F' : '.'); out.append(view.isEnabled() ? 'E' : '.'); out.append(view.willNotDraw() ? '.' : 'D'); out.append(view.isHorizontalScrollBarEnabled()? 'H' : '.'); out.append(view.isVerticalScrollBarEnabled() ? 'V' : '.'); out.append(view.isClickable() ? 'C' : '.'); out.append(view.isLongClickable() ? 'L' : '.'); out.append(' '); out.append(view.isFocused() ? 'F' : '.'); out.append(view.isSelected() ? 'S' : '.'); out.append(view.isPressed() ? 'P' : '.'); out.append(' '); out.append(view.getLeft()); out.append(','); out.append(view.getTop()); out.append('-'); out.append(view.getRight()); out.append(','); out.append(view.getBottom()); final int id = view.getId(); if (id != View.NO_ID) { out.append(" #"); out.append(Integer.toHexString(id)); final Resources r = view.getResources(); if (id != 0 && r != null) { try { String pkgname; switch (id&0xff000000) { case 0x7f000000: pkgname="app"; break; case 0x01000000: pkgname="android"; break; default: pkgname = r.getResourcePackageName(id); break; } String typename = r.getResourceTypeName(id); String entryname = r.getResourceEntryName(id); out.append(" "); out.append(pkgname); out.append(":"); out.append(typename); out.append("/"); out.append(entryname); } catch (Resources.NotFoundException e) { } } } out.append("}"); return out.toString(); } private void dumpViewHierarchy(String prefix, PrintWriter writer, View view) { writer.print(prefix); if (view == null) { writer.println("null"); return; } writer.println(viewToString(view)); if (!(view instanceof ViewGroup)) { return; } ViewGroup grp = (ViewGroup)view; final int N = grp.getChildCount(); if (N <= 0) { return; } prefix = prefix + " "; for (int i=0; i * Note: It is possible that the permissions request interaction * with the user is interrupted. In this case you will receive empty permissions * and results arrays which should be treated as a cancellation. *

* * @param requestCode The request code passed in {@link #requestPermissions(String[], int)}. * @param permissions The requested permissions. Never null. * @param grantResults The grant results for the corresponding permissions * which is either {@link android.content.pm.PackageManager#PERMISSION_GRANTED} * or {@link android.content.pm.PackageManager#PERMISSION_DENIED}. Never null. * * @see #requestPermissions(String[], int) */ public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) { int index = (requestCode>>8)&0xff; if (index != 0) { index--; final int activeFragmentsCount = mFragments.getActiveFragmentsCount(); if (activeFragmentsCount == 0 || index < 0 || index >= activeFragmentsCount) { Log.w(TAG, "Activity result fragment index out of range: 0x" + Integer.toHexString(requestCode)); return; } final List activeFragments = mFragments.getActiveFragments(new ArrayList(activeFragmentsCount)); Fragment frag = activeFragments.get(index); if (frag == null) { Log.w(TAG, "Activity result no fragment exists for index: 0x" + Integer.toHexString(requestCode)); } else { frag.onRequestPermissionsResult(requestCode&0xff, permissions, grantResults); } } } /** * Called by Fragment.startActivityForResult() to implement its behavior. */ public void startActivityFromFragment(Fragment fragment, Intent intent, int requestCode) { if (requestCode == -1) { super.startActivityForResult(intent, -1); return; } if ((requestCode&0xffff0000) != 0) { throw new IllegalArgumentException("Can only use lower 16 bits for requestCode"); } super.startActivityForResult(intent, ((fragment.mIndex+1)<<16) + (requestCode&0xffff)); } /** * Called by Fragment.requestPermissions() to implement its behavior. */ private void requestPermissionsFromFragment(Fragment fragment, String[] permissions, int requestCode) { if (requestCode == -1) { ActivityCompat.requestPermissions(this, permissions, requestCode); return; } if ((requestCode&0xffffff00) != 0) { throw new IllegalArgumentException("Can only use lower 8 bits for requestCode"); } mRequestedPermissionsFromFragment = true; ActivityCompat.requestPermissions(this, permissions, ((fragment.mIndex + 1) << 8) + (requestCode & 0xff)); } class HostCallbacks extends FragmentHostCallback { public HostCallbacks() { super(FragmentActivity.this /*fragmentActivity*/); } @Override public void onDump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { FragmentActivity.this.dump(prefix, fd, writer, args); } @Override public boolean onShouldSaveFragmentState(Fragment fragment) { return !isFinishing(); } @Override public LayoutInflater onGetLayoutInflater() { return FragmentActivity.this.getLayoutInflater().cloneInContext(FragmentActivity.this); } @Override public FragmentActivity onGetHost() { return FragmentActivity.this; } @Override public void onSupportInvalidateOptionsMenu() { FragmentActivity.this.supportInvalidateOptionsMenu(); } @Override public void onStartActivityFromFragment(Fragment fragment, Intent intent, int requestCode) { FragmentActivity.this.startActivityFromFragment(fragment, intent, requestCode); } @Override public void onRequestPermissionsFromFragment(@NonNull Fragment fragment, @NonNull String[] permissions, int requestCode) { FragmentActivity.this.requestPermissionsFromFragment(fragment, permissions, requestCode); } @Override public boolean onShouldShowRequestPermissionRationale(@NonNull String permission) { return ActivityCompat.shouldShowRequestPermissionRationale( FragmentActivity.this, permission); } @Override public boolean onHasWindowAnimations() { return getWindow() != null; } @Override public int onGetWindowAnimations() { final Window w = getWindow(); return (w == null) ? 0 : w.getAttributes().windowAnimations; } @Override public void onAttachFragment(Fragment fragment) { FragmentActivity.this.onAttachFragment(fragment); } @Nullable @Override public View onFindViewById(int id) { return FragmentActivity.this.findViewById(id); } @Override public boolean onHasView() { final Window w = getWindow(); return (w != null && w.peekDecorView() != null); } } }