[MD Bookmarks] Add Select for Bookmarks.

chrome/browser/resources/md_bookmarks/store.js

 // 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.
 
 var BookmarksStore = Polymer({
   is: 'bookmarks-store',
 
   properties: {
     /** @type {BookmarkTreeNode} */
     rootNode: {
@@ skipping 19 matching lines @@
      * selected folder.
      * @type {Array<BookmarkTreeNode>}
      */
     displayedList: {
       type: Array,
       notify: true,
       readOnly: true,
     },
 
     idToNodeMap_: Object,
+
+    prevSelectedItemIndex_: Number,

[calamity, 2017/01/24 06:39:17]

Hmm. I got confused by this thinking it was the actual previous selection index.
This is probably better called anchorIndex as in list_selection_controller.js.

[jiaxi, 2017/01/25 03:26:10]

Done.

   },
 
   /** @private {Object} */
   documentListeners_: null,
 
   /** @override */
   attached: function() {
     this.documentListeners_ = {
-      'selected-folder-changed': this.onSelectedFolderChanged_.bind(this),
       'folder-open-changed': this.onFolderOpenChanged_.bind(this),
       'search-term-changed': this.onSearchTermChanged_.bind(this),
+      'select-item': this.onItemSelected_.bind(this),
+      'selected-folder-changed': this.onSelectedFolderChanged_.bind(this),
     };
     for (var event in this.documentListeners_)
       document.addEventListener(event, this.documentListeners_[event]);
   },
 
   /** @override */
   detached: function() {
     for (var event in this.documentListeners_)
       document.removeEventListener(event, this.documentListeners_[event]);
   },
@@ skipping 23 matching lines @@
     this.idToNodeMap_ = {};
     this.rootNode.path = 'rootNode';
     BookmarksStore.generatePaths(rootNode, 0);
     BookmarksStore.initNodes(this.rootNode, this.idToNodeMap_);
     this.fire('selected-folder-changed', this.rootNode.children[0].id);
   },
 
   /** @private */
   deselectFolders_: function() {
     this.unlinkPaths('displayedList');
-    this.set(this.idToNodeMap_[this.selectedId].path + '.isSelected', false);
+    this.set(
+        this.idToNodeMap_[this.selectedId].path + '.isSelectedFolder', false);
     this.selectedId = null;
   },
 
   /**
    * @param {BookmarkTreeNode} folder
    * @private
    * @return {boolean}
    */
   isAncestorOfSelected_: function(folder) {
     if (!this.selectedId)
       return false;
 
     var selectedNode = this.idToNodeMap_[this.selectedId];
     return selectedNode.path.startsWith(folder.path);
   },
 
   /** @private */
   updateSearchDisplay_: function() {
     if (this.searchTerm == '') {
       this.fire('selected-folder-changed', this.rootNode.children[0].id);
     } else {
       chrome.bookmarks.search(this.searchTerm, function(results) {
+        this.clearSelectedItems_();
+        this.prevSelectedItemIndex_ = undefined;
+
         if (this.selectedId)
           this.deselectFolders_();
 
+        for (var i = 0; i < results.length; i++)
+          results[i].searchResultIndex = i;
+
         this._setDisplayedList(results);
       }.bind(this));
     }
   },
 
   /** @private */
   updateSelectedDisplay_: function() {
     // Don't change to the selected display if ID was cleared.
     if (!this.selectedId)
       return;
 
+    this.clearSelectedItems_();
+    this.prevSelectedItemIndex_ = undefined;
+
     var selectedNode = this.idToNodeMap_[this.selectedId];
     this.linkPaths('displayedList', selectedNode.path + '.children');
     this._setDisplayedList(selectedNode.children);
   },
 
   /**
    * Remove all descendants of a given node from the map.
    * @param {string} id
    * @private
    */
   removeDescendantsFromMap_: function(id) {
     var node = this.idToNodeMap_[id];
     if (!node)
       return;
 
     if (node.children) {
       for (var i = 0; i < node.children.length; i++)
         this.removeDescendantsFromMap_(node.children[i].id);
     }
     delete this.idToNodeMap_[id];
   },
 
+  /**
+   * Remove all selected items in the list.
+   * @private
+   */
+  clearSelectedItems_: function() {
+    if (!this.displayedList)
+      return;
+
+    for (var i = 0; i < this.displayedList.length; i++) {
+      if (!this.displayedList[i].isSelectedItem)
+        continue;
+
+      this.set('displayedList.#' + i + '.isSelectedItem', false);
+    }
+  },
+
+  /**
+   * Return the index in the search result of an item.
+   * @param {BookmarkTreeNode} item
+   * @return {number}
+   * @private
+   */
+  getIndexInList_: function(item) {
+    if (this.searchTerm)
+      return item.searchResultIndex;
+
+    return item.index;

[calamity, 2017/01/24 06:39:17]

I think this can just be return item.searchResultIndex || item.index;

[jiaxi, 2017/01/25 03:26:10]

This will return undefined if we select the first item in the displayedList
while searching (item.searchResultIndex = 0 = false in js).

+  },
+
+  isInDisplayedList_: function(id) {
+    if (this.searchTerm) {
+      for (var i = 0; i < this.displayedList.length; i++) {
+        if (this.displayedList[i].id == id)
+          return true;
+      }
+      return false;
+    }

[calamity, 2017/01/24 06:39:17]

You may want to think about caching this information in a map for fast lookup
instead of iterating.

[jiaxi, 2017/01/25 03:26:10]

Done.

+
+    return (this.idToNodeMap_[id].parentId == this.selectedId);

[calamity, 2017/01/24 06:39:17]

nit: No parens.

[jiaxi, 2017/01/25 03:26:10]

Done.

+  },
 ////////////////////////////////////////////////////////////////////////////////
 // bookmarks-store, bookmarks API event listeners:
 
   /**
    * Callback for when a bookmark node is removed.
    * If a folder is selected or is an ancestor of a selected folder, the parent
    * of the removed folder will be selected.
    * @param {string} id The id of the removed bookmark node.
    * @param {!{index: number,
    *           parentId: string,
    *           node: BookmarkTreeNode}} removeInfo
    */
   onBookmarkRemoved_: function(id, removeInfo) {
-    if (this.isAncestorOfSelected_(this.idToNodeMap_[id])) {
-      this.fire('selected-folder-changed', removeInfo.parentId);
-    }
+    chrome.bookmarks.getSubTree(removeInfo.parentId, function(parentNode) {

[calamity, 2017/01/24 06:39:17]

Call this parentNodes so it's not confused with the var below.

[jiaxi, 2017/01/25 03:26:11]

Done.

+      var parentNode = parentNode[0];
+      var isAncestor = this.isAncestorOfSelected_(this.idToNodeMap_[id]);
+      var isInDisplayedList = this.isInDisplayedList_(id);
 
-    var parentNode = this.idToNodeMap_[removeInfo.parentId];
-    this.splice(parentNode.path + '.children', removeInfo.index, 1);
-    this.removeDescendantsFromMap_(id);
-    BookmarksStore.generatePaths(parentNode, removeInfo.index);
+      // Update the tree.
+      this.removeDescendantsFromMap_(id);

[calamity, 2017/01/24 06:39:17]

Should this be replacing the parent node? Is this even necessary since you're
setting a new parentNode later anyway?

[jiaxi, 2017/01/25 03:26:11]

Discussed offline. This will remove all the extra nodes in the idToNodeMap_.

+      parentNode.path = this.idToNodeMap_[parentNode.id].path;
+      BookmarksStore.generatePaths(parentNode, 0);
+      BookmarksStore.initNodes(parentNode, this.idToNodeMap_);
+      this.set(parentNode.path, parentNode)
 
-    // Regenerate the search list if its displayed.
-    if (this.searchTerm)
-      this.updateSearchDisplay_();
+      // Update selectedId if the removed node is an ancestor of the current
+      // selected node.
+      if (isAncestor)
+        this.fire('selected-folder-changed', removeInfo.parentId);
+
+      // Only update the displayedList if the removed node is in the
+      // displayedList.
+      if (isInDisplayedList) {

[calamity, 2017/01/24 06:39:17]

Invert and early return.

[jiaxi, 2017/01/25 03:26:11]

Done.

+        if (this.prevSelectedItemIndex_ == this.displayedList.length - 1)
+          this.prevSelectedItemIndex_--;
+
+        if (this.searchTerm) {
+          chrome.bookmarks.search(this.searchTerm, function(results) {
+            for (var i = 0; i < results.length; i++)
+              results[i].searchResultIndex = i;

[calamity, 2017/01/24 06:39:17]

This code should really be shared with the searching code.

[jiaxi, 2017/01/25 03:26:11]

Done.

+
+            this._setDisplayedList(results);
+
+            this.set(
+                'displayedList.#' + this.prevSelectedItemIndex_ +
+                    '.isSelectedItem',
+                true);

[calamity, 2017/01/24 06:39:17]

What if prevSelectedItemIndex is null?

[jiaxi, 2017/01/25 03:26:11]

The prevSelectedItemIndex(anchorIndex) can only be either undefined or a number.
When it is undefined it will not select anything.

+          }.bind(this));
+        } else {
+          this._setDisplayedList(parentNode.children);
+
+          this.set(
+              'displayedList.#' + this.prevSelectedItemIndex_ +
+                  '.isSelectedItem',
+              true);
+        }
+      }
+    }.bind(this));
   },
 
   /**
    * Called when the title of a bookmark changes.
    * @param {string} id The id of changed bookmark node.
    * @param {!Object} changeInfo
    */
   onBookmarkChanged_: function(id, changeInfo) {
     if (changeInfo.title)
       this.set(this.idToNodeMap_[id].path + '.title', changeInfo.title);
@@ skipping 19 matching lines @@
    * Selects the folder specified by the event and deselects the previously
    * selected folder.
    * @param {CustomEvent} e
    * @private
    */
   onSelectedFolderChanged_: function(e) {
     if (this.searchTerm)
       this.searchTerm = '';
 
     // Deselect the old folder if defined.
-    if (this.selectedId)
-      this.set(this.idToNodeMap_[this.selectedId].path + '.isSelected', false);
+    if (this.selectedId && this.idToNodeMap_[this.selectedId])
+      this.set(
+          this.idToNodeMap_[this.selectedId].path + '.isSelectedFolder', false);
 
     var selectedId = /** @type {string} */ (e.detail);
     var newFolder = this.idToNodeMap_[selectedId];
-    this.set(newFolder.path + '.isSelected', true);
+    this.set(newFolder.path + '.isSelectedFolder', true);
     this.selectedId = selectedId;
   },
 
   /**
    * Handles events that open and close folders.
    * @param {CustomEvent} e
    * @private
    */
   onFolderOpenChanged_: function(e) {
     var folder = this.idToNodeMap_[e.detail.id];
     this.set(folder.path + '.isOpen', e.detail.open);
     if (!folder.isOpen && this.isAncestorOfSelected_(folder))
       this.fire('selected-folder-changed', folder.id);
   },
+
+  /**
+   * Select a single item in the list.
+   * @param {BookmarkTreeNode} item
+   * @private
+   */
+  onSingleItemSelected_: function(item) {
+    this.clearSelectedItems_();
+    this.prevSelectedItemIndex_ = this.getIndexInList_(item);
+    this.set(
+        'displayedList.#' + this.prevSelectedItemIndex_ + '.isSelectedItem',
+        true);
+  },
+
+  /**
+   * Select multiple items based on |prevSelectedItemIndex_| and the selected
+   * item. If |prevSelectedItemIndex_| is not set, single select the item.
+   * @param {BookmarkTreeNode} item
+   * @private
+   */
+  onMultipleItemsShiftSelected_: function(item) {
+    this.clearSelectedItems_();
+    var startIndex, endIndex;
+    if (this.prevSelectedItemIndex_ == undefined) {
+      this.prevSelectedItemIndex_ = this.getIndexInList_(item);
+      startIndex = this.prevSelectedItemIndex_;
+      endIndex = this.prevSelectedItemIndex_;
+    } else {
+      var currIndex = this.getIndexInList_(item);

[calamity, 2017/01/24 06:39:17]

nit: selectedIndex.

[jiaxi, 2017/01/25 03:26:11]

Done.

+      startIndex = Math.min(this.prevSelectedItemIndex_, currIndex);
+      endIndex = Math.max(this.prevSelectedItemIndex_, currIndex);
+    }
+    for (var i = startIndex; i <= endIndex; i++)
+      this.set('displayedList.#' + i + '.isSelectedItem', true);
+  },
+
+  /**
+   * Select multiple items with the index of the last elected item as
+   * |prevSelectedItemIndex_|.
+   * @param {BookmarkTreeNode} item
+   * @private
+   */
+  onMultipleItemsCtrlSelected_: function(item) {
+    this.prevSelectedItemIndex_ = this.getIndexInList_(item);
+    this.set(
+        'displayedList.#' + this.prevSelectedItemIndex_ + '.isSelectedItem',
+        true);
+  },
+
+  /**
+   * Select item according to keyboard behaviours.
+   * @param {CustomEvent} e
+   * @private
+   */
+  onItemSelected_: function(e) {
+    if (e.detail.shiftKey)
+      this.onMultipleItemsShiftSelected_(e.detail.item);
+    else if (e.detail.ctrlKey)
+      this.onMultipleItemsCtrlSelected_(e.detail.item);
+    else
+      this.onSingleItemSelected_(e.detail.item);
+  },
 });
 
 ////////////////////////////////////////////////////////////////////////////////
 // bookmarks-store, static methods:
 
 /**
  * Stores the path from the store to a node inside the node.
  * @param {BookmarkTreeNode} bookmarkNode
  * @param {number} startIndex
  */
 BookmarksStore.generatePaths = function(bookmarkNode, startIndex) {
   if (!bookmarkNode.children)
     return;
 
   for (var i = startIndex; i < bookmarkNode.children.length; i++) {
     bookmarkNode.children[i].path = bookmarkNode.path + '.children.#' + i;
     BookmarksStore.generatePaths(bookmarkNode.children[i], 0);
   }
 };
 
 /**
  * Initializes the nodes in the bookmarks tree as follows:
  * - Populates |idToNodeMap_| with a mapping of all node ids to their
  *   corresponding BookmarkTreeNode.
  * - Sets all the nodes to not selected and open by default.
  * @param {BookmarkTreeNode} bookmarkNode
  * @param {Object=} idToNodeMap
  */
 BookmarksStore.initNodes = function(bookmarkNode, idToNodeMap) {
+  bookmarkNode.isSelectedItem = false;
   if (idToNodeMap)
     idToNodeMap[bookmarkNode.id] = bookmarkNode;
 
   if (bookmarkNode.url)
     return;
 
-  bookmarkNode.isSelected = false;
+  bookmarkNode.isSelectedFolder = false;
   bookmarkNode.isOpen = true;
   for (var i = 0; i < bookmarkNode.children.length; i++)
     BookmarksStore.initNodes(bookmarkNode.children[i], idToNodeMap);
 };