Bug 1288256 - Post: add comments explaining HomePager specific methods in HomeScreen r=sebastian
authorAndrzej Hunt <ahunt@mozilla.com>
Thu, 21 Jul 2016 08:03:37 -0700
changeset 346187 bd6655e7b879214b7d983ca85c8160a77a653178
parent 346186 35add519e9f4ae0c4f03befb6483d1fc255a5ad7
child 346188 664bd6aa11e1c9e53f5e6e7bca4990265b563802
push id6389
push userraliiev@mozilla.com
push dateMon, 19 Sep 2016 13:38:22 +0000
treeherdermozilla-beta@01d67bfe6c81 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerssebastian
bugs1288256
milestone50.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1288256 - Post: add comments explaining HomePager specific methods in HomeScreen r=sebastian MozReview-Commit-ID: 5hgTMzff6zq
mobile/android/base/java/org/mozilla/gecko/home/HomeScreen.java
--- a/mobile/android/base/java/org/mozilla/gecko/home/HomeScreen.java
+++ b/mobile/android/base/java/org/mozilla/gecko/home/HomeScreen.java
@@ -33,20 +33,25 @@ public interface HomeScreen {
     // The following two methods are actually methods of View. Since there is no View interface
     // we're forced to do this instead of "extending" View. Any class implementing HomeScreen
     // will have to implement these and pass them through to the underlying View.
     boolean isVisible();
     boolean requestFocus();
 
     void onToolbarFocusChange(boolean hasFocus);
 
+    // The following three methods are HomePager specific. The persistence framework might need
+    // refactoring/generalising at some point, but it isn't entirely clear what other panels
+    // might need so we can leave these as is for now.
     void showPanel(String panelId, Bundle restoreData);
-
     void setOnPanelChangeListener(OnPanelChangeListener listener);
-
     void setPanelStateChangeListener(HomeFragment.PanelStateChangeListener listener);
 
+    /**
+     * Set a banner that may be displayed at the bottom of the HomeScreen. This can be used
+     * e.g. to show snippets.
+     */
     void setBanner(HomeBanner banner);
 
     void load(LoaderManager lm, FragmentManager fm, String panelId, Bundle restoreData, PropertyAnimator animator);
 
     void unload();
 }