Print Preview: Simplify other_options_settings javascript code.

chrome/browser/resources/print_preview/settings/other_options_settings.js

 // Copyright (c) 2012 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('print_preview', function() {
   'use strict';
 
   /**
+   * Represents a single option in the Other Options settings section.
+   * @param {!print_preview.ticket_items.TicketItem} ticketItem The ticket item
+   *     for this element, used to read and write.
+   * @param {boolean} collapsible Whether this option is collapsible or not.
+   * @param {string} cssId The CSS id for the container element for this option,
+   *     used to access the container and checkbox HTML elements.
+   * @constructor
+   */
+  function CheckboxTicketItemElement(ticketItem, collapsible, cssId) {
+    /**
+     * Ticket item for this element, used to read/write.
+     * @private {!print_preview.ticket_items.TicketItem}
+     */
+    this.ticketItem_ = ticketItem;
+
+    /**
+     * Whether this element is collapsible.
+     * @private {boolean}
+     */
+    this.collapsible_ = collapsible;
+
+    /**
+     * The CSS id string for the container element.
+     * @private {string}
+     */
+    this.cssId_ = cssId;
+
+    /**
+     * The HTML container element. Populated when decorate() is called.
+     * @private {HTMLElement}
+     */
+    this.container_ = null;
+
+    /**
+     * The HTML checkbox input element. The checkbox child element of
+     * container_. Populated when decorate() is called.
+     * @private {HTMLElement}
+     */
+    this.checkbox_ = null;
+  };
+
+  CheckboxTicketItemElement.prototype = {
+
+    /** @return {boolean} Whether the element is collapsible */
+    get collapsible() {
+      return this.collapsible_;
+    },
+
+    /**
+     * @return {!print_preview.ticket_items.TicketItem} The ticket item for this
+     *      element.
+     */
+    get ticketItem() {
+      return this.ticketItem_;
+    },
+
+    /** @return {HTMLElement} The checkbox HTML element. */
+    get checkbox() {
+      return this.checkbox_;
+    },
+
+    /** Initializes container and checkbox */
+    decorate: function() {
+        this.container_ = document.getElementById(this.cssId_);

[dpapad, 2016/12/16 00:53:48]

-2 indent

[rbpotter, 2016/12/16 01:19:49]

Done.

+        this.checkbox_ = this.container_.querySelector('.checkbox');
+    },
+
+    /** Resets container and checkbox. */
+    exitDocument: function() {
+      this.container_ = null;
+      this.checkbox_ = null;
+    },
+
+    /** Called when the checkbox is clicked. Updates the ticket item value. */
+    onCheckboxClick: function() {
+      this.ticketItem_.updateValue(this.checkbox_.checked);
+    },
+
+    /**
+     * Called when the ticket item changes. Updates the UI state.
+     * @param {!print_preview.SettingsSection.OtherOptionsSettings}
+     *     otherOptionsSettings The settings section that this element is part
+     *     of.
+     */
+    onTicketItemChange: function(otherOptionsSettings) {
+      this.checkbox_.checked = this.ticketItem_.getValue();
+      otherOptionsSettings.updateUiStateInternal();
+    },
+
+    /**
+     * @param {boolean} collapseContent Whether the settings section has content
+     *     collapsed.
+     * @return {boolean} Whether this element should be visible.
+     */
+    isVisible: function(collapseContent) {
+      return this.ticketItem_.isCapabilityAvailable() &&
+             (!this.collapsible_ || !collapseContent);
+    },
+
+    /**
+     * Sets the visibility of the element.
+     * @param {boolean} collapseContent Whether the settings section has content
+     *     collapsed.
+     */
+    setVisibility: function(collapseContent) {
+      setIsVisible(this.container_, this.isVisible(collapseContent));
+    },
+
+  };
+
+  /**
    * UI component that renders checkboxes for various print options.
    * @param {!print_preview.ticket_items.Duplex} duplex Duplex ticket item.
    * @param {!print_preview.ticket_items.FitToPage} fitToPage Fit-to-page ticket
    *     item.
    * @param {!print_preview.ticket_items.CssBackground} cssBackground CSS
    *     background ticket item.
    * @param {!print_preview.ticket_items.SelectionOnly} selectionOnly Selection
    *     only ticket item.
    * @param {!print_preview.ticket_items.HeaderFooter} headerFooter Header
    *     footer ticket item.
    * @constructor
    * @extends {print_preview.SettingsSection}
    */
   function OtherOptionsSettings(
       duplex, fitToPage, cssBackground, selectionOnly, headerFooter) {
     print_preview.SettingsSection.call(this);
 
-    /**
-     * Duplex ticket item, used to read/write the duplex selection.
-     * @type {!print_preview.ticket_items.Duplex}
-     * @private
+    /*
+     * @private {!Array<!CheckboxTicketItemElement>} checkbox ticket item
+     *      elements representing the different options in the section.
+     *      Selection only must always be the last element in the array.
      */
-    this.duplexTicketItem_ = duplex;
+    this.elements_ = [
+        new CheckboxTicketItemElement(headerFooter, true,
+                                      'header-footer-container'),
+        new CheckboxTicketItemElement(fitToPage, false,
+                                      'fit-to-page-container'),
+        new CheckboxTicketItemElement(duplex, false, 'duplex-container'),
+        new CheckboxTicketItemElement(cssBackground, true,
+                                      'css-background-container'),
+        new CheckboxTicketItemElement(selectionOnly, true,
+                                      'selection-only-container')
+    ];
 
-    /**
-     * Fit-to-page ticket item, used to read/write the fit-to-page selection.
-     * @type {!print_preview.ticket_items.FitToPage}
-     * @private
-     */
-    this.fitToPageTicketItem_ = fitToPage;
-
-    /**
-     * Enable CSS backgrounds ticket item, used to read/write.
-     * @type {!print_preview.ticket_items.CssBackground}
-     * @private
-     */
-    this.cssBackgroundTicketItem_ = cssBackground;
-
-    /**
-     * Print selection only ticket item, used to read/write.
-     * @type {!print_preview.ticket_items.SelectionOnly}
-     * @private
-     */
-    this.selectionOnlyTicketItem_ = selectionOnly;
-
-    /**
-     * Header-footer ticket item, used to read/write.
-     * @type {!print_preview.ticket_items.HeaderFooter}
-     * @private
-     */
-    this.headerFooterTicketItem_ = headerFooter;
-
-     /**
-     * Header footer container element.
-     * @type {HTMLElement}
-     * @private
-     */
-    this.headerFooterContainer_ = null;
-
-    /**
-     * Header footer checkbox.
-     * @type {HTMLInputElement}
-     * @private
-     */
-    this.headerFooterCheckbox_ = null;
-
-    /**
-     * Fit-to-page container element.
-     * @type {HTMLElement}
-     * @private
-     */
-    this.fitToPageContainer_ = null;
-
-    /**
-     * Fit-to-page checkbox.
-     * @type {HTMLInputElement}
-     * @private
-     */
-    this.fitToPageCheckbox_ = null;
-
-    /**
-     * Duplex container element.
-     * @type {HTMLElement}
-     * @private
-     */
-    this.duplexContainer_ = null;
-
-    /**
-     * Duplex checkbox.
-     * @type {HTMLInputElement}
-     * @private
-     */
-    this.duplexCheckbox_ = null;
-
-    /**
-     * Print CSS backgrounds container element.
-     * @type {HTMLElement}
-     * @private
-     */
-    this.cssBackgroundContainer_ = null;
-
-    /**
-     * Print CSS backgrounds checkbox.
-     * @type {HTMLInputElement}
-     * @private
-     */
-    this.cssBackgroundCheckbox_ = null;
-
-    /**
-     * Print selection only container element.
-     * @type {HTMLElement}
-     * @private
-     */
-    this.selectionOnlyContainer_ = null;
-
-    /**
-     * Print selection only checkbox.
-     * @type {HTMLInputElement}
-     * @private
-     */
-    this.selectionOnlyCheckbox_ = null;
   };
 
   OtherOptionsSettings.prototype = {
     __proto__: print_preview.SettingsSection.prototype,
 
     /** @override */
     isAvailable: function() {
-      return this.headerFooterTicketItem_.isCapabilityAvailable() ||
-             this.fitToPageTicketItem_.isCapabilityAvailable() ||
-             this.duplexTicketItem_.isCapabilityAvailable() ||
-             this.cssBackgroundTicketItem_.isCapabilityAvailable() ||
-             this.selectionOnlyTicketItem_.isCapabilityAvailable();
+      return this.elements_.some(function(element) {
+        return element.ticketItem.isCapabilityAvailable();
+      });
     },
 
     /** @override */
     hasCollapsibleContent: function() {
-      return this.headerFooterTicketItem_.isCapabilityAvailable() ||
-             this.cssBackgroundTicketItem_.isCapabilityAvailable() ||
-             this.selectionOnlyTicketItem_.isCapabilityAvailable();
+      return this.elements_.some(function(element) {
+        return element.collapsible;
+      });
     },
 
     /** @override */
     set isEnabled(isEnabled) {
-      this.headerFooterCheckbox_.disabled = !isEnabled;
-      this.fitToPageCheckbox_.disabled = !isEnabled;
-      this.duplexCheckbox_.disabled = !isEnabled;
-      this.cssBackgroundCheckbox_.disabled = !isEnabled;
+      /* Skip |ticket_items.SelectionOnly|, which must always be the last
+       * element, as this checkbox is enabled based on whether the user has
+       * selected something in the page, which is different logic from the
+       * other elements. */
+      for (var i = 0; i < this.elements_.length - 1; i++)
+        this.elements_[i].checkbox.disabled = !isEnabled;
     },
 
     /** @override */
     enterDocument: function() {
       print_preview.SettingsSection.prototype.enterDocument.call(this);
-      this.tracker.add(
-          this.headerFooterCheckbox_,
-          'click',
-          this.onHeaderFooterCheckboxClick_.bind(this));
-      this.tracker.add(
-          this.fitToPageCheckbox_,
-          'click',
-          this.onFitToPageCheckboxClick_.bind(this));
-      this.tracker.add(
-          this.duplexCheckbox_,
-          'click',
-          this.onDuplexCheckboxClick_.bind(this));
-      this.tracker.add(
-          this.cssBackgroundCheckbox_,
-          'click',
-          this.onCssBackgroundCheckboxClick_.bind(this));
-      this.tracker.add(
-          this.selectionOnlyCheckbox_,
-          'click',
-          this.onSelectionOnlyCheckboxClick_.bind(this));
-      this.tracker.add(
-          this.duplexTicketItem_,
-          print_preview.ticket_items.TicketItem.EventType.CHANGE,
-          this.onDuplexChange_.bind(this));
-      this.tracker.add(
-          this.fitToPageTicketItem_,
-          print_preview.ticket_items.TicketItem.EventType.CHANGE,
-          this.onFitToPageChange_.bind(this));
-      this.tracker.add(
-          this.cssBackgroundTicketItem_,
-          print_preview.ticket_items.TicketItem.EventType.CHANGE,
-          this.onCssBackgroundChange_.bind(this));
-      this.tracker.add(
-          this.selectionOnlyTicketItem_,
-          print_preview.ticket_items.TicketItem.EventType.CHANGE,
-          this.onSelectionOnlyChange_.bind(this));
-      this.tracker.add(
-          this.headerFooterTicketItem_,
-          print_preview.ticket_items.TicketItem.EventType.CHANGE,
-          this.onHeaderFooterChange_.bind(this));
+      this.elements_.forEach(function(element) {
+        this.tracker.add(
+            element.checkbox,
+            'click',
+            element.onCheckboxClick.bind(element));
+        this.tracker.add(
+            element.ticketItem,
+            print_preview.ticket_items.TicketItem.EventType.CHANGE,
+            element.onTicketItemChange.bind(element, this));
+      }, this);
     },
 
     /** @override */
     exitDocument: function() {
       print_preview.SettingsSection.prototype.exitDocument.call(this);
-      this.headerFooterContainer_ = null;
-      this.headerFooterCheckbox_ = null;
-      this.fitToPageContainer_ = null;
-      this.fitToPageCheckbox_ = null;
-      this.duplexContainer_ = null;
-      this.duplexCheckbox_ = null;
-      this.cssBackgroundContainer_ = null;
-      this.cssBackgroundCheckbox_ = null;
-      this.selectionOnlyContainer_ = null;
-      this.selectionOnlyCheckbox_ = null;
+      for (var i = 0; i < this.elements_.length; i++)
+        this.elements_[i].exitDocument();
     },
 
     /** @override */
     decorateInternal: function() {
-      this.headerFooterContainer_ = this.getElement().querySelector(
-          '.header-footer-container');
-      this.headerFooterCheckbox_ = this.headerFooterContainer_.querySelector(
-          '.header-footer-checkbox');
-      this.fitToPageContainer_ = this.getElement().querySelector(
-          '.fit-to-page-container');
-      this.fitToPageCheckbox_ = this.fitToPageContainer_.querySelector(
-          '.fit-to-page-checkbox');
-      this.duplexContainer_ = this.getElement().querySelector(
-          '.duplex-container');
-      this.duplexCheckbox_ = this.duplexContainer_.querySelector(
-          '.duplex-checkbox');
-      this.cssBackgroundContainer_ = this.getElement().querySelector(
-          '.css-background-container');
-      this.cssBackgroundCheckbox_ = this.cssBackgroundContainer_.querySelector(
-          '.css-background-checkbox');
-      this.selectionOnlyContainer_ = this.getElement().querySelector(
-          '.selection-only-container');
-      this.selectionOnlyCheckbox_ = this.selectionOnlyContainer_.querySelector(
-          '.selection-only-checkbox');
+      for (var i = 0; i < this.elements_.length; i++)
+        this.elements_[i].decorate();
     },
 
     /** @override */
     updateUiStateInternal: function() {
       if (this.isAvailable()) {
-        setIsVisible(this.headerFooterContainer_,
-                     this.headerFooterTicketItem_.isCapabilityAvailable() &&
-                     !this.collapseContent);
-        setIsVisible(this.fitToPageContainer_,
-                     this.fitToPageTicketItem_.isCapabilityAvailable());
-        setIsVisible(this.duplexContainer_,
-                     this.duplexTicketItem_.isCapabilityAvailable());
-        setIsVisible(this.cssBackgroundContainer_,
-                     this.cssBackgroundTicketItem_.isCapabilityAvailable() &&
-                     !this.collapseContent);
-        setIsVisible(this.selectionOnlyContainer_,
-                     this.selectionOnlyTicketItem_.isCapabilityAvailable() &&
-                     !this.collapseContent);
+        for (var i = 0; i < this.elements_.length; i++)
+          this.elements_[i].setVisibility(this.collapseContent);
       }
       print_preview.SettingsSection.prototype.updateUiStateInternal.call(this);
     },
 
     /** @override */
     isSectionVisibleInternal: function() {
-      if (this.collapseContent) {
-        return this.fitToPageTicketItem_.isCapabilityAvailable() ||
-               this.duplexTicketItem_.isCapabilityAvailable();
-      }
-
-      return this.isAvailable();
+      return this.elements_.some(function(element) {
+        return element.isVisible(this.collapseContent);
+      }, this);
     },
 
-     /**
-     * Called when the header-footer checkbox is clicked. Updates the print
-     * ticket.
-     * @private
-     */
-    onHeaderFooterCheckboxClick_: function() {
-      this.headerFooterTicketItem_.updateValue(
-          this.headerFooterCheckbox_.checked);
-    },
-
-    /**
-     * Called when the fit-to-page checkbox is clicked. Updates the print
-     * ticket.
-     * @private
-     */
-    onFitToPageCheckboxClick_: function() {
-      this.fitToPageTicketItem_.updateValue(this.fitToPageCheckbox_.checked);
-    },
-
-    /**
-     * Called when the duplex checkbox is clicked. Updates the print ticket.
-     * @private
-     */
-    onDuplexCheckboxClick_: function() {
-      this.duplexTicketItem_.updateValue(this.duplexCheckbox_.checked);
-    },
-
-    /**
-     * Called when the print CSS backgrounds checkbox is clicked. Updates the
-     * print ticket store.
-     * @private
-     */
-    onCssBackgroundCheckboxClick_: function() {
-      this.cssBackgroundTicketItem_.updateValue(
-          this.cssBackgroundCheckbox_.checked);
-    },
-
-    /**
-     * Called when the print selection only is clicked. Updates the
-     * print ticket store.
-     * @private
-     */
-    onSelectionOnlyCheckboxClick_: function() {
-      this.selectionOnlyTicketItem_.updateValue(
-          this.selectionOnlyCheckbox_.checked);
-    },
-
-    /**
-     * Called when the duplex ticket item has changed. Updates the duplex
-     * checkbox.
-     * @private
-     */
-    onDuplexChange_: function() {
-      this.duplexCheckbox_.checked = this.duplexTicketItem_.getValue();
-      this.updateUiStateInternal();
-    },
-
-    /**
-     * Called when the fit-to-page ticket item has changed. Updates the
-     * fit-to-page checkbox.
-     * @private
-     */
-    onFitToPageChange_: function() {
-      this.fitToPageCheckbox_.checked = this.fitToPageTicketItem_.getValue();
-      this.updateUiStateInternal();
-    },
-
-    /**
-     * Called when the CSS background ticket item has changed. Updates the
-     * CSS background checkbox.
-     * @private
-     */
-    onCssBackgroundChange_: function() {
-      this.cssBackgroundCheckbox_.checked =
-          this.cssBackgroundTicketItem_.getValue();
-      this.updateUiStateInternal();
-    },
-
-    /**
-     * Called when the print selection only ticket item has changed. Updates the
-     * CSS background checkbox.
-     * @private
-     */
-    onSelectionOnlyChange_: function() {
-      this.selectionOnlyCheckbox_.checked =
-          this.selectionOnlyTicketItem_.getValue();
-      this.updateUiStateInternal();
-    },
-
-    /**
-     * Called when the header-footer ticket item has changed. Updates the
-     * header-footer checkbox.
-     * @private
-     */
-    onHeaderFooterChange_: function() {
-      this.headerFooterCheckbox_.checked =
-          this.headerFooterTicketItem_.getValue();
-      this.updateUiStateInternal();
-    },
   };
 
   // Export
   return {
     OtherOptionsSettings: OtherOptionsSettings
   };
 });