chrome/browser/resources/print_preview/data/document_info.js

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 cr.define('print_preview', function() {
   6   'use strict';
   7
   8   /**
   9    * Data model which contains information related to the document to print.
  10    * @constructor
  11    * @extends {cr.EventTarget}
  12    */
  13   function DocumentInfo() {
  14     cr.EventTarget.call(this);
  15
  16     /**
  17      * Whether the document is styled by CSS media styles.
  18      * @type {boolean}
  19      * @private
  20      */
  21     this.hasCssMediaStyles_ = false;
  22
  23     /**
  24      * Whether the document has selected content.
  25      * @type {boolean}
  26      * @private
  27      */
  28     this.hasSelection_ = false;
  29
  30     /**
  31      * Whether the document to print is modifiable (i.e. can be reflowed).
  32      * @type {boolean}
  33      * @private
  34      */
  35     this.isModifiable_ = true;
  36
  37     /**
  38      * Whether scaling of the document is prohibited.
  39      * @type {boolean}
  40      * @private
  41      */
  42     this.isScalingDisabled_ = false;
  43
  44     /**
  45      * Margins of the document in points.
  46      * @type {print_preview.Margins}
  47      * @private
  48      */
  49     this.margins_ = null;
  50
  51     /**
  52      * Number of pages in the document to print.
  53      * @type {number}
  54      * @private
  55      */
  56     this.pageCount_ = 0;
  57
  58     // Create the document info with some initial settings. Actual
  59     // page-related information won't be set until preview generation occurs,
  60     // so we'll use some defaults until then. This way, the print ticket store
  61     // will be valid even if no preview can be generated.
  62     var initialPageSize = new print_preview.Size(612, 792); // 8.5"x11"
  63
  64     /**
  65      * Size of the pages of the document in points.
  66      * @type {!print_preview.Size}
  67      * @private
  68      */
  69     this.pageSize_ = initialPageSize;
  70
  71     /**
  72      * Printable area of the document in points.
  73      * @type {!print_preview.PrintableArea}
  74      * @private
  75      */
  76     this.printableArea_ = new print_preview.PrintableArea(
  77         new print_preview.Coordinate2d(0, 0), initialPageSize);
  78
  79     /**
  80      * Title of document.
  81      * @type {string}
  82      * @private
  83      */
  84     this.title_ = '';
  85
  86     /**
  87      * Whether this data model has been initialized.
  88      * @type {boolean}
  89      * @private
  90      */
  91     this.isInitialized_ = false;
  92   };
  93
  94   /**
  95    * Event types dispatched by this data model.
  96    * @enum {string}
  97    */
  98   DocumentInfo.EventType = {
  99     CHANGE: 'print_preview.DocumentInfo.CHANGE'
 100   };
 101
 102   DocumentInfo.prototype = {
 103     __proto__: cr.EventTarget.prototype,
 104
 105     /** @return {boolean} Whether the document is styled by CSS media styles. */
 106     get hasCssMediaStyles() {
 107       return this.hasCssMediaStyles_;
 108     },
 109
 110     /** @return {boolean} Whether the document has selected content. */
 111     get hasSelection() {
 112       return this.hasSelection_;
 113     },
 114
 115     /**
 116      * @return {boolean} Whether the document to print is modifiable (i.e. can
 117      *     be reflowed).
 118      */
 119     get isModifiable() {
 120       return this.isModifiable_;
 121     },
 122
 123     /** @return {boolean} Whether scaling of the document is prohibited. */
 124     get isScalingDisabled() {
 125       return this.isScalingDisabled_;
 126     },
 127
 128     /** @return {print_preview.Margins} Margins of the document in points. */
 129     get margins() {
 130       return this.margins_;
 131     },
 132
 133     /** @return {number} Number of pages in the document to print. */
 134     get pageCount() {
 135       return this.pageCount_;
 136     },
 137
 138     /**
 139      * @return {!print_preview.Size} Size of the pages of the document in
 140      *     points.
 141      */
 142     get pageSize() {
 143       return this.pageSize_;
 144     },
 145
 146     /**
 147      * @return {!print_preview.PrintableArea} Printable area of the document in
 148      *     points.
 149      */
 150     get printableArea() {
 151       return this.printableArea_;
 152     },
 153
 154     /** @return {string} Title of document. */
 155     get title() {
 156       return this.title_;
 157     },
 158
 159     /**
 160      * Initializes the state of the data model and dispatches a CHANGE event.
 161      * @param {boolean} isModifiable Whether the document is modifiable.
 162      * @param {string} title Title of the document.
 163      * @param {boolean} hasSelection Whether the document has user-selected
 164      *     content.
 165      */
 166     init: function(isModifiable, title, hasSelection) {
 167       this.isModifiable_ = isModifiable;
 168       this.title_ = title;
 169       this.hasSelection_ = hasSelection;
 170       this.isInitialized_ = true;
 171       cr.dispatchSimpleEvent(this, DocumentInfo.EventType.CHANGE);
 172     },
 173
 174     /**
 175      * Updates whether scaling is disabled for the document and dispatches a
 176      * CHANGE event.
 177      * @param {boolean} isScalingDisabled Whether scaling of the document is
 178      *     prohibited.
 179      */
 180     updateIsScalingDisabled: function(isScalingDisabled) {
 181       if (this.isInitialized_ && this.isScalingDisabled_ != isScalingDisabled) {
 182         this.isScalingDisabled_ = isScalingDisabled;
 183         cr.dispatchSimpleEvent(this, DocumentInfo.EventType.CHANGE);
 184       }
 185     },
 186
 187     /**
 188      * Updates the total number of pages in the document and dispatches a CHANGE
 189      * event.
 190      * @param {number} pageCount Number of pages in the document.
 191      */
 192     updatePageCount: function(pageCount) {
 193       if (this.isInitialized_ && this.pageCount_ != pageCount) {
 194         this.pageCount_ = pageCount;
 195         cr.dispatchSimpleEvent(this, DocumentInfo.EventType.CHANGE);
 196       }
 197     },
 198
 199     /**
 200      * Updates information about each page and dispatches a CHANGE event.
 201      * @param {!print_preview.PrintableArea} printableArea Printable area of the
 202      *     document in points.
 203      * @param {!print_preview.Size} pageSize Size of the pages of the document
 204      *     in points.
 205      * @param {boolean} hasCssMediaStyles Whether the document is styled by CSS
 206      *     media styles.
 207      * @param {print_preview.Margins} margins Margins of the document in points.
 208      */
 209     updatePageInfo: function(
 210         printableArea, pageSize, hasCssMediaStyles, margins) {
 211       if (this.isInitialized_ &&
 212           (!this.printableArea_.equals(printableArea) ||
 213            !this.pageSize_.equals(pageSize) ||
 214            this.hasCssMediaStyles_ != hasCssMediaStyles ||
 215            this.margins_ == null || !this.margins_.equals(margins))) {
 216         this.printableArea_ = printableArea;
 217         this.pageSize_ = pageSize;
 218         this.hasCssMediaStyles_ = hasCssMediaStyles;
 219         this.margins_ = margins;
 220         cr.dispatchSimpleEvent(this, DocumentInfo.EventType.CHANGE);
 221       }
 222     }
 223   };
 224
 225   // Export
 226   return {
 227     DocumentInfo: DocumentInfo
 228   };
 229 });