Bug 889612: BookmarksListAdapter should be controlled by the BookmarksPage fragment. [r=bnicholson]

This commit is contained in:
Sriram Ramasubramanian 2013-07-02 15:03:13 -07:00
parent b598ce95a2
commit f7b44ba3eb
4 changed files with 253 additions and 250 deletions

View File

@ -208,6 +208,7 @@ FENNEC_JAVA_FILES = \
gfx/TouchEventHandler.java \
gfx/ViewTransform.java \
gfx/VirtualLayer.java \
home/BookmarksListAdapter.java \
home/BookmarksListView.java \
home/BookmarksPage.java \
home/BookmarkFolderView.java \

View File

@ -0,0 +1,226 @@
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.gecko.home;
import org.mozilla.gecko.R;
import org.mozilla.gecko.db.BrowserContract.Bookmarks;
import android.content.Context;
import android.content.res.Resources;
import android.database.Cursor;
import android.support.v4.widget.CursorAdapter;
import android.util.Pair;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import java.util.LinkedList;
/**
* Adapter to back the BookmarksListView with a list of bookmarks.
*/
class BookmarksListAdapter extends CursorAdapter {
private static final int VIEW_TYPE_ITEM = 0;
private static final int VIEW_TYPE_FOLDER = 1;
private static final int VIEW_TYPE_COUNT = 2;
// A listener that knows how to refresh the list for a given folder id.
// This is usually implemented by the enclosing fragment/activity.
public static interface OnRefreshFolderListener {
// The folder id to refresh the list with.
public void onRefreshFolder(int folderId);
}
// mParentStack holds folder id/title pairs that allow us to navigate
// back up the folder heirarchy.
private LinkedList<Pair<Integer, String>> mParentStack;
// Refresh folder listener.
private OnRefreshFolderListener mListener;
public BookmarksListAdapter(Context context, Cursor cursor) {
// Initializing with a null cursor.
super(context, cursor);
mParentStack = new LinkedList<Pair<Integer, String>>();
// Add the root folder to the stack
Pair<Integer, String> rootFolder = new Pair<Integer, String>(Bookmarks.FIXED_ROOT_ID, "");
mParentStack.addFirst(rootFolder);
}
// Refresh the current folder by executing a new task.
private void refreshCurrentFolder() {
if (mListener != null) {
mListener.onRefreshFolder(mParentStack.peek().first);
}
}
/**
* Moves to parent folder, if one exists.
*/
public void moveToParentFolder() {
// If we're already at the root, we can't move to a parent folder
if (mParentStack.size() != 1) {
mParentStack.removeFirst();
refreshCurrentFolder();
}
}
/**
* Moves to child folder, given a folderId.
*
* @param folderId The id of the folder to show.
* @param folderTitle The title of the folder to show.
*/
public void moveToChildFolder(int folderId, String folderTitle) {
Pair<Integer, String> folderPair = new Pair<Integer, String>(folderId, folderTitle);
mParentStack.addFirst(folderPair);
refreshCurrentFolder();
}
/**
* Set a listener that can refresh this adapter.
*
* @param listener The listener that can refresh the adapter.
*/
public void setOnRefreshFolderListener(OnRefreshFolderListener listener) {
mListener = listener;
}
@Override
public int getItemViewType(int position) {
// The position also reflects the opened child folder row.
if (isShowingChildFolder()) {
if (position == 0) {
return VIEW_TYPE_FOLDER;
}
// Accounting for the folder view.
position--;
}
Cursor c = getCursor();
if (!c.moveToPosition(position)) {
throw new IllegalStateException("Couldn't move cursor to position " + position);
}
return getItemViewType(c);
}
/**
* Returns the type of the item at the given position in the cursor.
*
* @param cursor A cursor moved to the required position.
* @return The type of the item.
*/
public int getItemViewType(Cursor cursor) {
if (cursor.getInt(cursor.getColumnIndexOrThrow(Bookmarks.TYPE)) == Bookmarks.TYPE_FOLDER) {
return VIEW_TYPE_FOLDER;
}
// Default to returning normal item type.
return VIEW_TYPE_ITEM;
}
@Override
public int getViewTypeCount() {
return VIEW_TYPE_COUNT;
}
/**
* Get the title of the folder given a cursor moved to the position.
*
* @param context The context of the view.
* @param cursor A cursor moved to the required position.
* @return The title of the folder at the position.
*/
public String getFolderTitle(Context context, Cursor c) {
String guid = c.getString(c.getColumnIndexOrThrow(Bookmarks.GUID));
// If we don't have a special GUID, just return the folder title from the DB.
if (guid == null || guid.length() == 12) {
return c.getString(c.getColumnIndexOrThrow(Bookmarks.TITLE));
}
Resources res = context.getResources();
// Use localized strings for special folder names.
if (guid.equals(Bookmarks.FAKE_DESKTOP_FOLDER_GUID)) {
return res.getString(R.string.bookmarks_folder_desktop);
} else if (guid.equals(Bookmarks.MENU_FOLDER_GUID)) {
return res.getString(R.string.bookmarks_folder_menu);
} else if (guid.equals(Bookmarks.TOOLBAR_FOLDER_GUID)) {
return res.getString(R.string.bookmarks_folder_toolbar);
} else if (guid.equals(Bookmarks.UNFILED_FOLDER_GUID)) {
return res.getString(R.string.bookmarks_folder_unfiled);
}
// If for some reason we have a folder with a special GUID, but it's not one of
// the special folders we expect in the UI, just return the title from the DB.
return c.getString(c.getColumnIndexOrThrow(Bookmarks.TITLE));
}
/**
* @return true, if currently showing a child folder, false otherwise.
*/
public boolean isShowingChildFolder() {
return (mParentStack.peek().first != Bookmarks.FIXED_ROOT_ID);
}
@Override
public int getCount() {
return super.getCount() + (isShowingChildFolder() ? 1 : 0);
}
@Override
public View getView(int position, View convertView, ViewGroup parent) {
// The position also reflects the opened child folder row.
if (isShowingChildFolder()) {
if (position == 0) {
BookmarkFolderView folder = (BookmarkFolderView) LayoutInflater.from(parent.getContext()).inflate(R.layout.bookmark_folder_row, null);
folder.setText(mParentStack.peek().second);
folder.open();
return folder;
}
// Accounting for the folder view.
position--;
}
return super.getView(position, convertView, parent);
}
@Override
public void bindView(View view, Context context, Cursor cursor) {
final int viewType = getItemViewType(cursor);
if (viewType == VIEW_TYPE_ITEM) {
TwoLinePageRow row = (TwoLinePageRow) view;
row.updateFromCursor(cursor);
} else {
BookmarkFolderView row = (BookmarkFolderView) view;
row.setText(getFolderTitle(context, cursor));
row.close();
}
}
@Override
public View newView(Context context, Cursor cursor, ViewGroup parent) {
final int viewType = getItemViewType(cursor);
final int resId;
if (viewType == VIEW_TYPE_ITEM) {
resId = R.layout.home_item_row;
} else {
resId = R.layout.bookmark_folder_row;
}
return LayoutInflater.from(parent.getContext()).inflate(resId, null);
}
}

