src/chrome/browser/resources/print_preview/data/page_number_set.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    * An immutable ordered set of page numbers.
  10    * @param {!Array.<number>} pageNumberList A list of page numbers to include
  11    *     in the set.
  12    * @constructor
  13    */
  14   function PageNumberSet(pageNumberList) {
  15     /**
  16      * Internal data store for the page number set.
  17      * @type {!Array.<number>}
  18      * @private
  19      */
  20     this.pageNumberSet_ = pageListToPageSet(pageNumberList);
  21   };
  22
  23   PageNumberSet.prototype = {
  24     /** @return {number} The number of page numbers in the set. */
  25     get size() {
  26       return this.pageNumberSet_.length;
  27     },
  28
  29     /**
  30      * @param {number} index 0-based index of the page number to get.
  31      * @return {number} Page number at the given index.
  32      */
  33     getPageNumberAt: function(index) {
  34       return this.pageNumberSet_[index];
  35     },
  36
  37     /**
  38      * @param {number} 1-based page number to check for.
  39      * @return {boolean} Whether the given page number is in the page range.
  40      */
  41     hasPageNumber: function(pageNumber) {
  42       return arrayContains(this.pageNumberSet_, pageNumber);
  43     },
  44
  45     /**
  46      * @param {number} 1-based number of the page to get index of.
  47      * @return {number} 0-based index of the given page number with respect to
  48      *     all of the pages in the page range.
  49      */
  50     getPageNumberIndex: function(pageNumber) {
  51       return this.pageNumberSet_.indexOf(pageNumber);
  52     },
  53
  54     /** @return {!Array.<number>} Array representation of the set. */
  55     asArray: function() {
  56       return this.pageNumberSet_.slice(0);
  57     },
  58   };
  59
  60   // Export
  61   return {
  62     PageNumberSet: PageNumberSet
  63   };
  64 });