Print Preview: Refactoring layout mode related logic to LayoutSettings class.

chrome/browser/resources/print_preview/print_preview.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.
 
 // require: cr/ui/print_preview_cloud.js
 
 var localStrings = new LocalStrings();
 
 // If useCloudPrint is true we attempt to connect to cloud print
 // and populate the list of printers with cloud print printers.
@@ skipping 30 matching lines @@
 
 // True when preview tab is hidden.
 var isTabHidden = false;
 
 // Object holding all the pages related settings.
 var pageSettings;
 
 // Object holding all the copies related settings.
 var copiesSettings;
 
+// Object holding all the layout related settings.
+var layoutSettings;
+
 // True if the user has click 'Advanced...' in order to open the system print
 // dialog.
 var showingSystemDialog = false;
 
 // The range of options in the printer dropdown controlled by cloud print.
 var firstCloudPrintOptionPos = 0
 var lastCloudPrintOptionPos = firstCloudPrintOptionPos;
 
 /**
  * Window onload handler, sets up the page and starts print preview by getting
@@ skipping 15 matching lines @@
 
   $('print-button').focus();
   $('system-dialog-link').addEventListener('click', onSystemDialogLinkClicked);
   $('mainview').parentElement.removeChild($('dummy-viewer'));
 
   $('printer-list').disabled = true;
   $('print-button').onclick = printFile;
 
   pageSettings = print_preview.PageSettings.getInstance();
   copiesSettings = print_preview.CopiesSettings.getInstance();
+  layoutSettings = print_preview.LayoutSettings.getInstance();
   pageSettings.addEventListeners();
   copiesSettings.addEventListeners();
+  layoutSettings.addEventListeners();
 
   showLoadingAnimation();
   chrome.send('getDefaultPrinter');
 }
 
 /**
  * Adds event listeners to the settings controls.
  */
 function addEventListeners() {
   // Controls that require preview rendering.
-  $('landscape').onclick = onLayoutModeToggle;
-  $('portrait').onclick = onLayoutModeToggle;
   $('printer-list').onchange = updateControlsWithSelectedPrinterCapabilities;
 
   // Controls that do not require preview rendering.
   $('color').onclick = function() { setColor(true); };
   $('bw').onclick = function() { setColor(false); };
 }
 
 /**
  * Removes event listeners from the settings controls.
  */
 function removeEventListeners() {
   if (pageSettings)
     clearTimeout(pageSettings.timerId_);
 
   // Controls that require preview rendering
-  $('landscape').onclick = null;
-  $('portrait').onclick = null;
   $('printer-list').onchange = null;
 
   // Controls that don't require preview rendering.
   $('color').onclick = null;
   $('bw').onclick = null;
 }
 
 /**
  * Disables the input elements in the sidebar.
  */
@@ skipping 111 matching lines @@
   lastSelectedPrinterIndex = selectedIndex;
 
   // Regenerate the preview data based on selected printer settings.
   setDefaultValuesAndRegeneratePreview();
 }
 
 /**
  * Updates the controls with printer capabilities information.
  * @param {Object} settingInfo printer setting information.
  */
 function updateWithPrinterCapabilities(settingInfo) {

[Evan Stade, 2011/07/14 18:51:45]

could we have a printerCapabilitiesUpdated event similar to PDFLoaded

[dpapad, 2011/07/14 22:17:45]

Done. The remaining statements here will be moved to a listener of that event
once the color options are refactored to a ColorSettings class. Eventually this
function will only fire the event.

   var disableColorOption = settingInfo.disableColorOption;
   var disableCopiesOption = settingInfo.disableCopiesOption;
   var setColorAsDefault = settingInfo.setColorAsDefault;
-  var disableLandscapeOption = settingInfo.disableLandscapeOption;
   var setDuplexAsDefault = settingInfo.setDuplexAsDefault;
   var color = $('color');
   var bw = $('bw');
   var colorOptions = $('color-options');
 
   if (disableCopiesOption) {
     fadeOutElement($('copies-option'));
     $('hr-before-copies').classList.remove('invisible');
   } else {
     fadeInElement($('copies-option'));
     $('hr-before-copies').classList.add('invisible');
   }
 
-  if (disableLandscapeOption) {
-    fadeOutElement($('landscape-option'));
-  } else {
-    fadeInElement($('landscape-option'));
-  }
-
+  layoutSettings.fadeInOut(settingInfo.disableLandscapeOption);
   disableColorOption ? fadeOutElement(colorOptions) :
       fadeInElement(colorOptions);
   colorOptions.setAttribute('aria-hidden', disableColorOption);
 
   if (color.checked != setColorAsDefault) {
     color.checked = setColorAsDefault;
     bw.checked = !setColorAsDefault;
   }
   copiesSettings.twoSidedCheckbox.checked = setDuplexAsDefault;
 }
