Print Preview: Adding UI for margin settings.

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 35 matching lines @@
 
 // True when a pending print file request exists.
 var hasPendingPrintDocumentRequest = false;
 
 // True when the complete metafile for the previewed doc is ready.
 var isPrintReadyMetafileReady = false;
 
 // True when preview tab is hidden.
 var isTabHidden = false;
 
-// Object holding all the pages related settings.
+// @type {print_preview.PageSettings} Holds all the pages related settings.
 var pageSettings;
 
-// Object holding all the copies related settings.
+// @type {print_preview.CopiesSettings} Holds all the copies related settings.
 var copiesSettings;
 
-// Object holding all the layout related settings.
+// @type {print_preview.LayoutSettings} Holds all the layout related settings.
 var layoutSettings;
 
-// Object holding all the margin related settings.
+// @type {print_preview.MarginSettings} Holds all the margin related settings.
 var marginSettings;
 
-// Object holding all the header footer related settings.
+// @type {print_preview.HeaderFooterSettings} Holds all the header footer
+//     related settings.
 var headerFooterSettings;
 
-// Object holding all the color related settings.
+// @type {print_preview.ColorSettings} Holds all the color related settings.
 var colorSettings;
 
+// @type {print_preview.PreviewArea} Holds information related to the preview
+//     area (on the right).
+var previewArea;
+
 // 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;
 
 // Store the current previewUid.
 var currentPreviewUid = '';
@@ skipping 34 matching lines @@
 
   $('printer-list').disabled = true;
 
   printHeader = print_preview.PrintHeader.getInstance();
   pageSettings = print_preview.PageSettings.getInstance();
   copiesSettings = print_preview.CopiesSettings.getInstance();
   layoutSettings = print_preview.LayoutSettings.getInstance();
   marginSettings = print_preview.MarginSettings.getInstance();
   headerFooterSettings = print_preview.HeaderFooterSettings.getInstance();
   colorSettings = print_preview.ColorSettings.getInstance();
+  previewArea = print_preview.PreviewArea.getInstance();
   printHeader.addEventListeners();
   pageSettings.addEventListeners();
   copiesSettings.addEventListeners();
   headerFooterSettings.addEventListeners();
   layoutSettings.addEventListeners();
   marginSettings.addEventListeners();
   colorSettings.addEventListeners();
+  previewArea.addEventListeners();
   $('printer-list').onchange = updateControlsWithSelectedPrinterCapabilities;
 
   showLoadingAnimation();
   chrome.send('getInitiatorTabTitle');
   chrome.send('getDefaultPrinter');
 }
 
 /**
  * Disables the input elements in the sidebar.
  */
