[tabbed options] more work on content settings exceptions lists

chrome/browser/resources/options/content_settings_exceptions_area.js

 // Copyright (c) 2010 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.
 
 cr.define('options.contentSettings', function() {
   const List = cr.ui.List;
   const ListItem = cr.ui.ListItem;
   const ArrayDataModel = cr.ui.ArrayDataModel;
 
   /**
@@ skipping 21 matching lines @@
 
   ExceptionsListItem.prototype = {
     __proto__: ListItem.prototype,
 
     /**
      * Called when an element is decorated as a list item.
      */
     decorate: function() {
       ListItem.prototype.decorate.call(this);
 
-      // Labels for display mode.
-      var patternLabel = cr.doc.createElement('span');
-      patternLabel.textContent = this.pattern;
-      this.appendChild(patternLabel);
+      // Labels for display mode. |pattern| will be null for the 'add new
+      // exception' row.
+      if (this.pattern) {
+        var patternLabel = cr.doc.createElement('span');
+        patternLabel.textContent = this.pattern;
+        patternLabel.className = 'exceptionPattern';
+        this.appendChild(patternLabel);
+        this.patternLabel = patternLabel;
 
-      var settingLabel = cr.doc.createElement('span');
-      settingLabel.textContent = this.settingForDisplay();
-      settingLabel.className = 'exceptionSetting';
-      this.appendChild(settingLabel);
+        var settingLabel = cr.doc.createElement('span');
+        settingLabel.textContent = this.settingForDisplay();
+        settingLabel.className = 'exceptionSetting';
+        this.appendChild(settingLabel);
+        this.settingLabel = settingLabel;
+      }
 
       // Elements for edit mode.
       var input = cr.doc.createElement('input');
       input.type = 'text';
       this.appendChild(input);
-      input.className = 'exceptionInput hidden';
+      input.className = 'exceptionPattern hidden';
 
       var select = cr.doc.createElement('select');
       var optionAllow = cr.doc.createElement('option');
       optionAllow.textContent = templateData.allowException;
       select.appendChild(optionAllow);
 
       if (this.enableAskOption) {
         var optionAsk = cr.doc.createElement('option');
         optionAsk.textContent = templateData.askException;
         select.appendChild(optionAsk);
@@ skipping 19 matching lines @@
       // current text in the input is valid. Changing the text resets this to
       // false, and getting a response from the browser sets it back to true.
       // It starts off as false for empty string (new exceptions) or true for
       // already-existing exceptions (which we assume are valid).
       this.inputValidityKnown = this.pattern;
       // This one tracks the actual validity of the pattern in the input. This
       // starts off as true so as not to annoy the user when he adds a new and
       // empty input.
       this.inputIsValid = true;
 
-      this.patternLabel = patternLabel;
-      this.settingLabel = settingLabel;
       this.input = input;
       this.select = select;
       this.optionAllow = optionAllow;
       this.optionBlock = optionBlock;
 
       this.updateEditables();
-      if (!this.pattern)
-        input.value = templateData.examplePattern;
 
       var listItem = this;
-      this.ondblclick = function(event) {
+
+      this.addEventListener('selectedChange', function(event) {
         // Editing notifications and geolocation is disabled for now.
         if (listItem.contentType == 'notifications' ||
             listItem.contentType == 'location')
           return;
 
-        listItem.editing = true;
-      };
+        listItem.editing = listItem.selected;
+      });
 
       // Handle events on the editable nodes.
       input.oninput = function(event) {
         listItem.inputValidityKnown = false;
         chrome.send('checkExceptionPatternValidity',
                     [listItem.contentType, listItem.mode, input.value]);
       };
 
       // Handles enter and escape which trigger reset and commit respectively.
       function handleKeydown(e) {
         // Make sure that the tree does not handle the key.
         e.stopPropagation();
 
         // Calling list.focus blurs the input which will stop editing the list
         // item.
         switch (e.keyIdentifier) {
           case 'U+001B':  // Esc
             // Reset the inputs.
             listItem.updateEditables();
-            if (listItem.pattern)
-              listItem.maybeSetPatternValid(listItem.pattern, true);
+            listItem.setPatternValid(true);
           case 'Enter':
-            if (listItem.parentNode)
-              listItem.parentNode.focus();
+            listItem.ownerDocument.activeElement.blur();
         }
       }
 
-      function handleBlur(e) {
-        // When the blur event happens we do not know who is getting focus so we
-        // delay this a bit since we want to know if the other input got focus
-        // before deciding if we should exit edit mode.
-        var doc = e.target.ownerDocument;
-        window.setTimeout(function() {
-          var activeElement = doc.activeElement;
-          if (!listItem.contains(activeElement)) {
-            listItem.editing = false;
-          }
-        }, 50);
-      }
-
       input.addEventListener('keydown', handleKeydown);
-      input.addEventListener('blur', handleBlur);
-
       select.addEventListener('keydown', handleKeydown);
-      select.addEventListener('blur', handleBlur);
     },
 
     /**
      * The pattern (e.g., a URL) for the exception.
      * @type {string}
      */
     get pattern() {
       return this.dataItem['displayPattern'];
     },
     set pattern(pattern) {
@@ skipping 21 matching lines @@
         return templateData.allowException;
       else if (setting == 'block')
         return templateData.blockException;
       else if (setting == 'ask')
         return templateData.askException;
       else if (setting == 'session')
         return templateData.sessionException;
     },
 
     /**
-     * Update this list item to reflect whether the input is a valid pattern
-     * if |pattern| matches the text currently in the input.
-     * @param {string} pattern The pattern.
+     * Update this list item to reflect whether the input is a valid pattern.
      * @param {boolean} valid Whether said pattern is valid in the context of
      *     a content exception setting.
      */
-    maybeSetPatternValid: function(pattern, valid) {
-      // Don't do anything for messages where we are not the intended recipient,
-      // or if the response is stale (i.e. the input value has changed since we
-      // sent the request to analyze it).
-      if (pattern != this.input.value)
-        return;
-
-      if (valid)
+    setPatternValid: function(valid) {
+      if (valid || !this.input.value)
         this.input.setCustomValidity('');
       else
         this.input.setCustomValidity(' ');
       this.inputIsValid = valid;
       this.inputValidityKnown = true;
     },
 
     /**
+     * Set the <input> to its original contents. Used when the user quits
+     * editing.
+     */
+    resetInput: function() {
+      this.input.value = this.pattern;
+    },
+
+    /**
      * Copy the data model values to the editable nodes.
      */
     updateEditables: function() {
-      this.input.value = this.pattern;
+      this.resetInput();
 
       if (this.setting == 'allow')
         this.optionAllow.selected = true;
       else if (this.setting == 'block')
         this.optionBlock.selected = true;
       else if (this.setting == 'session' && this.optionSession)
         this.optionSession.selected = true;
       else if (this.setting == 'ask' && this.optionAsk)
         this.optionAsk.selected = true;
     },
 
     /**
+     * Fiddle with the display of elements of this list item when the editing
+     * mode changes.
+     */
+    toggleVisibilityForEditing: function() {
+      this.patternLabel.classList.toggle('hidden');
+      this.settingLabel.classList.toggle('hidden');
+      this.input.classList.toggle('hidden');
+      this.select.classList.toggle('hidden');
+    },
+
+    /**
      * Whether the user is currently able to edit the list item.
      * @type {boolean}
      */
     get editing() {
       return this.hasAttribute('editing');
     },
     set editing(editing) {
       var oldEditing = this.editing;
       if (oldEditing == editing)
         return;
 
-      var listItem = this;
-      var pattern = this.pattern;
-      var setting = this.setting;
-      var patternLabel = this.patternLabel;
-      var settingLabel = this.settingLabel;
       var input = this.input;
-      var select = this.select;
-      var optionAllow = this.optionAllow;
-      var optionBlock = this.optionBlock;
-      var optionSession = this.optionSession;
-      var optionAsk = this.optionAsk;
 
-      // Just delete this row if it was added via the Add button.
-      if (!editing && !pattern && !input.value) {
-        var model = listItem.parentNode.dataModel;
-        model.splice(model.indexOf(listItem.dataItem), 1);
-        return;
-      }
-
-      // Check that we have a valid pattern and if not we do not change the
-      // editing mode.
-      if (!editing && (!this.inputValidityKnown || !this.inputIsValid)) {
-        input.focus();
-        input.select();
-        return;
-      }
-
-      patternLabel.classList.toggle('hidden');
-      settingLabel.classList.toggle('hidden');
-      input.classList.toggle('hidden');
-      select.classList.toggle('hidden');
-
-      var doc = this.ownerDocument;
-      var area = doc.querySelector('div[contentType=' +
-          listItem.contentType + '][mode=' + listItem.mode + ']');
-      area.enableAddAndEditButtons(!editing);
+      this.toggleVisibilityForEditing();
 
       if (editing) {
         this.setAttribute('editing', '');
         cr.ui.limitInputWidth(input, this, 20);
-        input.focus();
-        input.select();
+        // When this is called in response to the selectedChange event,
+        // the list grabs focus immediately afterwards. Thus we must delay
+        // our focus grab.
+        window.setTimeout(function() {
+          input.focus();
+          input.select();
+        }, 50);
+
+        // TODO(estade): should we insert example text here for the AddNewRow
+        // input?
       } else {
         this.removeAttribute('editing');
 
+        // Check that we have a valid pattern and if not we do not, abort
+        // changes to the exception.
+        if (!this.inputValidityKnown || !this.inputIsValid) {
+          this.updateEditables();
+          this.setPatternValid(true);
+          return;
+        }
+
         var newPattern = input.value;
 
         var newSetting;
+        var optionAllow = this.optionAllow;
+        var optionBlock = this.optionBlock;
+        var optionSession = this.optionSession;
+        var optionAsk = this.optionAsk;
         if (optionAllow.selected)
           newSetting = 'allow';
         else if (optionBlock.selected)
           newSetting = 'block';
         else if (optionSession && optionSession.selected)
           newSetting = 'session';
         else if (optionAsk && optionAsk.selected)
           newSetting = 'ask';
 
-        // Empty edit - do nothing.
-        if (pattern == newPattern && newSetting == this.setting)
-          return;
+        this.finishEdit(newPattern, newSetting);
+      }
+    },
 
-        this.pattern = patternLabel.textContent = newPattern;
-        this.setting = newSetting;
-        settingLabel.textContent = this.settingForDisplay();
+    /**
+     * Editing is complete; update the model.
+     * @type {string} newPattern The pattern that the user entered.
+     * @type {string} newSetting The setting the user chose.
+     */
+    finishEdit: function(newPattern, newSetting) {
+      // Empty edit - do nothing.
+      if (newPattern == this.pattern && newSetting == this.setting)
+        return;
 
-        if (pattern != this.pattern) {
-          chrome.send('removeExceptions',
-                      [this.contentType, this.mode, pattern]);
-        }
+      this.patternLabel.textContent = newPattern;
+      this.settingLabel.textContent = this.settingForDisplay();
+      var oldPattern = this.pattern;
+      this.pattern = newPattern;
+      this.setting = newSetting;
 
-        chrome.send('setException',
-                    [this.contentType, this.mode, this.pattern, this.setting]);
+      if (oldPattern != newPattern) {
+        chrome.send('removeExceptions',
+                    [this.contentType, this.mode, oldPattern]);
       }
+
+      chrome.send('setException',
+                  [this.contentType, this.mode, newPattern, newSetting]);
     }
   };
 
   /**
+   * Creates a new list item for the Add New Item row, which doesn't represent
+   * an actual entry in the exceptions list but allows the user to add new
+   * exceptions.
+   * @param {string} contentType The type of the list.
+   * @param {string} mode The browser mode, 'otr' or 'normal'.
+   * @param {boolean} enableAskOption Whether to show an 'ask every time'
+   *     option in the select.
+   * @constructor
+   * @extends {cr.ui.ExceptionsListItem}
+   */
+  function ExceptionsAddRowListItem(contentType, mode, enableAskOption) {
+    var el = cr.doc.createElement('li');
+    el.mode = mode;
+    el.contentType = contentType;
+    el.enableAskOption = enableAskOption;
+    el.dataItem = [];
+    el.__proto__ = ExceptionsAddRowListItem.prototype;
+    el.decorate();
+
+    return el;
+  }
+
+  ExceptionsAddRowListItem.prototype = {
+    __proto__: ExceptionsListItem.prototype,
+
+    decorate: function() {
+      ExceptionsListItem.prototype.decorate.call(this);
+
+      this.input.placeholder = templateData.addNewExceptionInstructions;
+      this.input.classList.remove('hidden');
+      this.select.classList.remove('hidden');
+
+      // Do we always want a default of allow?
+      this.setting = 'allow';
+    },
+
+    /**
+     * Clear the <input> and let the placeholder text show again.
+     */
+    resetInput: function() {
+      this.input.value = '';
+    },
+
+    /**
+     * No elements show or hide when going into edit mode, so do nothing.
+     */
+    toggleVisibilityForEditing: function() {
+      // No-op.
+    },
+
+    /**
+     * Editing is complete; update the model. As long as the pattern isn't
+     * empty, we'll just add it.
+     * @type {string} newPattern The pattern that the user entered.
+     * @type {string} newSetting The setting the user chose.
+     */
+    finishEdit: function(newPattern, newSetting) {
+      if (newPattern == '')
+        return;
+
+      chrome.send('setException',
+                  [this.contentType, this.mode, newPattern, newSetting]);
+    },
+  };
+
+  /**
    * Creates a new exceptions list.
    * @constructor
    * @extends {cr.ui.List}
    */
   var ExceptionsList = cr.ui.define('list');
 
   ExceptionsList.prototype = {
     __proto__: List.prototype,
 
     /**
      * Called when an element is decorated as a list.
      */
     decorate: function() {
       List.prototype.decorate.call(this);
 
-      this.dataModel = new ArrayDataModel([]);
+      this.contentType = this.parentNode.getAttribute('contentType');
+      this.mode = this.getAttribute('mode');
+
+      var exceptionList = this;
+      function handleBlur(e) {
+        // When the blur event happens we do not know who is getting focus so we
+        // delay this a bit until we know if the new focus node is outside the list.
+        var doc = e.target.ownerDocument;
+        window.setTimeout(function() {
+          var activeElement = doc.activeElement;
+          if (!exceptionList.contains(activeElement))
+            exceptionList.selectionModel.clear();
+        }, 50);
+      }
+
+      this.addEventListener('blur', handleBlur, true);
 
       // Whether the exceptions in this list allow an 'Ask every time' option.
       this.enableAskOption = (this.contentType == 'plugins' &&
                               templateData.enable_click_to_play);
+
+      this.reset();
     },
 
     /**
      * Creates an item to go in the list.
      * @param {Object} entry The element from the data model for this row.
      */
     createItem: function(entry) {
-      return new ExceptionsListItem(this.contentType,
-                                    this.mode,
-                                    this.enableAskOption,
-                                    entry);
+      if (entry) {
+        return new ExceptionsListItem(this.contentType,
+                                      this.mode,
+                                      this.enableAskOption,
+                                      entry);
+      } else {
+        return new ExceptionsAddRowListItem(this.contentType,
+                                            this.mode,
+                                            this.enableAskOption);
+      }
     },
 
     /**
      * Adds an exception to the js model.
      * @param {Object} entry A dictionary of values for the exception.
      */
     addException: function(entry) {
       this.dataModel.push(entry);
-
-      // When an empty row is added, put it into editing mode.
-      if (!entry['displayPattern'] && !entry['setting']) {
-        var index = this.dataModel.length - 1;
-        var sm = this.selectionModel;
-        sm.anchorIndex = sm.leadIndex = sm.selectedIndex = index;
-        this.scrollIndexIntoView(index);
-        var li = this.getListItemByIndex(index);
-        li.editing = true;
-      }
     },
 
     /**
      * The browser has finished checking a pattern for validity. Update the
      * list item to reflect this.
      * @param {string} pattern The pattern.
      * @param {bool} valid Whether said pattern is valid in the context of
      *     a content exception setting.
      */
     patternValidityCheckComplete: function(pattern, valid) {
-      for (var i = 0; i < this.dataModel.length; i++) {
-        var listItem = this.getListItemByIndex(i);
-        if (listItem)
-          listItem.maybeSetPatternValid(pattern, valid);
+      var listItems = this.items;
+      for (var i = 0; i < listItems.length; i++) {
+        var listItem = listItems[i];
+        // Don't do anything for messages for the item if it is not the intended
+        // recipient, or if the response is stale (i.e. the input value has
+        // changed since we sent the request to analyze it).
+        if (pattern == listItem.input.value)
+          listItem.setPatternValid(valid);
       }
     },
 
     /**
      * Removes all exceptions from the js model.
      */
-    clear: function() {
-      this.dataModel = new ArrayDataModel([]);
+    reset: function() {
+      // The null creates the Add New Exception row.
+      this.dataModel = new ArrayDataModel([null]);
     },
 
     /**
      * Removes all selected rows from browser's model.
      */
     removeSelectedRows: function() {
       // The first member is the content type; the rest of the values describe
       // the patterns we are removing.
       var args = [this.contentType];
       var selectedItems = this.selectedItems;
@@ skipping 18 matching lines @@
      */
     editSelectedRow: function() {
       var li = this.getListItem(this.selectedItem);
       if (li)
         li.editing = true;
     }
   };
 
   return {
     ExceptionsListItem: ExceptionsListItem,
+    ExceptionsAddRowListItem: ExceptionsAddRowListItem,
     ExceptionsList: ExceptionsList,
   };
 });