Enable brightness controls for all ChromeOS builds. Make brightness controls auto-repeat.

chrome/browser/resources/shared/js/cr/ui/repeating_button.js

+// Copyright (c) 2011 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('cr.ui', function() {
+

[James Hawkins, 2011/10/26 21:49:46]

nit: Remove blank line.

[kevers, 2011/10/27 15:06:34]

Done.

+  /**
+   * Creates a new button element.  The repeating button behaves like a

[James Hawkins, 2011/10/26 21:49:46]

nit: Single space between comments.

[kevers, 2011/10/27 15:06:34]

Updated all comments in this file to use single spacing between sentences.

+   * keyboard button, which auto-repeats if held.  This button is designed
+   * for use with controls such as brightness and volume adjustment buttons.
+   * @constructor
+   * @extends {HTMLButtonElement}
+   */
+  var RepeatingButton = cr.ui.define('button');
+
+  RepeatingButton.prototype = {
+    __proto__: HTMLButtonElement.prototype,
+
+    /**
+     * Delay in milliseconds before the first repeat trigger of the button
+     * held action.
+     * @type {number}
+     */
+    holdDelayTime: 500,

[James Hawkins, 2011/10/26 21:49:46]

These vars are private, right?

[kevers, 2011/10/27 15:06:34]

Initially, I thought that it would be useful to keep these variables public;
however, in retrospect it is probably best to keep private until there is a need
to override the defaults.  Easy enough to add get/set methods later as required.

Fixed.

+
+    /**
+     * Delay in milliseconds between triggers of the button held action.
+     * @type {number}
+     */
+    holdRepeatIntervalTime: 50,
+
+    /**
+     * Callback function when repeated intervals trigger. Initialized when the
+     * button is held for an initial delay period and cleared when the button
+     * is released.
+     * @type {function}
+     */
+    intervalCallback: undefined,
+
+    /**
+     * Callback function to arm the repeat timer.  Initialized when the button
+     * is pressed and cleared when the interval timer is set or the button is
+     * released.
+     * @type {function}
+     */
+    armRepeaterCallback: undefined,
+
+    /**
+     * Initializes the button.
+     */
+    decorate: function() {
+      this.onmousedown = this.buttonDown.bind(this);
+      this.onmouseup = this.buttonUp.bind(this);
+      this.onmouseout = this.buttonUp.bind(this);
+      this.ontouchstart = this.touchStart.bind(this);
+      this.ontouchend = this.buttonUp.bind(this);
+      this.ontouchcancel = this.buttonUp.bind(this);
+    },
+
+    /**
+     * Called when the user initiates a touch gesture.
+     * @param {!Event} e The triggered event.
+     */
+    touchStart: function(e) {
+      // Block system level gestures to prevent double tap to zoom. Also,
+      // block following mouse event to prevent double firing of the button
+      // held action in the case of a tap.  Otherwise, a single tap action in
+      // webkit generates the following event sequence: touchstart, touchend,
+      // mouseover, mousemove, mousedown, mouseup and click.
+      e.preventDefault();
+    },
+
+    /**
+     * Called when the user presses the button.

[James Hawkins, 2011/10/26 21:49:46]

To remove ambiguity when referring to "this" button, s/the button/this button/

[kevers, 2011/10/27 15:06:34]

Updated docs for buttonDown_, buttonUp_ and buttonHeld_.

+     * @param {!Event} e The triggered event.
+     */
+    buttonDown: function(e) {

[James Hawkins, 2011/10/26 21:49:46]

It seems a lot of these methods should be private.

[kevers, 2011/10/27 15:06:34]

Fixed.

+      this.clearTimeout();
+      // Trigger the button held action immediately, after an initial delay and
+      // then repeated based on a fixed time increment.  The time intervals are
+      // in agreement with the defaults for the ChromeOS keyboard and virtual

[James Hawkins, 2011/10/26 21:49:46]

re: in agreement

Should we pull/set these values from some common location in the backend?

[kevers, 2011/10/27 15:06:34]

Added a TODO comment.

+      // keyboard.
+      this.buttonHeld();
+      var self = this;
+      this.armRepeaterCallback = function() {
+        // In the event of a click/tap operation, the button has already been
+        // released by the time this timeout triggers.  Test to ensure that the
+        // button is still being held (i.e. clearTimeout has not been called).
+        if (self.armRepeaterCallback) {
+          self.armRepeaterCallback = undefined;
+          self.intervalCallback = setInterval(self.buttonHeld.bind(self),
+              self.holdRepeatIntervalTime);
+        }
+      };
+      setTimeout(this.armRepeaterCallback, Math.max(0, this.holdDelayTime -
+          this.holdRepeatIntervalTime));
+    },
+
+    /**
+     * Called when the user releases the button.
+     * @param {!Event} e The triggered event.
+     */
+    buttonUp: function(e) {
+      this.clearTimeout();
+    },
+
+    /**
+     * Resets the interval callback.
+     */
+    clearTimeout: function() {
+      if (this.armRepeaterCallback) {
+        clearTimeout(this.armRepeaterCallback);
+        this.armRepeaterCallback = undefined;
+      }
+      if (this.intervalCallback) {
+        clearInterval(this.intervalCallback);
+        this.intervalCallback = undefined;
+      }
+    },
+
+    /**
+     * Dispatches the action associated with keeping the button pressed.
+     */
+    buttonHeld: function() {
+      if (this.onButtonHeldAction)
+        this.onButtonHeldAction();
+    }
+  };
+
+  return {
+    RepeatingButton: RepeatingButton
+  };
+});
+