[Download Home] Displaying offline page bundle per day

chrome/android/java/src/org/chromium/chrome/browser/widget/DateDividedAdapter.java

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.widget;
 
 import android.os.AsyncTask;
 import android.support.v7.widget.RecyclerView;
 import android.support.v7.widget.RecyclerView.Adapter;
 import android.support.v7.widget.RecyclerView.ViewHolder;
 import android.text.format.DateUtils;
 import android.util.Pair;
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.ViewGroup;
 import android.widget.TextView;
 
 import org.chromium.chrome.R;
-import org.chromium.chrome.browser.widget.DateDividedAdapter.ItemGroup;
 
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.Date;
 import java.util.List;
 import java.util.SortedSet;
 import java.util.TreeSet;
 import java.util.concurrent.ExecutionException;
@@ skipping 16 matching lines @@
         /** Value indicating that a TimedItem is not currently being displayed. */
         public static final int INVALID_POSITION = -1;
 
         /** Position of the TimedItem in the list, or {@link #INVALID_POSITION} if not shown. */
         private int mPosition = INVALID_POSITION;
 
         private boolean mIsFirstInGroup;
         private boolean mIsLastInGroup;
 
         /** See {@link #mPosition}. */
-        private final void setPosition(int position) {
+        public final void setPosition(int position) {
             mPosition = position;
         }
 
         /** See {@link #mPosition}. */
         public final int getPosition() {
             return mPosition;
         }
 
         /**
          * @param isFirst Whether this item is the first in its group.
@@ skipping 78 matching lines @@
 
     protected static class BasicViewHolder extends RecyclerView.ViewHolder {
         public BasicViewHolder(View itemView) {
             super(itemView);
         }
     }
 
     /**
      * A bucket of items with the same date.
      */
-    protected static class ItemGroup {
-        private final Date mDate;
-        private final List<TimedItem> mItems = new ArrayList<>();
+    public static class ItemGroup {
+        protected final Date mDate;
+        protected final List<TimedItem> mItems = new ArrayList<>();
 
         /** Index of the header, relative to the full list.  Must be set only once.*/
         private int mIndex;
 
         private boolean mIsSorted;
         private boolean mIsListHeader;
         private boolean mIsListFooter;
 
         public ItemGroup(long timestamp) {
             mDate = new Date(timestamp);
             mIsSorted = true;
         }
 
         public void addItem(TimedItem item) {
             mItems.add(item);
             mIsSorted = mItems.size() == 1;
         }
 
         public void removeItem(TimedItem item) {
             mItems.remove(item);
         }
 
         /** Records the position of all the TimedItems in this group, relative to the full list. */
         public void setPosition(int index) {
             assert mIndex == 0 || mIndex == TimedItem.INVALID_POSITION;
             mIndex = index;
 
             sortIfNeeded();
+            setPositionForItems(index + 1);
+            markFirstAndLastItem();
+        }
+
+        protected void setPositionForItems(int startIndex) {
+            int index = startIndex;
             for (int i = 0; i < mItems.size(); i++) {
-                index += 1;
                 TimedItem item = mItems.get(i);
                 item.setPosition(index);
-                item.setIsFirstInGroup(i == 0);
-                item.setIsLastInGroup(i == mItems.size() - 1);
+                index += 1;
             }
         }
 
+        protected void markFirstAndLastItem() {
+            TimedItem first = mItems.get(0);
+            TimedItem last = mItems.get(mItems.size() - 1);
+            first.setIsFirstInGroup(true);
+            last.setIsLastInGroup(true);
+        }
+
         /** Unsets the position of all TimedItems in this group. */
         public void resetPosition() {
             mIndex = TimedItem.INVALID_POSITION;
             for (TimedItem item : mItems) item.setPosition(TimedItem.INVALID_POSITION);
         }
 
         /**
          * @return Whether the given date happens in the same day as the items in this group.
          */
         public boolean isSameDay(Date otherDate) {
             return compareDate(mDate, otherDate) == 0;
         }
 
         /**
          * @return The size of this group.
          */
         public int size() {
             if (mIsListHeader || mIsListFooter) return 1;
 
             // Plus 1 to account for the date header.
-            return mItems.size() + 1;
+            return mItems.isEmpty() ? 0 : mItems.size() + 1;
         }
 
         public TimedItem getItemAt(int index) {
             // 0 is allocated to the date header. The list header has no items.
             if (index == 0 || mIsListHeader || mIsListFooter) return null;
 
             sortIfNeeded();
+            return getItemAtInternal(index);
+        }
+
+        protected TimedItem getItemAtInternal(int index) {
             return mItems.get(index - 1);
         }
 
         /**
          * Rather than sorting the list each time a new item is added, the list is sorted when
          * something requires a correct ordering of the items.
          */
-        private void sortIfNeeded() {
+        protected void sortIfNeeded() {
             if (mIsSorted) return;
             mIsSorted = true;
 
             Collections.sort(mItems, new Comparator<TimedItem>() {
                 @Override
                 public int compare(TimedItem lhs, TimedItem rhs) {
-                    // More recent items are listed first.  Ideally we'd use Long.compare, but that
-                    // is an API level 19 call for some inexplicable reason.
-                    long timeDelta = lhs.getTimestamp() - rhs.getTimestamp();
-                    if (timeDelta > 0) {
-                        return -1;
-                    } else if (timeDelta == 0) {
-                        return 0;
-                    } else {
-                        return 1;
-                    }
+                    return compareItem(lhs, rhs);
                 }
             });
         }
+
+        protected int compareItem(TimedItem lhs, TimedItem rhs) {
+            // More recent items are listed first.  Ideally we'd use Long.compare, but that
+            // is an API level 19 call for some inexplicable reason.
+            long timeDelta = lhs.getTimestamp() - rhs.getTimestamp();
+            if (timeDelta > 0) {
+                return -1;
+            } else if (timeDelta == 0) {
+                return 0;
+            } else {
+                return 1;
+            }
+        }
+
+        public int getItemViewType(int position) {
+            return position == 0 ? TYPE_DATE : TYPE_NORMAL;
+        }
+
+        /**
+         * Returns the number of rows that should be removed when the given item is deleted.
+         * e.g. When the last item is deleted, the date header should also be removed.
+         * @param item The item to be removed.
+         * @return The number of rows to be removed.
+         */
+        public int getNumberOfRowsToBeRemovedForItem(TimedItem item) {

[Theresa, 2017/02/13 19:15:00]

Instead of introducing this method, can ItemGroup#removeItem() return the number
of items that were removed?

+            return mItems.size() == 1 ? 2 : 1;
+        }
     }
 
     // Cached async tasks to get the two Calendar objects, which are used when comparing dates.
     private static final AsyncTask<Void, Void, Calendar> sCal1 = createCalendar();
     private static final AsyncTask<Void, Void, Calendar> sCal2 = createCalendar();
 
     public static final int TYPE_FOOTER = -2;
     public static final int TYPE_HEADER = -1;
     public static final int TYPE_DATE = 0;
     public static final int TYPE_NORMAL = 1;
+    public static final int TYPE_SUBSECTION_HEADER = 2;
 
     private int mSize;
     private boolean mHasListHeader;
     private boolean mHasListFooter;
 
     private SortedSet<ItemGroup> mGroups = new TreeSet<>(new Comparator<ItemGroup>() {
         @Override
         public int compare(ItemGroup lhs, ItemGroup rhs) {
             if (lhs == rhs) return 0;
 
             // There should only be at most one list header and one list footer in the SortedSet.
             if (lhs.mIsListHeader || rhs.mIsListFooter) return -1;
             if (lhs.mIsListFooter || rhs.mIsListHeader) return 1;
 
             return compareDate(lhs.mDate, rhs.mDate);
         }
     });
 
     /**
      * Creates a {@link ViewHolder} in the given view parent.
      * @see #onCreateViewHolder(ViewGroup, int)
      */
     protected abstract ViewHolder createViewHolder(ViewGroup parent);
 
     /**
+     * Creates a {@link ViewHolder} for a subsection in the given view parent.
+     * @see #onCreateViewHolder(ViewGroup, int)
+     */
+    protected ViewHolder createSubsectionHeader(ViewGroup parent) {
+        return null;
+    }
+
+    /**
      * Creates a {@link BasicViewHolder} in the given view parent for the header.
      * @see #onCreateViewHolder(ViewGroup, int)
      */
     protected BasicViewHolder createHeader(ViewGroup parent) {
         return null;
     }
 
     /**
      * Creates a {@link BasicViewHolder} in the given view parent for the footer.
      * See {@link #onCreateViewHolder(ViewGroup, int)}.
@@ skipping 28 matching lines @@
      * {@link #clear(boolean)} to remove previous items.
      */
     public void loadItems(List<? extends TimedItem> timedItems) {
         for (TimedItem timedItem : timedItems) {
             Date date = new Date(timedItem.getTimestamp());
             boolean found = false;
             for (ItemGroup group : mGroups) {
                 if (group.isSameDay(date)) {
                     found = true;
                     group.addItem(timedItem);
-                    mSize++;
                     break;
                 }
             }
             if (!found) {
                 // Create a new ItemGroup with the date for the new item. This increases the
                 // size by two because we add new views for the date and the item itself.
-                ItemGroup newGroup = new ItemGroup(timedItem.getTimestamp());
+                ItemGroup newGroup = createGroup(timedItem.getTimestamp());
                 newGroup.addItem(timedItem);
                 mGroups.add(newGroup);
-                mSize += 2;
             }
         }
 
+        computeItemCount();
         setGroupPositions();
         notifyDataSetChanged();
     }
 
+    protected ItemGroup createGroup(long timestamp) {
+        return new ItemGroup(timestamp);
+    }
+
     /**
      * Tells each group where they start in the list.
      */
-    private void setGroupPositions() {
+    protected void setGroupPositions() {
         int startIndex = 0;
         for (ItemGroup group : mGroups) {
             group.resetPosition();
             group.setPosition(startIndex);
             startIndex += group.size();
         }
     }
 
     /**
      * Adds a header as the first group in this adapter.
@@ skipping 89 matching lines @@
         return new Pair<>(group.mDate, group.getItemAt(pair.second));
     }
 
     @Override
     public final int getItemViewType(int position) {
         Pair<ItemGroup, Integer> pair = getGroupAt(position);
         if (pair.second == TYPE_HEADER) {
             return TYPE_HEADER;
         } else if (pair.second == TYPE_FOOTER) {
             return TYPE_FOOTER;
-        } else if (pair.second == 0) {
-            return TYPE_DATE;
         } else {
-            return TYPE_NORMAL;
+            ItemGroup group = pair.first;
+            return group.getItemViewType(pair.second);
         }
     }
 
     @Override
-    public final RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
+    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
         if (viewType == TYPE_DATE) {
             return createDateViewHolder(parent);
         } else if (viewType == TYPE_NORMAL) {
             return createViewHolder(parent);
         } else if (viewType == TYPE_HEADER) {
             return createHeader(parent);
         } else if (viewType == TYPE_FOOTER) {
             return createFooter(parent);
+        } else if (viewType == TYPE_SUBSECTION_HEADER) {
+            return createSubsectionHeader(parent);
         }
         assert false;
         return null;
     }
 
     @Override
-    public final void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
+    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
         Pair<Date, TimedItem> pair = getItemAt(position);
         if (holder instanceof DateViewHolder) {
             ((DateViewHolder) holder).setDate(pair.first);
         } else if (!(holder instanceof BasicViewHolder)) {
             bindViewHolderForTimedItem(holder, pair.second);
         }
     }
 
     @Override
     public final int getItemCount() {
@@ skipping 25 matching lines @@
         }
         assert false;
         return null;
     }
 
     /**
      * @param item The item to remove from the adapter.
      */
     protected void removeItem(TimedItem item) {
         ItemGroup group = getGroupAt(item.getPosition()).first;
+        int numRowsToRemove = group.getNumberOfRowsToBeRemovedForItem(item);
         group.removeItem(item);
-        mSize--;
 
-        // Remove the group if only the date header is left.
-        if (group.size() == 1) {
+        // Remove the group if it is empty.
+        if (group.size() == 0) {
             mGroups.remove(group);
-            mSize--;
         }
 
+        mSize -= numRowsToRemove;
         setGroupPositions();
         notifyDataSetChanged();
     }
 
+    protected void computeItemCount() {
+        mSize = 0;
+        for (ItemGroup group : mGroups) {
+            mSize += group.size();
+        }
+    }
+
     /**
      * Creates a long ID that identifies a particular day in history.
      * @param date Date to process.
      * @return Long that has the day of the year (1-365) in the lowest 16 bits and the year in the
      *         next 16 bits over.
      */
     private static long getStableIdFromDate(Date date) {
         Pair<Calendar, Calendar> pair = getCachedCalendars();
         Calendar calendar = pair.first;
         calendar.setTime(date);
         long dayOfYear = calendar.get(Calendar.DAY_OF_YEAR);
         long year = calendar.get(Calendar.YEAR);
         return (year << 16) + dayOfYear;
     }
 
     /**
      * Compares two {@link Date}s. Note if you already have two {@link Calendar} objects, use
      * {@link #compareCalendar(Calendar, Calendar)} instead.
      * @return 0 if date1 and date2 are in the same day; 1 if date1 is before date2; -1 otherwise.
      */
-    private static int compareDate(Date date1, Date date2) {
+    protected static int compareDate(Date date1, Date date2) {
         Pair<Calendar, Calendar> pair = getCachedCalendars();
         Calendar cal1 = pair.first, cal2 = pair.second;
         cal1.setTime(date1);
         cal2.setTime(date2);
         return compareCalendar(cal1, cal2);
     }
 
     /**
      * @return 0 if cal1 and cal2 are in the same day; 1 if cal1 happens before cal2; -1 otherwise.
      */
@@ skipping 30 matching lines @@
      */
     private static AsyncTask<Void, Void, Calendar> createCalendar() {
         return new AsyncTask<Void, Void, Calendar>() {
             @Override
             protected Calendar doInBackground(Void... unused) {
                 return Calendar.getInstance();
             }
         }.execute();
     }
 }