View File

@ -5,7 +5,6 @@
package org.mozilla.gecko.home;
import org.mozilla.gecko.R;
import org.mozilla.gecko.db.BrowserContract.Bookmarks;
import org.mozilla.gecko.db.BrowserDB.URLColumns;
import org.mozilla.gecko.home.HomePager.OnUrlOpenListener;
@ -13,19 +12,13 @@ import org.mozilla.gecko.util.GamepadUtils;
import android.content.Context;
import android.database.Cursor;
import android.support.v4.widget.CursorAdapter;
import android.util.AttributeSet;
import android.util.Pair;
import android.view.LayoutInflater;
import android.view.MotionEvent;
import android.view.View;
import android.view.ViewConfiguration;
import android.view.ViewGroup;
import android.widget.AdapterView;
import android.widget.ListView;
import java.util.LinkedList;
/**
* A ListView of bookmarks.
*/
@ -34,27 +27,12 @@ public class BookmarksListView extends HomeListView
public static final String LOGTAG = "GeckoBookmarksListView";
// A listener that knows how to refresh the list for a given folder id.
// This is usually implemented by the enclosing fragment/activity.
public static interface OnRefreshFolderListener {
// The folder id to refresh the list with.
public void onRefreshFolder(int folderId);
}
// A cursor based adapter.
private BookmarksListAdapter mCursorAdapter = null;
// The last motion event that was intercepted.
private MotionEvent mMotionEvent;
// The default touch slop.
private int mTouchSlop;
// Refresh folder listener.
private OnRefreshFolderListener mListener;
public BookmarksListView(Context context) {
this(context, null);
}
@ -74,21 +52,10 @@ public class BookmarksListView extends HomeListView
public void onAttachedToWindow() {
super.onAttachedToWindow();
// Intialize the adapter.
mCursorAdapter = new BookmarksListAdapter(getContext(), null);
setAdapter(mCursorAdapter);
setOnItemClickListener(this);
setOnKeyListener(GamepadUtils.getListItemClickDispatcher());
}
@Override
public void onDetachedFromWindow() {
super.onDetachedFromWindow();
mCursorAdapter = null;
mListener = null;
}
@Override
public boolean onInterceptTouchEvent(MotionEvent event) {
switch(event.getAction() & MotionEvent.ACTION_MASK) {
@ -132,10 +99,11 @@ public class BookmarksListView extends HomeListView
// Absolute position for the adapter.
position -= headerCount;
if (mCursorAdapter.isShowingChildFolder()) {
BookmarksListAdapter adapter = (BookmarksListAdapter) getAdapter();
if (adapter.isShowingChildFolder()) {
if (position == 0) {
// If we tap on an opened folder, move back to parent folder.
mCursorAdapter.moveToParentFolder();
adapter.moveToParentFolder();
return;
}
@ -143,7 +111,7 @@ public class BookmarksListView extends HomeListView
position--;
}
final Cursor cursor = mCursorAdapter.getCursor();
final Cursor cursor = adapter.getCursor();
if (cursor == null) {
return;
}
@ -154,8 +122,8 @@ public class BookmarksListView extends HomeListView
if (type == Bookmarks.TYPE_FOLDER) {
// If we're clicking on a folder, update adapter to move to that folder
final int folderId = cursor.getInt(cursor.getColumnIndexOrThrow(Bookmarks._ID));
final String folderTitle = mCursorAdapter.getFolderTitle(cursor);
mCursorAdapter.moveToChildFolder(folderId, folderTitle);
final String folderTitle = adapter.getFolderTitle(parent.getContext(), cursor);
adapter.moveToChildFolder(folderId, folderTitle);
} else {
// Otherwise, just open the URL
final String url = cursor.getString(cursor.getColumnIndexOrThrow(URLColumns.URL));
@ -165,203 +133,4 @@ public class BookmarksListView extends HomeListView
}
}
}
public void refreshFromCursor(Cursor cursor) {
// This will update the cursorAdapter to use the new one if it already exists.
mCursorAdapter.swapCursor(cursor);
}
public void setOnRefreshFolderListener(OnRefreshFolderListener listener) {
mListener = listener;
}
/**
* Adapter to back the ListView with a list of bookmarks.
*/
private class BookmarksListAdapter extends CursorAdapter {
private static final int VIEW_TYPE_ITEM = 0;
private static final int VIEW_TYPE_FOLDER = 1;
private static final int VIEW_TYPE_COUNT = 2;
// mParentStack holds folder id/title pairs that allow us to navigate
// back up the folder heirarchy.
private LinkedList<Pair<Integer, String>> mParentStack;
public BookmarksListAdapter(Context context, Cursor cursor) {
// Initializing with a null cursor.
super(context, cursor);
mParentStack = new LinkedList<Pair<Integer, String>>();
// Add the root folder to the stack
Pair<Integer, String> rootFolder = new Pair<Integer, String>(Bookmarks.FIXED_ROOT_ID, "");
mParentStack.addFirst(rootFolder);
}
// Refresh the current folder by executing a new task.
private void refreshCurrentFolder() {
if (mListener != null) {
mListener.onRefreshFolder(mParentStack.peek().first);
}
}
/**
* Moves to parent folder, if one exists.
*/
public void moveToParentFolder() {
// If we're already at the root, we can't move to a parent folder
if (mParentStack.size() != 1) {
mParentStack.removeFirst();
refreshCurrentFolder();
}
}
/**
* Moves to child folder, given a folderId.
*
* @param folderId The id of the folder to show.
* @param folderTitle The title of the folder to show.
*/
public void moveToChildFolder(int folderId, String folderTitle) {
Pair<Integer, String> folderPair = new Pair<Integer, String>(folderId, folderTitle);
mParentStack.addFirst(folderPair);
refreshCurrentFolder();
}
/**
* {@inheritDoc}
*/
@Override
public int getItemViewType(int position) {
// The position also reflects the opened child folder row.
if (isShowingChildFolder()) {
if (position == 0) {
return VIEW_TYPE_FOLDER;
}
// Accounting for the folder view.
position--;
}
Cursor c = getCursor();
if (!c.moveToPosition(position)) {
throw new IllegalStateException("Couldn't move cursor to position " + position);
}
return getItemViewType(c);
}
/**
* Returns the type of the item at the given position in the cursor.
*
* @param cursor A cursor moved to the required position.
* @return The type of the item.
*/
public int getItemViewType(Cursor cursor) {
if (cursor.getInt(cursor.getColumnIndexOrThrow(Bookmarks.TYPE)) == Bookmarks.TYPE_FOLDER) {
return VIEW_TYPE_FOLDER;
}
// Default to returning normal item type.
return VIEW_TYPE_ITEM;
}
/**
* {@inheritDoc}
*/
@Override
public int getViewTypeCount() {
return VIEW_TYPE_COUNT;
}
/**
* Get the title of the folder given a cursor moved to the position.
*
* @param cursor A cursor moved to the required position.
* @return The title of the folder at the position.
*/
public String getFolderTitle(Cursor c) {
String guid = c.getString(c.getColumnIndexOrThrow(Bookmarks.GUID));
// If we don't have a special GUID, just return the folder title from the DB.
if (guid == null || guid.length() == 12) {
return c.getString(c.getColumnIndexOrThrow(Bookmarks.TITLE));
}
// Use localized strings for special folder names.
if (guid.equals(Bookmarks.FAKE_DESKTOP_FOLDER_GUID)) {
return getResources().getString(R.string.bookmarks_folder_desktop);
} else if (guid.equals(Bookmarks.MENU_FOLDER_GUID)) {
return getResources().getString(R.string.bookmarks_folder_menu);
} else if (guid.equals(Bookmarks.TOOLBAR_FOLDER_GUID)) {
return getResources().getString(R.string.bookmarks_folder_toolbar);
} else if (guid.equals(Bookmarks.UNFILED_FOLDER_GUID)) {
return getResources().getString(R.string.bookmarks_folder_unfiled);
}
// If for some reason we have a folder with a special GUID, but it's not one of
// the special folders we expect in the UI, just return the title from the DB.
return c.getString(c.getColumnIndexOrThrow(Bookmarks.TITLE));
}
/**
* @return true, if currently showing a child folder, false otherwise.
*/
public boolean isShowingChildFolder() {
return (mParentStack.peek().first != Bookmarks.FIXED_ROOT_ID);
}
@Override
public int getCount() {
return super.getCount() + (isShowingChildFolder() ? 1 : 0);
}
@Override
public View getView(int position, View convertView, ViewGroup parent) {
// The position also reflects the opened child folder row.
if (isShowingChildFolder()) {
if (position == 0) {
BookmarkFolderView folder = (BookmarkFolderView) LayoutInflater.from(parent.getContext()).inflate(R.layout.bookmark_folder_row, null);
folder.setText(mParentStack.peek().second);
folder.open();
return folder;
}
// Accounting for the folder view.
position--;
}
return super.getView(position, convertView, parent);
}
@Override
public void bindView(View view, Context context, Cursor cursor) {
final int viewType = getItemViewType(cursor);
if (viewType == VIEW_TYPE_ITEM) {
TwoLinePageRow row = (TwoLinePageRow) view;
row.updateFromCursor(cursor);
} else {
BookmarkFolderView row = (BookmarkFolderView) view;
row.setText(getFolderTitle(cursor));
row.close();
}
}
@Override
public View newView(Context context, Cursor cursor, ViewGroup parent) {
final int viewType = getItemViewType(cursor);
final int resId;
if (viewType == VIEW_TYPE_ITEM) {
resId = R.layout.home_item_row;
} else {
resId = R.layout.bookmark_folder_row;
}
return LayoutInflater.from(parent.getContext()).inflate(resId, null);
}
}
}

