Allow for custom page sizes on image prints

Author: akberenz

js/qz-tray.js

@@ -1549,6 +1549,7 @@ var qz = (function() {
              *  @param {Object} [options.size=null] Paper size.
              *   @param {number} [options.size.width=null] Page width.
              *   @param {number} [options.size.height=null] Page height.
+             *   @param {boolean} [options.size.custom=false] If the provided page size is not included in the driver.
              *  @param {string} [options.units='in'] Page units, applies to paper size, margins, and density. Valid value <code>[in | cm | mm]</code>
              *
              *  @param {boolean} [options.forceRaw=false] Print the specified raw data using direct method, skipping the driver.  Not yet supported on Windows.

sample.html

@@ -589,6 +589,11 @@ <h3>Pixel Printing</h3>
                                                     </label>
                                                     <input type="number" step="any" id="pxlSizeHeight" class="form-control pull-right" />
                                                 </div>
+
+                                                <div class="form-group form-inline">
+                                                    <label for="pxlSizeForce">&nbsp; As Custom Size</label>
+                                                    <input type="checkbox" id="pxlSizeForce" class="pull-right" />
+                                                </div>
                                             </div>
 
                                             <div class="form-group">
@@ -2150,7 +2155,7 @@ <h4 class="panel-title">Options</h4>
         //print options not used with this flavor
 
         var printData = [
-            { type: 'pixel', format: 'image', flavor: 'file', data: 'assets/img/image_sample.png' }
+            { type: 'pixel', format: 'image', flavor: 'file', data: 'assets/test/custom_sized_tester.png' }
             //also valid, as format and flavor will default to proper values:
 //             { type: 'pixel', data: 'assets/img/image_sample.png' }
         ];
@@ -2698,6 +2703,7 @@ <h4 class="panel-title">Options</h4>
 
         $("#pxlSizeWidth").val('');
         $("#pxlSizeHeight").val('');
+        $("#pxlSizeForce").prop('checked', false);
         $("#pxlSizeActive").prop('checked', false);
         $("#pxlSizeGroup").css('display', 'none');
 
@@ -3252,7 +3258,8 @@ <h4 class="panel-title">Options</h4>
         if (isChecked($("#pxlSizeActive"), cleanConditions['pxlSizeActive']) && (($("#pxlSizeWidth").val() !== '') || ($("#pxlSizeHeight").val() !== ''))) {
             pxlSize = {
                 width: $("#pxlSizeWidth").val(),
-                height: $("#pxlSizeHeight").val()
+                height: $("#pxlSizeHeight").val(),
+                custom: $("#pxlSizeForce").prop('checked')
             };
         }
 
@@ -3446,7 +3453,7 @@ <h4 class="panel-title">Options</h4>
             // Ensure we're on the right tab
             stayOnTab = true;
         }
-        
+
         var setupDropButton = function(format, name, data, stayOnTab) {
             var tabHref;
             var buttonId;
@@ -3461,7 +3468,7 @@ <h4 class="panel-title">Options</h4>
                     buttonId = "#rawDropBtn"
                     tabHref = "#rawContent";
             }
-            
+
             var button = $(buttonId);
             if(stayOnTab) {
                 // File upload button can't change tabs
@@ -3489,7 +3496,7 @@ <h4 class="panel-title">Options</h4>
 
         if (file) {
             console.log("Dropped file:", file);
-            getBase64(file).then(function(base64) { 
+            getBase64(file).then(function(base64) {
                 var name = file.name;
                 var extension = name.substring(name.lastIndexOf('.') + 1, name.length) || '';
                 switch(extension.toLowerCase()) {
@@ -3511,7 +3518,7 @@ <h4 class="panel-title">Options</h4>
                     default:
                         setupDropButton("command", name, base64, stayOnTab);
                 }
-            }).catch(displayError); 
+            }).catch(displayError);
         }
     }
 

src/qz/printer/PrintOptions.java

@@ -349,6 +349,11 @@ public PrintOptions(JSONObject configOpts, PrintOutput output, PrintingUtilities
                     catch(JSONException e) { LoggerUtilities.optionWarn(log, "double", "size.height", subSize.opt("height")); }
                 }
 
+                if (!subSize.isNull("custom")) {
+                    try { s.custom = subSize.getBoolean("custom"); }
+                    catch(JSONException e) { LoggerUtilities.optionWarn(log, "boolean", "size.custom", subSize.opt("custom")); }
+                }
+
                 if (s.height <= 0 && s.width <= 0) {
                     log.warn("Page size has been set without dimensions, using default");
                 } else {
@@ -586,13 +591,18 @@ public Size getPageSize() {
     public class Size {
         private double width = -1;  //Page width
         private double height = -1; //Page height
-
+        private boolean custom = false; //Force a custom size
 
         public Size() {}
 
         public Size(double width, double height) {
+            this(width, height, false);
+        }
+
+        public Size(double width, double height, boolean custom) {
             this.width = width;
             this.height = height;
+            this.custom = custom;
         }
 
         public double getWidth() {
@@ -602,6 +612,10 @@ public double getWidth() {
         public double getHeight() {
             return height;
         }
+
+        public boolean isCustom() {
+            return custom;
+        }
     }
 
     /** Pixel page margins options */

src/qz/printer/action/PrintImage.java

@@ -188,7 +188,14 @@ public void print(PrintOutput output, PrintOptions options) throws PrinterExcept
         }
 
         job.setJobName(pxlOpts.getJobName(Constants.IMAGE_PRINT));
-        job.setPrintable(this, job.validatePage(page));
+
+        if (pxlOpts.getSize() != null && pxlOpts.getSize().isCustom()) {
+            // forcing a custom size, skip validation
+            job.setPrintable(this, page);
+        } else {
+            //expecting a valid paper size, validate
+            job.setPrintable(this, job.validatePage(page));
+        }
 
         printCopies(output, pxlOpts, job, attributes);
     }