@@ skipping 18 matching lines @@
 }
 
 /**
  * Cloud print upload of the PDF file is finished, time to close the dialog.
  */
 function finishedCloudPrinting() {
   window.location = cloudprint.getBaseURL();
 }
 
 /**
- * Checks whether the preview layout setting is set to 'landscape' or not.
- *
- * @return {boolean} true if layout is 'landscape'.
- */
-function isLandscape() {
-  return $('landscape').checked;
-}
-
-/**
  * Checks whether the preview color setting is set to 'color' or not.
  *
  * @return {boolean} true if color is 'color'.
  */
 function isColor() {
   return $('color').checked;
 }
 
 /**
  * Checks whether the preview collate setting value is set or not.
  *
  * @return {boolean} true if collate setting is enabled and checked.
  */
 function isCollated() {
   return !copiesSettings.collateOption.hidden && $('collate').checked;
 }
 
 /**
- * Gets the duplex mode for printing.
- * @return {number} duplex mode.
- */
-function getDuplexMode() {
-  // Constants values matches printing::DuplexMode enum.
-  const SIMPLEX = 0;
-  const LONG_EDGE = 1;
-  return !copiesSettings.twoSidedCheckbox.checked ? SIMPLEX : LONG_EDGE;
-}
-
-/**
  * Creates an object based on the values in the printer settings.
  *
  * @return {Object} Object containing print job settings.
  */
 function getSettings() {
   var deviceName = getSelectedPrinterName();
   var printToPDF = (deviceName == PRINT_TO_PDF);
 
   var settings =
       {'deviceName': deviceName,
        'pageRange': pageSettings.selectedPageRanges,
        'printAll': pageSettings.allPagesRadioButton.checked,
-       'duplex': getDuplexMode(),
+       'duplex': copiesSettings.duplexMode,
        'copies': copiesSettings.numberOfCopies,
        'collate': isCollated(),
-       'landscape': isLandscape(),
+       'landscape': layoutSettings.isLandscape(),
        'color': isColor(),
        'printToPDF': printToPDF,
        'requestID': 0};
 
   var printerList = $('printer-list');
   var selectedPrinter = printerList.selectedIndex;
   if (cloudprint.isCloudPrint(printerList.options[selectedPrinter])) {
     settings['cloudPrintID'] =
         printerList.options[selectedPrinter].value;
   }
@@ skipping 401 matching lines @@
 }
 
 /**
  * Called when the PDF plugin loads its document.
  */
 function onPDFLoad() {
   $('pdf-viewer').fitToHeight();
   setColor($('color').checked);
   hideLoadingAnimation();
 
-  if (!previewModifiable)
-    fadeOutElement($('landscape-option'));
   cr.dispatchSimpleEvent(document, 'PDFLoaded');
 }
 
 /**
  * Update the page count and check the page range.
  * Called from PrintPreviewUI::OnDidGetPreviewPageCount().
  * @param {number} pageCount The number of pages.
  */
 function onDidGetPreviewPageCount(pageCount) {
   pageSettings.updateState(pageCount);
@@ skipping 172 matching lines @@
     html = localStrings.getStringF('printPreviewSummaryFormatShort',
                                    '<b>' + numOfSheets + '</b>',
                                    '<b>' + summaryLabel + '</b>');
 
   // Removing extra spaces from within the string.
   html = html.replace(/\s{2,}/g, ' ');
   printSummary.innerHTML = html;
 }
 
 /**
- * When the user switches printing orientation mode the page field selection is
- * reset to "all pages selected". After the change the number of pages will be
- * different and currently selected page numbers might no longer be valid.
- * Even if they are still valid the content of these pages will be different.
- */
-function onLayoutModeToggle() {
-  // If the chosen layout is same as before, nothing needs to be done.
-  if (printSettings.isLandscape == isLandscape())
-    return;
-  setDefaultValuesAndRegeneratePreview();
-}
-
-/**
  * Sets the default values and sends a request to regenerate preview data.
  */
 function setDefaultValuesAndRegeneratePreview() {
   pageSettings.resetState();
   requestPrintPreview();
 }
 
 /**
  * Class that represents the state of the print settings.
  */
 function PrintSettings() {
   this.deviceName = '';
   this.isLandscape = '';
 }
 
 /**
  * Takes a snapshot of the print settings.
  */
 PrintSettings.prototype.save = function() {
   this.deviceName = getSelectedPrinterName();
-  this.isLandscape = isLandscape();
+  this.isLandscape = layoutSettings.isLandscape();
 }