View File

@ -8,10 +8,9 @@ package org.mozilla.gecko.home;
import org.mozilla.gecko.R;
import org.mozilla.gecko.db.BrowserContract.Bookmarks;
import org.mozilla.gecko.db.BrowserDB;
import org.mozilla.gecko.home.BookmarksListView.OnRefreshFolderListener;
import org.mozilla.gecko.home.BookmarksListAdapter.OnRefreshFolderListener;
import org.mozilla.gecko.home.HomePager.OnUrlOpenListener;
import android.app.Activity;
import android.content.Context;
import android.content.res.Configuration;
import android.database.Cursor;
@ -44,6 +43,9 @@ public class BookmarksPage extends HomeFragment {
// Grid of top bookmarks.
private TopBookmarksView mTopBookmarks;
// Adapter for list of bookmarks.
private BookmarksListAdapter mListAdapter;
// Callback for loaders.
private CursorLoaderCallbacks mLoaderCallbacks;
@ -71,15 +73,6 @@ public class BookmarksPage extends HomeFragment {
mList = (BookmarksListView) view.findViewById(R.id.bookmarks_list);
mList.setOnUrlOpenListener(listener);
mList.setOnRefreshFolderListener(new OnRefreshFolderListener() {
@Override
public void onRefreshFolder(int folderId) {
// Restart the loader with folder as the argument.
Bundle bundle = new Bundle();
bundle.putInt(BOOKMARKS_FOLDER_KEY, folderId);
getLoaderManager().restartLoader(BOOKMARKS_LIST_LOADER_ID, bundle, mLoaderCallbacks);
}
});
registerForContextMenu(mList);
@ -90,6 +83,19 @@ public class BookmarksPage extends HomeFragment {
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
// Setup the list adapter.
mListAdapter = new BookmarksListAdapter(getActivity(), null);
mListAdapter.setOnRefreshFolderListener(new OnRefreshFolderListener() {
@Override
public void onRefreshFolder(int folderId) {
// Restart the loader with folder as the argument.
Bundle bundle = new Bundle();
bundle.putInt(BOOKMARKS_FOLDER_KEY, folderId);
getLoaderManager().restartLoader(BOOKMARKS_LIST_LOADER_ID, bundle, mLoaderCallbacks);
}
});
mList.setAdapter(mListAdapter);
// Create callbacks before the initial loader is started.
mLoaderCallbacks = new CursorLoaderCallbacks();
@ -102,6 +108,7 @@ public class BookmarksPage extends HomeFragment {
@Override
public void onDestroyView() {
mList = null;
mListAdapter = null;
super.onDestroyView();
}
@ -189,7 +196,7 @@ public class BookmarksPage extends HomeFragment {
final int loaderId = loader.getId();
switch(loaderId) {
case BOOKMARKS_LIST_LOADER_ID: {
mList.refreshFromCursor(c);
mListAdapter.swapCursor(c);
break;
}
@ -206,7 +213,7 @@ public class BookmarksPage extends HomeFragment {
switch(loaderId) {
case BOOKMARKS_LIST_LOADER_ID: {
if (mList != null) {
mList.refreshFromCursor(null);
mListAdapter.swapCursor(null);
}
break;
}