Issue 2513 - Adblock Browser does not display chosen filter lists as active right away

mobile/android/thirdparty/org/adblockplus/browser/SubscriptionPreferenceCategory.java

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 11 matching lines @@
 import org.mozilla.gecko.R;
 import org.mozilla.gecko.util.ThreadUtils;
 
 import android.app.ProgressDialog;
 import android.content.Context;
 import android.preference.CheckBoxPreference;
 import android.preference.Preference;
 import android.preference.PreferenceCategory;
 import android.util.AttributeSet;
 
-public class SubscriptionPreferenceCategory extends PreferenceCategory
+public class SubscriptionPreferenceCategory extends PreferenceCategory implements
+        Preference.OnPreferenceChangeListener, SubscriptionContainer.SubscriptionListener

[Felix Dahlke, 2016/12/13 08:59:20]

FYI: We have so far (how I remember it) avoided to have classes implement
listener interfaces, and added a private field with a separate listener object
for that instead. IIRC that was because I found it harder to read the code this
way - it's just not as obvious which method implements which listener. I don't
feel that strong about it though, so if you do, I'm OK with it if you keep it
as-is.

[diegocarloslima, 2016/12/13 13:31:05]

There are a few classes in ABB which implement listeners such as StartPane and
UrlInputDialog, but I agree that it's more readable if we define them through
inner classes +  class members

 {
   volatile static SubscriptionContainer subscriptionContainer = null;
-  private final CheckBoxChangeListener checkBoxChangeListener = new CheckBoxChangeListener();
   private boolean isEnabledList = false;
   private ProgressDialog progressDialog;
 
   public SubscriptionPreferenceCategory(Context context)
   {
     super(context);
   }
 
   public SubscriptionPreferenceCategory(Context context, AttributeSet attrs)
   {
@@ skipping 15 matching lines @@
     {
       subscriptionContainer.refresh();
     }
   }
 
   @Override
   protected void onAttachedToActivity()
   {
     this.isEnabledList = this.getKey().endsWith("subscriptionEnabled");
 
-    this.progressDialog = new ProgressDialog(this.getContext());
-
     this.setEnabled(false);
     this.setShouldDisableView(true);
 
     super.onAttachedToActivity();
 
-    this.progressDialog.setProgressStyle(ProgressDialog.STYLE_SPINNER);
-    this.progressDialog.setMessage(this.getContext().getString(R.string.abb_adblocking_waiting));
-    this.progressDialog.show();
+    showProgressDialog();
 
     AddOnBridge.postToHandler(new Runnable()
     {
       @Override
       public void run()
       {
         initSubscriptions();
+        subscriptionContainer.addSubscriptionListener(SubscriptionPreferenceCategory.this);
         ThreadUtils.postToUiThread(new Runnable()
         {
           @Override
           public void run()
           {
-            SubscriptionPreferenceCategory.this.initEntries();
+            SubscriptionPreferenceCategory.this.refreshEntries();
           }
         });
       }
     });
   }
 
+  @Override
+  public boolean onPreferenceChange(Preference preference, Object newValue)
+  {
+    if (preference instanceof CheckBoxPreference && newValue instanceof Boolean)
+    {
+      showProgressDialog();
+
+      final CheckBoxPreference cbp = (CheckBoxPreference) preference;
+      final boolean enable = ((Boolean) newValue).booleanValue();
+      SubscriptionPreferenceCategory.subscriptionContainer.changeSubscriptionState(
+              cbp.getKey(),
+              enable);
+    }
+    return true;
+  }
+
+  @Override
+  public void onSubscriptionUpdated()
+  {
+    refreshEntries();
+  }
+
   private CheckBoxPreference createDisabledCheckBox(final int titleId, final int summaryId)
   {
     final CheckBoxPreference cbp = new CheckBoxPreference(this.getContext());
     cbp.setTitle(titleId);
     cbp.setSummary(summaryId);
     cbp.setEnabled(false);
     cbp.setShouldDisableView(true);
     cbp.setSelectable(false);
     return cbp;
   }
 
   private CheckBoxPreference createEnabledCheckBox(
       final SubscriptionContainer.Subscription subscription)
   {
     final CheckBoxPreference cbp = new CheckBoxPreference(this.getContext());
     cbp.setTitle(subscription.specialization);
     cbp.setSummary(subscription.title);
     cbp.setChecked(true);
     cbp.setKey(subscription.url);
     cbp.setPersistent(false);
     cbp.setChecked(subscriptionContainer.isSubscriptionListed(subscription.url));
-    cbp.setOnPreferenceChangeListener(this.checkBoxChangeListener);
+    cbp.setOnPreferenceChangeListener(SubscriptionPreferenceCategory.this);
     return cbp;
   }
 
-  private void initEntries()
+  private void refreshEntries()
   {
     if (this.isEnabledList)
     {
-      this.initEntries(R.string.abb_adblocking_none_selected,
+      this.refreshEntries(R.string.abb_adblocking_none_selected,
           R.string.abb_adblocking_select_below, true);
     }
     else
     {
-      this.initEntries(R.string.abb_adblocking_none_available,
+      this.refreshEntries(R.string.abb_adblocking_none_available,
           R.string.abb_adblocking_all_selected, false);
     }
 
     this.setEnabled(true);
     this.setShouldDisableView(false);
-    this.progressDialog.dismiss();
-    this.progressDialog = null;
+
+    dismissProgressDialog();
   }
 
-  private void initEntries(final int titleId, final int summaryId, boolean enabled)
+  private void refreshEntries(final int titleId, final int summaryId, boolean enabled)
   {
     this.removeAll();
     final List<SubscriptionContainer.Subscription> entries =
         subscriptionContainer.getSubscriptions(enabled);
 
     if (entries.isEmpty())
     {
       this.addPreference(this.createDisabledCheckBox(titleId, summaryId));
     }
     else
     {
       for (SubscriptionContainer.Subscription e : entries)
       {
         this.addPreference(this.createEnabledCheckBox(e));
       }
     }
   }
 
-  private static class CheckBoxChangeListener implements OnPreferenceChangeListener
+  private void showProgressDialog()
   {
-    @Override
-    public boolean onPreferenceChange(Preference preference, Object newValue)
+    this.progressDialog = new ProgressDialog(this.getContext());
+    this.progressDialog.setProgressStyle(ProgressDialog.STYLE_SPINNER);
+    this.progressDialog.setMessage(this.getContext().getString(R.string.abb_adblocking_waiting));
+    this.progressDialog.show();
+  }
+
+  private void dismissProgressDialog()
+  {
+    if (this.progressDialog != null)
     {
-      if (preference instanceof CheckBoxPreference && newValue instanceof Boolean)
-      {
-        final CheckBoxPreference cbp = (CheckBoxPreference) preference;
-        final boolean enable = ((Boolean) newValue).booleanValue();
-        SubscriptionPreferenceCategory.subscriptionContainer.changeSubscriptionState(
-            cbp.getKey(),
-            enable);
-      }
-      return true;
+      this.progressDialog.dismiss();
+      this.progressDialog = null;
     }
   }
 }