Refactorings to reduce dependencies in ChromeVox 2.

chrome/browser/resources/chromeos/chromevox/common/braille_util.js

 // Copyright 2014 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.
 
 /**
  * @fileoverview A utility class for general braille functionality.
  */
 
 
 goog.provide('cvox.BrailleUtil');
-goog.provide('cvox.BrailleUtil.ValueSelectionSpan');
-goog.provide('cvox.BrailleUtil.ValueSpan');
 
 goog.require('cvox.ChromeVox');
 goog.require('cvox.DomUtil');
+goog.require('cvox.EditableTextAreaShadow');
 goog.require('cvox.Focuser');
 goog.require('cvox.NavBraille');
 goog.require('cvox.NodeStateUtil');
 goog.require('cvox.Spannable');
+goog.require('cvox.ValueSelectionSpan');
+goog.require('cvox.ValueSpan');
 
 
 /**
  * Trimmable whitespace character that appears between consecutive items in
  * braille.
  * @const {string}
  */
 cvox.BrailleUtil.ITEM_SEPARATOR = ' ';
 
 
@@ skipping 44 matching lines @@
   'input_type_submit': 'n r s',
   'input_type_text': 'n: v r s',
   'input_type_tel': 'n: v r s',
   'input_type_url': 'n: v r s',
   'tag_button': 'n r s',
   'tag_textarea': 'n: v r s'
 };
 
 
 /**
- * Attached to the value region of a braille spannable.
- * @param {number} offset The offset of the span into the value.
- * @constructor
- */
-cvox.BrailleUtil.ValueSpan = function(offset) {
-  /**
-   * The offset of the span into the value.
-   * @type {number}
-   */
-  this.offset = offset;
-};
-
-
-/**
- * Creates a value span from a json serializable object.
- * @param {!Object} obj The json serializable object to convert.
- * @return {!cvox.BrailleUtil.ValueSpan} The value span.
- */
-cvox.BrailleUtil.ValueSpan.fromJson = function(obj) {
-  return new cvox.BrailleUtil.ValueSpan(obj.offset);
-};
-
-
-/**
- * Converts this object to a json serializable object.
- * @return {!Object} The JSON representation.
- */
-cvox.BrailleUtil.ValueSpan.prototype.toJson = function() {
-  return this;
-};
-
-
-cvox.Spannable.registerSerializableSpan(
-    cvox.BrailleUtil.ValueSpan,
-    'cvox.BrailleUtil.ValueSpan',
-    cvox.BrailleUtil.ValueSpan.fromJson,
-    cvox.BrailleUtil.ValueSpan.prototype.toJson);
-
-
-/**
- * Attached to the selected text within a value.
- * @constructor
- */
-cvox.BrailleUtil.ValueSelectionSpan = function() {
-};
-
-
-cvox.Spannable.registerStatelessSerializableSpan(
-    cvox.BrailleUtil.ValueSelectionSpan,
-    'cvox.BrailleUtil.ValueSelectionSpan');
-
-
-/**
  * Gets the braille name for a node.
  * See DomUtil for a more precise definition of 'name'.
  * Additionally, whitespace is trimmed.
  * @param {Node} node The node.
  * @return {string} The string representation.
  */
 cvox.BrailleUtil.getName = function(node) {
   if (!node) {
     return '';
   }
@@ skipping 66 matching lines @@
     var msg = cvox.BrailleUtil.getRoleMsg(container);
     if (msg && cvox.BrailleUtil.CONTAINER.indexOf(msg) != -1) {
       return cvox.ChromeVox.msgs.getMsg(msg);
     }
   }
   return '';
 };
 
 
 /**
- * Gets the braille value of a node. A cvox.BrailleUtil.ValueSpan will be
- * attached, along with (possibly) a cvox.BrailleUtil.ValueSelectionSpan.
+ * Gets the braille value of a node. A {@code cvox.ValueSpan} will be
+ * attached, along with (possibly) a {@code cvox.ValueSelectionSpan}.
  * @param {Node} node The node.
  * @return {!cvox.Spannable} The value spannable.
  */
 cvox.BrailleUtil.getValue = function(node) {
   if (!node) {
     return new cvox.Spannable();
   }
-  var valueSpan = new cvox.BrailleUtil.ValueSpan(0 /* offset */);
+  var valueSpan = new cvox.ValueSpan(0 /* offset */);
   if (cvox.DomUtil.isInputTypeText(node)) {
     var value = node.value;
     if (node.type === 'password') {
       value = value.replace(/./g, '*');
     }
     var spannable = new cvox.Spannable(value, valueSpan);
     if (node === document.activeElement &&
         cvox.DomUtil.doesInputSupportSelection(node)) {
       var selectionStart = cvox.BrailleUtil.clamp_(
           node.selectionStart, 0, spannable.getLength());
       var selectionEnd = cvox.BrailleUtil.clamp_(
           node.selectionEnd, 0, spannable.getLength());
-      spannable.setSpan(new cvox.BrailleUtil.ValueSelectionSpan(),
+      spannable.setSpan(new cvox.ValueSelectionSpan(),
                         Math.min(selectionStart, selectionEnd),
                         Math.max(selectionStart, selectionEnd));
     }
     return spannable;
   } else if (node instanceof HTMLTextAreaElement) {
     var shadow = new cvox.EditableTextAreaShadow();
     shadow.update(node);
     var lineIndex = shadow.getLineIndex(node.selectionEnd);
     var lineStart = shadow.getLineStart(lineIndex);
     var lineEnd = shadow.getLineEnd(lineIndex);
     var lineText = node.value.substring(lineStart, lineEnd);
     valueSpan.offset = lineStart;
     var spannable = new cvox.Spannable(lineText, valueSpan);
     if (node === document.activeElement) {
       var selectionStart = cvox.BrailleUtil.clamp_(
           node.selectionStart - lineStart, 0, spannable.getLength());
       var selectionEnd = cvox.BrailleUtil.clamp_(
           node.selectionEnd - lineStart, 0, spannable.getLength());
-      spannable.setSpan(new cvox.BrailleUtil.ValueSelectionSpan(),
+      spannable.setSpan(new cvox.ValueSelectionSpan(),
                         Math.min(selectionStart, selectionEnd),
                         Math.max(selectionStart, selectionEnd));
     }
     return spannable;
   } else {
     return new cvox.Spannable(cvox.DomUtil.getValue(node), valueSpan);
   }
 };
 
 
@@ skipping 51 matching lines @@
   };
   for (var i = 0; i < template.length; i++) {
     var component = mapChar(template[i]);
     templated.append(component);
     // Ignore the next whitespace separator if the current component is empty,
     // unless the empty value has a selection, in which case the cursor
     // should be placed on the empty space after the empty value.
     if (!component.toString() && template[i + 1] == ' ' &&
         (!(component instanceof cvox.Spannable) ||
         !/**@type {cvox.Spannable}*/(component).getSpanInstanceOf(
-            cvox.BrailleUtil.ValueSelectionSpan))) {
+            cvox.ValueSelectionSpan))) {
       i++;
     }
   }
   return templated.trimRight();
 };
 
 
 /**
  * Creates a braille value from a string and, optionally, a selection range.
- * A cvox.BrailleUtil.ValueSpan will be
- * attached, along with a cvox.BrailleUtil.ValueSelectionSpan if applicable.
+ * A {@code cvox.ValueSpan} will be attached, along with a
+ * {@code cvox.ValueSelectionSpan} if applicable.
  * @param {string} text The text to display as the value.
  * @param {number=} opt_selStart Selection start.
  * @param {number=} opt_selEnd Selection end if different from selection start.
  * @param {number=} opt_textOffset Start offset of text.
  * @return {!cvox.Spannable} The value spannable.
  */
 cvox.BrailleUtil.createValue = function(text, opt_selStart, opt_selEnd,
                                         opt_textOffset) {
   var spannable = new cvox.Spannable(
-      text, new cvox.BrailleUtil.ValueSpan(opt_textOffset || 0));
+      text, new cvox.ValueSpan(opt_textOffset || 0));
   if (goog.isDef(opt_selStart)) {
     opt_selEnd = goog.isDef(opt_selEnd) ? opt_selEnd : opt_selStart;
     // TODO(plundblad): This looses the distinction between the selection
     // anchor (start) and focus (end).  We should use that information to
     // decide where to pan the braille display.
     if (opt_selStart > opt_selEnd) {
       var temp = opt_selStart;
       opt_selStart = opt_selEnd;
       opt_selEnd = temp;
     }
 
-    spannable.setSpan(new cvox.BrailleUtil.ValueSelectionSpan(),
-          opt_selStart, opt_selEnd);
+    spannable.setSpan(new cvox.ValueSelectionSpan(), opt_selStart, opt_selEnd);
   }
   return spannable;
 };
 
 
 /**
  * Activates a position in a nav braille.  Moves the caret in text fields
  * and simulates a mouse click on the node at the position.
  *
  * @param {!cvox.NavBraille} braille the nav braille representing the display
  *        content that was active when the user issued the key command.
  *        The annotations in the spannable are used to decide what
  *        node to activate and what part of the node value (if any) to
  *        move the caret to.
  * @param {number=} opt_displayPosition position of the display that the user
  *                  activated, relative to the start of braille.
  */
 cvox.BrailleUtil.click = function(braille, opt_displayPosition) {
   var handled = false;
   var spans = braille.text.getSpans(opt_displayPosition || 0);
   var node = spans.filter(function(n) { return n instanceof Node; })[0];
   if (node) {
     if (goog.isDef(opt_displayPosition) &&
         (cvox.DomUtil.isInputTypeText(node) ||
             node instanceof HTMLTextAreaElement)) {
       var valueSpan = spans.filter(
           function(s) {
-            return s instanceof cvox.BrailleUtil.ValueSpan;
+            return s instanceof cvox.ValueSpan;
           })[0];
       if (valueSpan) {
         if (document.activeElement !== node) {
           cvox.Focuser.setFocus(node);
         }
         var cursorPosition = opt_displayPosition -
             braille.text.getSpanStart(valueSpan) +
             valueSpan.offset;
         cvox.ChromeVoxEventWatcher.setUpTextHandler();
         node.selectionStart = node.selectionEnd = cursorPosition;
@@ skipping 15 matching lines @@
  * @param {number} number The number to clamp.
  * @param {number} min The minimum value to return.
  * @param {number} max The maximum value to return.
  * @return {number} {@code number} if it is within the bounds, or the nearest
  *     number within the bounds otherwise.
  * @private
  */
 cvox.BrailleUtil.clamp_ = function(number, min, max) {
   return Math.min(Math.max(number, min), max);
 };