Files.app: Add subfolders in the left nav

chrome/browser/resources/file_manager/js/sidebar.js

+// Copyright (c) 2013 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.
+
+/**
+ * Updates sub-elements of {@code parentElement} reading {@code DirectoryEntry}
+ * with calling {@code iterator}.
+ *
+ * @param {DirectoryItem|DirectoryTree} parentElement Parent element of newly
+ *     created items.
+ * @param {function(number): DirectoryEntry} iterator Function which returns
+ *     the n-th Entry in the directory.
+ * @param {DirectoryModel} directoryModel Current DirectoryModel.
+ */
+function updateSubElementsFromList(parentElement, iterator, directoryModel) {
+  var index = 0;
+  while (iterator(index)) {
+    var currentEntry = iterator(index);
+    var currentElement = parentElement.items[index];
+
+    if (index >= parentElement.items.length) {
+      var item = new DirectoryItem(currentEntry, parentElement, directoryModel);
+      parentElement.add(item);
+      index++;
+    } else if (currentEntry.fullPath == currentElement.fullPath) {
+      index++;
+    } else if (currentEntry.fullPath < currentElement.fullPath) {
+      var item = new DirectoryItem(currentEntry, parentElement, directoryModel);
+      parentElement.addAt(item, index);
+      index++;
+    } else if (currentEntry.fullPath > currentElement.fullPath) {
+      parentElement.remove(currentElement);
+    }
+  }
+
+  var removedChild;
+  while (removedChild = parentElement.items[index]) {
+    parentElement.remove(removedChild);
+  }
+
+  if (index == 0) {
+    parentElement.hasChildren = false;
+    parentElement.expanded = false;
+  } else {
+    parentElement.hasChildren = true;
+  }
+}
+
+/**
+ * A directory in the tree. One this element represents one directory. Each
+ * element represents one director.
+ *
+ * @param {DirectoryEntry} parentDirEntry DirectoryEntry of this item.
+ * @param {DirectoryItem|DirectoryTree} parentDirItem Parent of this item.
+ * @param {DirectoryModel} directoryModel Current DirectoryModel.
+ * @extends {cr.ui.TreeItem}
+ * @constructor
+ */
+function DirectoryItem(parentDirEntry, parentDirItem, directoryModel) {
+  var item = cr.doc.createElement('div');
+  DirectoryItem.decorate(item, parentDirEntry, parentDirItem, directoryModel);
+  return item;
+}
+
+/**
+ * @param {HTMLElement} el Element to be DirectoryItem.
+ * @param {DirectoryEntry} parentDirEntry DirectoryEntry of this item.
+ * @param {DirectoryItem|DirectoryTree} parentDirItem Parent of this item.
+ * @param {DirectoryModel} directoryModel Current DirectoryModel.
+ */
+DirectoryItem.decorate =
+    function(el, parentDirEntry, parentDirItem, directoryModel) {
+  el.__proto__ = DirectoryItem.prototype;
+  (/** @type {DirectoryItem} */ el).decorate(
+      parentDirEntry, parentDirItem, directoryModel);
+};
+
+DirectoryItem.prototype = {
+  __proto__: cr.ui.TreeItem.prototype,
+
+  /**
+   * The element containing the label text and the icon.
+   * @type {!HTMLElement}
+   * @override
+   **/
+  get labelElement() {
+      return this.firstElementChild.querySelector('.label');
+  }
+};
+
+/**
+ * @param {DirectoryEntry} parentDirEntry DirectoryEntry of this item.
+ * @param {DirectoryItem|DirectoryTree} parentDirItem Parent of this item.
+ * @param {DirectoryModel} directoryModel Current DirectoryModel.
+ */
+DirectoryItem.prototype.decorate = function(
+    parentDirEntry, parentDirItem, directoryModel) {
+  var path = parentDirEntry.fullPath;
+  var label = PathUtil.isRootPath(path) ?
+              PathUtil.getRootLabel(path) : parentDirEntry.name;
+
+  this.className = 'tree-item';
+  this.innerHTML =
+      '<div class="tree-row">' +
+      ' <span class="expand-icon"></span>' +
+      ' <span class="icon"></span>' +
+      ' <span class="label"></span>' +
+      ' <div class="root-eject"></div>' +
+      '</div>' +
+      '<div class="tree-children"></div>';
+  this.setAttribute('role', 'treeitem');
+
+  this.directoryModel_ = directoryModel;
+  this.parent_ = parentDirItem;
+  this.label = label;
+  this.fullPath = path;
+
+  // Sets hasChildren=true tentatively. This will be overridden after
+  // scanning sub-directories in updateSubElementsFromList.
+  this.hasChildren = true;
+
+  this.addEventListener('expand', this.onExpand_.bind(this), true);
+
+  var volumeManager = VolumeManager.getInstance();
+  var icon = this.querySelector('.icon');
+  if (PathUtil.isRootPath(path)) {
+    icon.classList.add('volume-icon');
+    var iconType = PathUtil.getRootType(path);
+    icon.setAttribute('volume-type-icon', iconType);
+
+    if (iconType == RootType.REMOVABLE)
+      icon.setAttribute('volume-subtype', volumeManager.getDeviceType(path));
+  }
+
+  var eject = this.querySelector('.root-eject');
+  eject.hidden = !PathUtil.isUnmountableByUser(path);
+  eject.addEventListener('click',
+      function(event) {
+        event.stopPropagation();
+        if (!PathUtil.isUnmountableByUser(path))
+          return;
+
+        volumeManager.unmount(path, function() {}, function() {});
+      }.bind(this));
+
+  if ('expanded' in parentDirItem || parentDirItem.expanded)
+    this.updateSubDirectoriesWithEntry_(parentDirEntry);
+};
+
+/**
+ * Invoked when the item is being expanded.
+ * @param {!UIEvent} e Event.
+ * @private
+ **/
+DirectoryItem.prototype.onExpand_ = function(e) {
+  this.updateSubDirectories(function() {
+    this.expanded = false;
+  }.bind(this));
+
+  e.stopPropagation();
+};
+
+/**
+ * Retrieve the latest subdirectories and update them on the tree.

[mtomasz, 2013/03/15 04:23:20]

Retrieve -> retrieves and in other places, please check. If the first word is a
verb, then it should be in a passive form.

[yoshiki, 2013/03/15 08:01:06]

Done.

+ * @param {function()=} opt_errorCallback Callback called on error.
+ */
+DirectoryItem.prototype.updateSubDirectories = function(opt_errorCallback) {
+  this.directoryModel_.resolveDirectory(
+      this.fullPath,
+      function(entry) {
+        this.updateSubDirectoriesWithEntry_(entry, opt_errorCallback);
+      }.bind(this),
+      opt_errorCallback);
+};
+
+/**
+ * Retrieve the latest subdirectories and update them on the tree.
+ * @param {!DirectoryEntry} dirEntry DirectoryEntry to read from.
+ * @param {function()=} opt_errorCallback Callback called on error.
+ * @private
+ */
+DirectoryItem.prototype.updateSubDirectoriesWithEntry_ =
+    function(dirEntry, opt_errorCallback) {
+  // Skips if the entry is dummy.
+  if (!('createReader' in dirEntry)) {
+    if (opt_errorCallback)
+      opt_errorCallback();
+    return;
+  }
+
+  var reader = dirEntry.createReader();
+  var entries = [];
+
+  var readEntry = function() {
+    reader.readEntries(function(results) {
+      if (!results.length) {
+        this.entries_ = entries.sort();
+        this.redrawSubDirectoryList_();
+        return;
+      }
+
+      for (var i = 0; i < results.length; i++) {
+        var entry = results[i];
+        if (entry.isDirectory)
+          entries.push(entry);
+      }
+      readEntry();
+    }.bind(this));
+  }.bind(this);
+  readEntry();
+};
+
+/**
+ * @private
+ */
+DirectoryItem.prototype.redrawSubDirectoryList_ = function() {
+  var entries = this.entries_;
+  updateSubElementsFromList(this,
+                            function(i) { return entries[i]; },
+                            this.directoryModel_);
+};
+
+/**
+ * Tree of directories on the sidebar. This element is also the root of items,
+ * in other words, this is the parent of the top-level items.
+ *
+ * @constructor
+ * @extends {cr.ui.Tree}
+ */
+function DirectoryTree() {}
+
+/**
+ * Decorates an element.
+ * @param {HTMLElement} el Element to be DirectoryTree.
+ * @param {DirectoryModel} directoryModel Current DirectoryModel.
+ */
+DirectoryTree.decorate = function(el, directoryModel) {
+  el.__proto__ = DirectoryTree.prototype;
+  (/** @type {DirectoryTree} */ el).decorate(directoryModel);
+};
+
+DirectoryTree.prototype = {
+  __proto__: cr.ui.Tree.prototype,
+};
+
+/**
+ * Decorates an element.
+ * @param {DirectoryModel} directoryModel Current DirectoryModel.
+ */
+DirectoryTree.prototype.decorate = function(directoryModel) {
+  cr.ui.Tree.prototype.decorate.call(this);
+
+  this.directoryModel_ = directoryModel;
+
+  this.rootsList_ = this.directoryModel_.getRootsList();
+  this.rootsList_.addEventListener('change',
+                                   this.onRootsListChanged_.bind(this));
+  this.rootsList_.addEventListener('permuted',
+                                   this.onRootsListChanged_.bind(this));
+  this.onRootsListChanged_();
+};
+
+/**
+ * Sets a context menu. Context menu is enabled only on archive and removable
+ * volumes as of now.
+ *
+ * @param {cr.ui.Menu} menu Context menu.
+ */
+DirectoryTree.prototype.setContextMenu = function(menu) {
+  this.contextMenu_ = menu;
+
+  for (var i = 0; i < this.rootsList_.length; i++) {
+    var item = this.rootsList_.item(i);
+    var type = PathUtil.getRootType(item.fullPath);
+    // Context menu is set only to archive and removable volumes.
+    if (type == RootType.ARCHIVE || type == RootType.REMOVABLE) {
+      cr.ui.contextMenuHandler.setContextMenu(this.items[i].rowElement,
+                                              this.contextMenu_);
+    }
+  }
+};
+
+/**
+ * Invoked when the root list is changed.
+ * @private
+ */
+DirectoryTree.prototype.onRootsListChanged_ = function() {
+  var rootsList = this.rootsList_;
+  updateSubElementsFromList(this,
+                            rootsList.item.bind(rootsList),
+                            this.directoryModel_);
+  this.setContextMenu(this.contextMenu_);
+};
+
+/**
+ * Returns the path of the selected item.
+ * @return {string} The current path.
+ */
+DirectoryTree.prototype.getCurrentPath = function() {
+  return this.selectedItem ? this.selectedItem.fullPath : null;
+};