Paging: Add an option to add an overview layer to the main map that displays the position of the pages (#3618)

* Feature : paging add an option to add an overview layer to the main map that displays the position of the pages on the main map

Author: arnaudboudier-sogelink

core/src/main/java/org/mapfish/print/Constants.java

@@ -94,5 +94,15 @@ private OverviewMap() {
       /** The default style name for the bbox rectangle in the overview map. */
       public static final String NAME = "overview-map";
     }
+
+    public static final class PagingOverviewLayer {
+
+      private PagingOverviewLayer() {
+        // not called
+      }
+
+      /** The default style name for the bbox rectangle in the overview map. */
+      public static final String NAME = "paging-overview-layer";
+    }
   }
 }

core/src/main/java/org/mapfish/print/attribute/map/MapAttribute.java

@@ -87,6 +87,9 @@ public class MapAttributeValues extends GenericMapAttributeValues {
 
     private MapBounds mapBounds;
 
+    /** Paging overview layer that displays the position of the pages on the main map. */
+    private MapLayer pagingOverviewLayer;
+
     /**
      * Constructor.
      *
@@ -122,6 +125,14 @@ public void setRawLayers(final PArray newLayers) {
       this.layers = newLayers;
     }
 
+    public void setPagingOverviewLayer(final MapLayer newPagingOverviewLayer) {
+      this.pagingOverviewLayer = newPagingOverviewLayer;
+    }
+
+    public MapLayer getPagingOverviewLayer() {
+      return this.pagingOverviewLayer;
+    }
+
     @Override
     public final void postConstruct() throws FactoryException {
       super.postConstruct();

core/src/main/java/org/mapfish/print/attribute/map/PagingAttribute.java

@@ -10,7 +10,7 @@
  * Attribute that defines how a map is displayed across many pages.
  *
  * <p>This is used by the <a href="processors.html#!paging">paging processor</a>.
- * [[examples=paging]]
+ * [[examples=paging,paging_with_overview_layer]]
  */
 public final class PagingAttribute
     extends ReflectiveAttribute<PagingAttribute.PagingProcessorValues> {
@@ -64,5 +64,16 @@ public static class PagingProcessorValues {
      * definition.
      */
     @HasDefaultValue public String aoiStyle = null;
+
+    /**
+     * If set to true will add an overview layer to the main map with all the pages and their label.
+     */
+    @HasDefaultValue public Boolean renderPagingOverview = false;
+
+    /**
+     * The style of the paging overview layer. This parameter is usefull only if
+     * renderPagingOverview is true.
+     */
+    @HasDefaultValue public String pagingOverviewStyle = null;
   }
 }

core/src/main/java/org/mapfish/print/config/Configuration.java

@@ -15,12 +15,18 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.annotation.PostConstruct;
+import org.geotools.api.filter.expression.Expression;
+import org.geotools.api.style.FeatureTypeStyle;
 import org.geotools.api.style.Fill;
+import org.geotools.api.style.Font;
 import org.geotools.api.style.Graphic;
+import org.geotools.api.style.Halo;
+import org.geotools.api.style.LineSymbolizer;
 import org.geotools.api.style.Mark;
 import org.geotools.api.style.Stroke;
 import org.geotools.api.style.Style;
 import org.geotools.api.style.Symbolizer;
+import org.geotools.api.style.TextSymbolizer;
 import org.geotools.styling.StyleBuilder;
 import org.json.JSONException;
 import org.json.JSONWriter;
@@ -43,6 +49,7 @@
 import org.mapfish.print.map.style.json.ColorParser;
 import org.mapfish.print.processor.http.matcher.URIMatcher;
 import org.mapfish.print.processor.http.matcher.UriMatchers;
+import org.mapfish.print.processor.map.CreateMapPagesProcessor;
 import org.mapfish.print.servlet.fileloader.ConfigFileLoaderManager;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -372,6 +379,8 @@ public final Style getDefaultStyle(@Nonnull final String geometryType) {
         symbolizer = builder.createRasterSymbolizer();
       } else if (normalizedGeomName.startsWith(Constants.Style.OverviewMap.NAME)) {
         symbolizer = createMapOverviewStyle(normalizedGeomName, builder);
+      } else if (normalizedGeomName.startsWith(Constants.Style.PagingOverviewLayer.NAME)) {
+        return createOverviewPagingLayerStyle(builder);
       } else {
         final Style geomStyle = this.defaultStyle.get(Geometry.class.getSimpleName().toLowerCase());
         if (geomStyle != null) {
@@ -424,6 +433,28 @@ private Symbolizer createMapOverviewStyle(
     return builder.createPolygonSymbolizer(stroke, fill);
   }
 
+  private Style createOverviewPagingLayerStyle(@Nonnull final StyleBuilder builder) {
+    Stroke stroke = builder.createStroke(Color.gray, 1.5);
+    LineSymbolizer polygonSymbolizer = builder.createLineSymbolizer(stroke);
+
+    Font[] fonts = new Font[] {builder.createFont("Lucida Sans", 10.0D)};
+    Halo halo = builder.createHalo(Color.white, 1);
+    Expression name =
+        builder.attributeExpression(CreateMapPagesProcessor.OVERVIEW_PAGING_ATTRIBUT_TEXT);
+    Fill fillColor = builder.createFill(Color.black);
+    TextSymbolizer textSymbolizer =
+        builder.createTextSymbolizer(fillColor, fonts, halo, name, null, null);
+
+    FeatureTypeStyle features =
+        builder.createFeatureTypeStyle(
+            CreateMapPagesProcessor.OVERVIEW_PAGING_FEATURE_NAME,
+            new Symbolizer[] {polygonSymbolizer, textSymbolizer});
+
+    Style s = builder.createStyle();
+    s.featureTypeStyles().add(features);
+    return s;
+  }
+
   /**
    * Set the default styles. the case of the keys are not important. The retrieval will be case
    * insensitive.