@@ skipping 161 matching lines @@
 }
 
 /**
  * Checks whether the specified settings are valid.
  *
  * @return {boolean} true if settings are valid, false if not.
  */
 function areSettingsValid() {
   var selectedPrinter = getSelectedPrinterName();
   return pageSettings.isPageSelectionValid() &&
-      (copiesSettings.isValid() ||
-       selectedPrinter == PRINT_TO_PDF ||
+      marginSettings.areMarginSettingsValid() &&
+      (copiesSettings.isValid() || selectedPrinter == PRINT_TO_PDF ||
        selectedPrinter == PRINT_WITH_CLOUD_PRINT);
 }
 
 /**
  * Creates an object based on the values in the printer settings.
  *
  * @return {Object} Object containing print job settings.
  */
 function getSettings() {
   var deviceName = getSelectedPrinterName();
@@ skipping 161 matching lines @@
     loadSelectedPages();
     generateDraftData = false;
   } else {
     hasPendingPreviewRequest = true;
     generateDraftData = true;
     pageSettings.updatePageSelection();
   }
 
   printSettings.save();
   layoutSettings.updateState();
+  previewArea.resetState();
   isPrintReadyMetafileReady = false;
   isFirstPageLoaded = false;
 
   var totalPageCount = pageSettings.totalPageCount;
   if (!previewModifiable && totalPageCount > 0)
     generateDraftData = false;
 
   var pageCount = totalPageCount != undefined ? totalPageCount : -1;
   chrome.send('getPreview', [JSON.stringify(getSettingsWithRequestID()),
                              pageCount,
@@ skipping 157 matching lines @@
   var option = createDestinationListOption(optionText,
                                            optionValue,
                                            isDefault,
                                            isDisabled,
                                            isSeparator);
   var printerList = $('printer-list');
   var before = printerList[position];
   printerList.add(option, before);
   return option;
 }
+
 /**
  * Sets the color mode for the PDF plugin.
  * Called from PrintPreviewHandler::ProcessColorSetting().
  * @param {boolean} color is true if the PDF plugin should display in color.
  */
 function setColor(color) {
   var pdfViewer = $('pdf-viewer');
   if (!pdfViewer) {
     return;
   }
@@ skipping 61 matching lines @@
   displayErrorMessage(localStrings.getString('invalidPrinterSettings'));
 }
 
 /**
  * Called when the PDF plugin loads its document.
  */
 function onPDFLoad() {
   if (previewModifiable) {
     setPluginPreviewPageCount();
   }
-  $('pdf-viewer').fitToHeight();
   cr.dispatchSimpleEvent(document, 'PDFLoaded');
   isFirstPageLoaded = true;
   checkAndHideOverlayLayerIfValid();
   sendPrintDocumentRequestIfNeeded();
 }
 
 function setPluginPreviewPageCount() {
   $('pdf-viewer').printPreviewPageCount(
       pageSettings.previouslySelectedPages.length);
 }
@@ skipping 11 matching lines @@
   if (!isExpectedPreviewResponse(previewResponseId))
     return;
   pageSettings.updateState(pageCount);
   previewModifiable = isModifiable;
   if (!previewModifiable && pageSettings.requestPrintPreviewIfNeeded())
     return;
 
   cr.dispatchSimpleEvent(document, 'updateSummary');
 }
 
+/**
+ * @param {printing::PageSizeMargins} pageLayout The default layout of the page
+ *     in points.
+ */
 function onDidGetDefaultPageLayout(pageLayout) {
-  // TODO(aayushkumar): Do something here!
+  marginSettings.currentDefaultPageLayout = new print_preview.PageLayout(
+      pageLayout.contentWidth,
+      pageLayout.contentHeight,
+      pageLayout.marginLeft,
+      pageLayout.marginTop,
+      pageLayout.marginRight,
+      pageLayout.marginBottom);
 }
 
 /**
  * This function sends a request to hide the overlay layer only if there is no
  * pending print document request and we are not waiting for the print ready
  * metafile.
  */
 function checkAndHideOverlayLayerIfValid() {
   var selectedPrinter = getSelectedPrinterName();
   var printToDialog = selectedPrinter == PRINT_TO_PDF ||
@@ skipping 155 matching lines @@
 
   pdfViewer = document.createElement('embed');
   pdfViewer.setAttribute('id', 'pdf-viewer');
   pdfViewer.setAttribute('type',
                          'application/x-google-chrome-print-preview-pdf');
   pdfViewer.setAttribute('src', srcURL);
   pdfViewer.setAttribute('aria-live', 'polite');
   pdfViewer.setAttribute('aria-atomic', 'true');
   $('mainview').appendChild(pdfViewer);
   pdfViewer.onload('onPDFLoad()');
+  pdfViewer.onScroll('onPreviewPositionChanged()');
+  pdfViewer.onPluginSizeChanged('onPreviewPositionChanged()');
   pdfViewer.removePrintButton();
   pdfViewer.grayscale(true);
 }
 
 /**
+ * Called either when there is a scroll event or when the plugin size changes.
+ */
+function onPreviewPositionChanged() {
+  marginSettings.onPreviewPositionChanged();
+}
+
+/**
  * @return {boolean} true if a compatible pdf plugin exists.
  */
 function checkCompatiblePluginExists() {
-  var dummyPlugin = $('dummy-viewer')
-  return !!(dummyPlugin.onload &&
-            dummyPlugin.goToPage &&
-            dummyPlugin.removePrintButton &&
-            dummyPlugin.loadPreviewPage &&
-            dummyPlugin.printPreviewPageCount &&
-            dummyPlugin.resetPrintPreviewUrl);
+  var dummyPlugin = $('dummy-viewer');
+  var pluginInterface = [ dummyPlugin.onload,

[Evan Stade, 2011/10/05 22:42:14]

I don't see anything wrong with the old format, why did you change it?

[dpapad, 2011/10/06 00:05:39]

Because this way is much easier to find which function is missing from the
plugin (by inserting a console.log in the for loop). This happens sometimes when
renaming functions of the plugin and it is tedious to spot which one.

[Evan Stade, 2011/10/07 03:29:58]

I suggest you leave the console.log there.

+                          dummyPlugin.goToPage,
+                          dummyPlugin.removePrintButton,
+                          dummyPlugin.loadPreviewPage,
+                          dummyPlugin.printPreviewPageCount,
+                          dummyPlugin.resetPrintPreviewUrl,
+                          dummyPlugin.onPluginSizeChanged,
+                          dummyPlugin.onScroll,
+                          dummyPlugin.pageXOffset,
+                          dummyPlugin.pageYOffset,
+                          dummyPlugin.setZoomLevel,
+                          dummyPlugin.setPageXOffset,
+                          dummyPlugin.setPageYOffset,
+                          dummyPlugin.getHorizontalScrollbarThickness,
+                          dummyPlugin.getVerticalScrollbarThickness,
+                          dummyPlugin.getPageLocationNormalized,
+                          dummyPlugin.getHeight,
+                          dummyPlugin.getWidth ];
+
+  for (var i = 0; i < pluginInterface.length; i++) {
+    if (!pluginInterface[i])
+      return false;
+  }
+  return true;
 }
 
 window.addEventListener('DOMContentLoaded', onLoad);
 
 /**
  * Sets the default values and sends a request to regenerate preview data.
  * Resets the margin options only if |resetMargins| is true.
  */
 function setDefaultValuesAndRegeneratePreview(resetMargins) {
   if (resetMargins)
@@ skipping 37 matching lines @@
 <include src="print_preview_animations.js"/>
 <include src="print_preview_cloud.js"/>
 <include src="print_preview_utils.js"/>
 <include src="print_header.js"/>
 <include src="page_settings.js"/>
 <include src="copies_settings.js"/>
 <include src="header_footer_settings.js"/>
 <include src="layout_settings.js"/>
 <include src="color_settings.js"/>
 <include src="margin_settings.js"/>
+<include src="margin_textbox.js"/>
+<include src="margin_line.js"/>
+<include src="margin_utils.js"/>
+<include src="margins_ui.js"/>
+<include src="preview_area.js"/>