Fixed problems with Android's lifecycle (restore)

Author: litetex

app/src/main/java/org/schabi/newpipe/settings/SettingsActivity.java

@@ -3,6 +3,7 @@
 import static org.schabi.newpipe.util.Localization.assureCorrectAppLanguage;
 
 import android.os.Bundle;
+import android.text.TextUtils;
 import android.util.Log;
 import android.view.Menu;
 import android.view.MenuItem;
@@ -40,6 +41,9 @@
 
 import java.util.concurrent.TimeUnit;
 
+import icepick.Icepick;
+import icepick.State;
+
 /*
  * Created by Christian Schabesberger on 31.08.15.
  *
@@ -77,20 +81,37 @@ public class SettingsActivity extends AppCompatActivity implements
     private View searchContainer;
     private EditText searchEditText;
 
+    // State
+    @State
+    String searchText;
+    @State
+    boolean wasSearchActive;
+
     @Override
     protected void onCreate(final Bundle savedInstanceBundle) {
         setTheme(ThemeHelper.getSettingsThemeStyle(this));
         assureCorrectAppLanguage(this);
+
         super.onCreate(savedInstanceBundle);
+        Icepick.restoreInstanceState(this, savedInstanceBundle);
+        final boolean restored = savedInstanceBundle != null;
 
         final SettingsLayoutBinding settingsLayoutBinding =
                 SettingsLayoutBinding.inflate(getLayoutInflater());
         setContentView(settingsLayoutBinding.getRoot());
-        initSearch(settingsLayoutBinding);
+        initSearch(settingsLayoutBinding, restored);
 
         setSupportActionBar(settingsLayoutBinding.settingsToolbarLayout.toolbar);
 
-        if (savedInstanceBundle == null) {
+        if (restored) {
+            // Restore state
+            if (this.wasSearchActive) {
+                setSearchActive(true);
+                if (!TextUtils.isEmpty(this.searchText)) {
+                    this.searchEditText.setText(this.searchText);
+                }
+            }
+        } else {
             getSupportFragmentManager().beginTransaction()
                     .replace(R.id.settings_fragment_holder, new MainSettingsFragment())
                     .commit();
@@ -101,6 +122,12 @@ protected void onCreate(final Bundle savedInstanceBundle) {
         }
     }
 
+    @Override
+    protected void onSaveInstanceState(@NonNull final Bundle outState) {
+        super.onSaveInstanceState(outState);
+        Icepick.saveInstanceState(this, outState);
+    }
+
     @Override
     public boolean onCreateOptionsMenu(final Menu menu) {
         final ActionBar actionBar = getSupportActionBar();
@@ -175,7 +202,10 @@ protected void onDestroy() {
     //////////////////////////////////////////////////////////////////////////*/
     //region Search
 
-    private void initSearch(final SettingsLayoutBinding settingsLayoutBinding) {
+    private void initSearch(
+            final SettingsLayoutBinding settingsLayoutBinding,
+            final boolean restored
+    ) {
         searchContainer =
                 settingsLayoutBinding.settingsToolbarLayout.toolbar
                         .findViewById(R.id.toolbar_search_container);
@@ -207,7 +237,19 @@ private void initSearch(final SettingsLayoutBinding settingsLayoutBinding) {
                 .map(parser::parse)
                 .forEach(searcher::add);
 
-        searchFragment = new PreferenceSearchFragment(searcher);
+        if (restored) {
+            searchFragment = (PreferenceSearchFragment) getSupportFragmentManager()
+                    .findFragmentByTag(PreferenceSearchFragment.NAME);
+            if (searchFragment != null) {
+                // Hide/Remove the search fragment otherwise we get an exception
+                // when adding it (because it's already present)
+                hideSearchFragment();
+            }
+        }
+        if (searchFragment == null) {
+            searchFragment = new PreferenceSearchFragment();
+        }
+        searchFragment.setSearcher(searcher);
     }
 
     private void prepareSearchConfig() {
@@ -228,43 +270,56 @@ private void prepareSearchConfig() {
 
     public void setMenuSearchItem(final MenuItem menuSearchItem) {
         this.menuSearchItem = menuSearchItem;
+
+        // Ensure that the item is in the correct state when adding it. This is due to
+        // Android's lifecycle (the Activity is recreated before the Fragment that registers this)
+        if (menuSearchItem != null) {
+            menuSearchItem.setVisible(!isSearchActive());
+        }
     }
 
     public void setSearchActive(final boolean active) {
+        if (DEBUG) {
+            Log.d(TAG, "setSearchActive called active=" + active);
+        }
+
         // Ignore if search is already in correct state
         if (isSearchActive() == active) {
             return;
         }
 
-        if (DEBUG) {
-            Log.d(TAG, "setSearchActive called active=" + active);
-        }
+        wasSearchActive = active;
 
         searchContainer.setVisibility(active ? View.VISIBLE : View.GONE);
         if (menuSearchItem != null) {
             menuSearchItem.setVisible(!active);
         }
 
-        final FragmentManager fm = getSupportFragmentManager();
         if (active) {
-            fm.beginTransaction()
+            getSupportFragmentManager()
+                    .beginTransaction()
                     .add(FRAGMENT_HOLDER_ID, searchFragment, PreferenceSearchFragment.NAME)
                     .addToBackStack(PreferenceSearchFragment.NAME)
                     .commit();
 
             KeyboardUtil.showKeyboard(this, searchEditText);
         } else if (searchFragment != null) {
-            fm.beginTransaction().remove(searchFragment).commit();
-            fm.popBackStack(
-                    PreferenceSearchFragment.NAME,
-                    FragmentManager.POP_BACK_STACK_INCLUSIVE);
+            hideSearchFragment();
+            getSupportFragmentManager()
+                    .popBackStack(
+                        PreferenceSearchFragment.NAME,
+                        FragmentManager.POP_BACK_STACK_INCLUSIVE);
 
             KeyboardUtil.hideKeyboard(this, searchEditText);
         }
 
         resetSearchText();
     }
 
+    private void hideSearchFragment() {
+        getSupportFragmentManager().beginTransaction().remove(searchFragment).commit();
+    }
+
     private void resetSearchText() {
         searchEditText.setText("");
     }
@@ -279,7 +334,8 @@ private void onSearchChanged() {
         }
 
         if (searchFragment != null) {
-            searchFragment.updateSearchResults(this.searchEditText.getText().toString());
+            searchText = this.searchEditText.getText().toString();
+            searchFragment.updateSearchResults(searchText);
         }
     }
 

app/src/main/java/org/schabi/newpipe/settings/preferencesearch/PreferenceSearchFragment.java

@@ -24,14 +24,12 @@
 public class PreferenceSearchFragment extends Fragment {
     public static final String NAME = PreferenceSearchFragment.class.getSimpleName();
 
-    private final PreferenceSearcher searcher;
+    private PreferenceSearcher searcher;
 
     private SearchViewHolder viewHolder;
     private PreferenceSearchAdapter adapter;
 
-    public PreferenceSearchFragment(
-            final PreferenceSearcher searcher
-    ) {
+    public void setSearcher(final PreferenceSearcher searcher) {
         this.searcher = searcher;
     }
 
@@ -56,7 +54,7 @@ public View onCreateView(
     }
 
     public void updateSearchResults(final String keyword) {
-        if (adapter == null) {
+        if (adapter == null || searcher == null) {
             return;
         }