chrome/browser/resources/settings/chromeos/device_page/keyboard.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.

cr.define('settings', function() {
  /**
   * Modifier key IDs corresponding to the ModifierKey enumerators in
   * /ui/base/ime/chromeos/ime_keyboard.h.
   * @enum {number}
   */
  const ModifierKey = {
    SEARCH_KEY: 0,
    CONTROL_KEY: 1,
    ALT_KEY: 2,
    VOID_KEY: 3,  // Represents a disabled key.
    CAPS_LOCK_KEY: 4,
    ESCAPE_KEY: 5,
    BACKSPACE_KEY: 6,
    ASSISTANT_KEY: 7,
  };


  Polymer({
    is: 'settings-keyboard',

    behaviors: [
      DeepLinkingBehavior,
      settings.RouteObserverBehavior,
    ],

    properties: {
      /** Preferences state. */
      prefs: {
        type: Object,
        notify: true,
      },

      /** @private {!Map<string, (string|Function)>} */
      focusConfig: {
        type: Object,
        observer: 'onFocusConfigChange_',
      },

      /** @private Whether to show Caps Lock options. */
      showCapsLock_: Boolean,

      /**
       * @private
       * Whether this device has a ChromeOS launcher key. Applies only to
       * ChromeOS keyboards, internal or external.
       */
      hasLauncherKey_: Boolean,

      /** @private Whether this device has an Assistant key on keyboard. */
      hasAssistantKey_: Boolean,

      /**
       * Whether to show a remapping option for external keyboard's Meta key
       * (Search/Windows keys). This is true only when there's an external
       * keyboard connected that is a non-Apple keyboard.
       * @private
       */
      showExternalMetaKey_: Boolean,

      /**
       * Whether to show a remapping option for the Command key. This is true
       * when one of the connected keyboards is an Apple keyboard.
       * @private
       */
      showAppleCommandKey_: Boolean,

      /** @private {!DropdownMenuOptionList} Menu items for key mapping. */
      keyMapTargets_: Object,

      /**
       * Auto-repeat delays (in ms) for the corresponding slider values, from
       * long to short. The values were chosen to provide a large range while
       * giving several options near the defaults.
       * @private {!Array<number>}
       */
      autoRepeatDelays_: {
        type: Array,
        value: [2000, 1500, 1000, 500, 300, 200, 150],
        readOnly: true,
      },

      /**
       * Auto-repeat intervals (in ms) for the corresponding slider values, from
       * long to short. The slider itself is labeled "rate", the inverse of
       * interval, and goes from slow (long interval) to fast (short interval).
       * @private {!Array<number>}
       */
      autoRepeatIntervals_: {
        type: Array,
        value: [2000, 1000, 500, 300, 200, 100, 50, 30, 20],
        readOnly: true,
      },

      /**
       * Used by DeepLinkingBehavior to focus this page's deep links.
       * @type {!Set<!chromeos.settings.mojom.Setting>}
       */
      supportedSettingIds: {
        type: Object,
        value: () => new Set([
          chromeos.settings.mojom.Setting.kKeyboardFunctionKeys,
          chromeos.settings.mojom.Setting.kKeyboardAutoRepeat,
          chromeos.settings.mojom.Setting.kKeyboardShortcuts,
        ]),
      },
    },

    /** @override */
    ready() {
      cr.addWebUIListener(
          'show-keys-changed', this.onShowKeysChange_.bind(this));
      settings.DevicePageBrowserProxyImpl.getInstance().initializeKeyboard();
      this.setUpKeyMapTargets_();
    },

    /**
     * @param {!settings.Route} route
     * @param {settings.Route} oldRoute
     */
    currentRouteChanged(route, oldRoute) {
      // Does not apply to this page.
      if (route !== settings.routes.KEYBOARD) {
        return;
      }

      this.attemptDeepLink();
    },

    /**
     * Initializes the dropdown menu options for remapping keys.
     * @private
     */
    setUpKeyMapTargets_() {
      // Ordering is according to UX, but values match settings.ModifierKey.
      this.keyMapTargets_ = [
        {
          value: settings.ModifierKey.SEARCH_KEY,
          name: loadTimeData.getString('keyboardKeySearch'),
        },
        {
          value: settings.ModifierKey.CONTROL_KEY,
          name: loadTimeData.getString('keyboardKeyCtrl')
        },
        {
          value: settings.ModifierKey.ALT_KEY,
          name: loadTimeData.getString('keyboardKeyAlt')
        },
        {
          value: settings.ModifierKey.CAPS_LOCK_KEY,
          name: loadTimeData.getString('keyboardKeyCapsLock')
        },
        {
          value: settings.ModifierKey.ESCAPE_KEY,
          name: loadTimeData.getString('keyboardKeyEscape')
        },
        {
          value: settings.ModifierKey.BACKSPACE_KEY,
          name: loadTimeData.getString('keyboardKeyBackspace')
        },
        {
          value: settings.ModifierKey.ASSISTANT_KEY,
          name: loadTimeData.getString('keyboardKeyAssistant')
        },
        {
          value: settings.ModifierKey.VOID_KEY,
          name: loadTimeData.getString('keyboardKeyDisabled')
        }
      ];
    },

    /** @private */
    onFocusConfigChange_() {
      this.focusConfig.set(settings.routes.OS_LANGUAGES_INPUT.path, () => {
        Polymer.RenderStatus.afterNextRender(this, () => {
          cr.ui.focusWithoutInk(assert(this.$$('#showLanguagesInput')));
        });
      });
    },

    /**
     * Handler for updating which keys to show.
     * @param {Object} keyboardParams
     * @private
     */
    onShowKeysChange_(keyboardParams) {
      this.hasLauncherKey_ = keyboardParams['hasLauncherKey'];
      this.hasAssistantKey_ = keyboardParams['hasAssistantKey'];
      this.showCapsLock_ = keyboardParams['showCapsLock'];
      this.showExternalMetaKey_ = keyboardParams['showExternalMetaKey'];
      this.showAppleCommandKey_ = keyboardParams['showAppleCommandKey'];
    },

    /** @private */
    onShowKeyboardShortcutViewerTap_() {
      settings.DevicePageBrowserProxyImpl.getInstance()
          .showKeyboardShortcutViewer();
    },

    /** @private */
    onShowInputSettingsTap_() {
      settings.Router.getInstance().navigateTo(
          settings.routes.OS_LANGUAGES_INPUT,
          /*dynamicParams=*/ null, /*removeSearch=*/ true);
    },

    /** @private */
    getExternalMetaKeyLabel_(hasLauncherKey) {
      return loadTimeData.getString(
          hasLauncherKey ? 'keyboardKeyExternalMeta' : 'keyboardKeyMeta');
    },

    /** @private */
    getExternalCommandKeyLabel_(hasLauncherKey) {
      return loadTimeData.getString(
          hasLauncherKey ? 'keyboardKeyExternalCommand' : 'keyboardKeyCommand');
    },
  });

  // #cr_define_end
  return {ModifierKey};
});