Changeset 3831 for print

Timestamp:

07/08/11 15:57:05 (11 months ago)

Author:

sbrunner

Message:

Legends improvement r=jeichar (closes #643), fix null value introduce in [3827], merge with [3826]

Location:

print/trunk

Files:

• docs/configuration.txt (modified) (2 diffs)
• docs/protocol.txt (modified) (1 diff)
• src/main/java/org/mapfish/print/PDFUtils.java (modified) (3 diffs)
• src/main/java/org/mapfish/print/config/Config.java (modified) (1 diff)
• src/main/java/org/mapfish/print/config/layout/LegendsBlock.java (modified) (8 diffs)

print/trunk/docs/configuration.txt

@@ -515 +515 @@
 
           - !legends
-  ?         maxIconWidth: 8
+  ?         maxIconWidth: 8 
   ?         maxIconHeight: 8
+  ?         defaultScale: 0
+  ?         inline: true
   ?         classIndentation: 20
   ?         layerSpace: 5
@@ -527 +529 @@
   ?         fontEncoding: Cp1252
 
+**maxIconWidth**, **maxIconHeight**, **defaultScale** with value of 0 indicates that the value will be ignore.
+
+if **defaultScale** is non null it means that the legend image will be scaled so it doesn't take the full space.
+
+Set **inline** to false mean that only tne image will be display per line. 
+
 **layerSpace** and **classSpace** is to specify the line space to add before layers and classes.
 
-For this to work, you need to set the **layerTree** config option on MF print widgets.
+For this to work, you need to set the **layerTree** config option on MF print widgets,
+more precisely the legends should be present in the print.pdf JSON request.
 
 Table configuration

print/trunk/docs/protocol.txt

@@ -92 +92 @@
             }
         ]
+        legends: [
+            {
+                classes: [
+                    {
+                        icons: [
+                            'full url to the image'
+                        ]
+                        name: 'an icon name'
+                    }
+                ]
+                name: 'a class name'
+            }        
+        ]
     }
 

print/trunk/src/main/java/org/mapfish/print/PDFUtils.java

@@ -68 +68 @@
      */
     public static Image getImage(RenderingContext context, URI uri, float w, float h) throws IOException, DocumentException {
+        return getImage(context, uri, w, h, 0f);
+    }
+    
+    /**
+     * Gets an iText image with a cache that uses PdfTemplates to re-use the same
+     * bitmap content multiple times in order to reduce the file size.
+     */
+    public static Image getImage(RenderingContext context, URI uri, float w, float h, float scale) throws IOException, DocumentException {
         //Check the image is not already used in the PDF file.
         //
@@ -89 +97 @@
         if (w == 0.0f) {
             if (h == 0.0f) {
-                w = template.getWidth();
-                h = template.getHeight();
+                scale = scale == 0f ? 1f : scale;
+                w = template.getWidth() * scale;
+                h = template.getHeight() * scale;
             } else {
-                w = h / template.getHeight() * template.getWidth();
+                if (scale == 0f) {
+                    w = h / template.getHeight() * template.getWidth();
+                }
+                else {
+                    float maxh = h;
+                    w = template.getWidth() * scale;
+                    h = template.getWidth() * scale;
+                    float scaleh = h / maxh;
+                    if (scaleh > 1f) {
+                        w /=  scaleh;
+                        h /=  scaleh;
+                    }
+                }
             }
         } else {
             if (h == 0.0f) {
-                h = w / template.getWidth() * template.getHeight();
+                if (scale == 0f) {
+                    h = w / template.getWidth() * template.getHeight();
+                }
+                else {
+                    float maxw = w;
+                    w = template.getWidth() * scale;
+                    h = template.getWidth() * scale;
+                    float scalew = w / maxw;
+                    if (scalew > 1f) {
+                        w /=  scalew;
+                        h /=  scalew;
+                    }
+                }
+            }
+            else {
+                float maxw = w;
+                float maxh = h;
+                w = template.getWidth() * scale;
+                h = template.getWidth() * scale;
+                float scalew = w / maxw;
+                float scaleh = h / maxh;
+                float maxscale = Math.max(scalew, scaleh);
+                if (maxscale > 1f) {
+                    w /=  maxscale;
+                    h /=  maxscale;
+                }
             }
         }
@@ -437 +483 @@
 
     public static Chunk createImageChunk(RenderingContext context, double maxWidth, double maxHeight, URI url, float rotation) throws DocumentException {
-        final Image image = createImage(context, maxWidth, maxHeight, url, rotation);
+        return createImageChunk(context, maxWidth, maxHeight, 0f, url, rotation);
+    }
+    public static Chunk createImageChunk(RenderingContext context, double maxWidth, double maxHeight, float scale, URI url, float rotation) throws DocumentException {
+        final Image image = createImage(context, maxWidth, maxHeight, scale, url, rotation);
         return new Chunk(image, 0f, 0f, true);
     }
 
     public static Image createImage(RenderingContext context, double maxWidth, double maxHeight, URI url, float rotation) throws DocumentException {
+        return createImage(context, maxWidth, maxHeight, 0f, url, rotation);
+    }
+    public static Image createImage(RenderingContext context, double maxWidth, double maxHeight, float scale, URI url, float rotation) throws DocumentException {
         final Image image;
         try {
-            image = getImage(context, url, (float) maxWidth, (float) maxHeight);
+            image = getImage(context, url, (float) maxWidth, (float) maxHeight, scale);
         } catch (IOException e) {
             throw new InvalidValueException("url", url.toString(), e);

print/trunk/src/main/java/org/mapfish/print/config/Config.java

@@ -396 +396 @@
         String name = null;
         if(layout != null) {
-            name = PDFUtils.getValueFromString(layout.getOutputFilename()); // get the string if it has ${now} or ${now DATEFORMAT} in it
+            name = layout.getOutputFilename();
+            if (name != null) {
+                name = PDFUtils.getValueFromString(name); // get the string if it has ${now} or ${now DATEFORMAT} in it
+            }
         }
         return name == null ? outputFilename : name;

print/trunk/src/main/java/org/mapfish/print/config/layout/LegendsBlock.java

@@ -46 +46 @@
     public static final Logger LOGGER = Logger.getLogger(LegendsBlock.class);
 
-    private double maxIconWidth = 0;
-    private double maxIconHeight = 8;
+    private double maxIconWidth = 0; // 0 mean disable
+    private double maxIconHeight = 8; // 0 mean disable
+    private float scale = 0; // 0 mean disable
+    private boolean inline = true;
     private double classIndentation = 20;
-    private double layerSpace = 5;
-    private double classSpace = 2;
+    private float layerSpace = 5;
+    private float classSpace = 2;
 
     private String layerFont = "Helvetica";
@@ -69 +71 @@
             for (int i = 0; i < legends.size(); ++i) {
                 PJsonObject layer = legends.getJSONObject(i);
-                final PdfPCell cell = createLine(context, 0.0, layer, layerPdfFont, params);
-                if (i > 0) {
-                    cell.setPaddingTop((float) layerSpace);
-                }
-                table.addCell(cell);
+                createLine(context, 0.0, layer, layerPdfFont, params, table, i == 0 ? layerSpace : 0);
 
                 PJsonArray classes = layer.getJSONArray("classes");
                 for (int j = 0; j < classes.size(); ++j) {
                     PJsonObject clazz = classes.getJSONObject(j);
-                    final PdfPCell classCell = createLine(context, classIndentation, clazz, classPdfFont, params);
-                    classCell.setPaddingTop((float) classSpace);
-                    table.addCell(classCell);
+                    createLine(context, classIndentation, clazz, classPdfFont, params, table, classSpace);
                 }
             }
@@ -88 +84 @@
     }
 
-    private PdfPCell createLine(RenderingContext context, double indent, PJsonObject node, Font pdfFont, PJsonObject params) throws DocumentException {
+    private void createLine(RenderingContext context, double indent, PJsonObject node, Font pdfFont, PJsonObject params,
+            PdfPTable table, float lineSpace) throws DocumentException {
         final String name = node.getString("name");
         final String icon = node.optString("icon");
         final PJsonArray icons = node.optJSONArray("icons");
 
-        final Paragraph result = new Paragraph();
-        result.setFont(pdfFont);
+        Paragraph result = new Paragraph();
         if (icon != null) {
-                try {
-                        if (icon.indexOf("image%2Fsvg%2Bxml") != -1) { // TaODO: make this cleaner
-                                result.add(PDFUtils.createImageChunkFromSVG(context, icon, maxIconWidth, maxIconHeight));
-                        } else {
-                                result.add(PDFUtils.createImageChunk(context, maxIconWidth, maxIconHeight, URI.create(icon), 0.0f));
-                        }
-                    result.add(" ");
-                } catch (IOException ioe) {
+            try {
+                if (icon.indexOf("image%2Fsvg%2Bxml") != -1) { // TODO: make this cleaner
+                    result.add(PDFUtils.createImageChunkFromSVG(context, icon, maxIconWidth, maxIconHeight));
+                } else {
+                    result.add(PDFUtils.createImageChunk(context, maxIconWidth, maxIconHeight, URI.create(icon), 0f));
+                }
+                if (!inline) {
+                    addCell(context, indent, params, table, lineSpace, result);
+                    result = new Paragraph();
+                    result.setFont(pdfFont);
+                }
+                else {
+                    result.add(" ");
+                }
+            } catch (IOException ioe) {
                 LOGGER.warn("Failed to load " + icon + " with " + ioe.getMessage());
             } catch (InvalidValueException e) {
@@ -113 +116 @@
                 String iconItem = icons.getString(i);
                 try {
-                    if (iconItem.indexOf("image%2Fsvg%2Bxml") != -1) { // TaODO: make this cleaner
-                        result.add(PDFUtils.createImageChunkFromSVG(context, iconItem, maxIconWidth, maxIconHeight));
+                    if (iconItem.indexOf("image%2Fsvg%2Bxml") != -1) { // TODO: make this cleaner
+                        result.add(PDFUtils.createImageChunkFromSVG(context, iconItem, maxIconWidth, maxIconHeight));
                     } else {
-                        result.add(PDFUtils.createImageChunk(context, maxIconWidth, maxIconHeight, URI.create(iconItem), 0.0f));
+                        result.add(PDFUtils.createImageChunk(context, maxIconWidth, maxIconHeight, scale, URI.create(iconItem), 0f));
                     }
-                    result.add(" ");
+                    if (!inline) {
+                        addCell(context, indent, params, table, 0, result);
+                        result = new Paragraph();
+                        result.setFont(pdfFont);
+                    }
+                    else {
+                        result.add(" ");
+                    }
                 } catch (IOException ioe) {
                     LOGGER.warn("Failed to load " + iconItem + " with " + ioe.getMessage());
@@ -126 +136 @@
             }
         }
-
         final PdfPCell cell = new PdfPCell(result);
         cell.setBorder(PdfPCell.NO_BORDER);
@@ -132 +141 @@
         cell.setPaddingLeft((float) indent);
 
+        result.setFont(pdfFont);
         result.add(name);
 
@@ -137 +147 @@
             cell.setBackgroundColor(getBackgroundColorVal(context, params));
         }
-
-        return cell;
-    }
-
+        table.addCell(cell);
+    }
+
+    private void addCell(RenderingContext context, double indent, PJsonObject params, PdfPTable table,
+            float lineSpace, final Paragraph result) {
+        final PdfPCell cell = new PdfPCell(result);
+        cell.setBorder(PdfPCell.NO_BORDER);
+        cell.setPadding(0f);
+        cell.setPaddingLeft((float) indent);
+
+        if (getBackgroundColorVal(context, params) != null) {
+            cell.setBackgroundColor(getBackgroundColorVal(context, params));
+        }
+
+        cell.setPaddingTop(lineSpace);
+        table.addCell(cell);
+    }
+
+    public void setDefaultScale(double scale) {
+        this.scale = (float)scale;
+        if (scale < 0.0) throw new InvalidValueException("scale", scale);
+    }
+
+    public void setInline(String inline) {
+        this.inline = "true".equalsIgnoreCase(inline);
+        if (!inline.equalsIgnoreCase("true") || !inline.equalsIgnoreCase("false")) throw new InvalidValueException("inline", inline);
+    }
+    
     public void setMaxIconWidth(double maxIconWidth) {
         this.maxIconWidth = maxIconWidth;
@@ -178 +212 @@
 
     public void setLayerSpace(double layerSpace) {
-        this.layerSpace = layerSpace;
+        this.layerSpace = (float)layerSpace;
         if (layerSpace < 0.0) throw new InvalidValueException("layerSpace", layerSpace);
     }
 
     public void setClassSpace(double classSpace) {
-        this.classSpace = classSpace;
+        this.classSpace = (float)classSpace;
         if (classSpace < 0.0) throw new InvalidValueException("classSpace", classSpace);
     }