Package ca.spatial.reportwriter

Class MapLayoutReport.Group

java.lang.Object
ca.spatial.reportwriter.MapLayoutReport.MapElement
ca.spatial.reportwriter.MapLayoutReport.Group
Direct Known Subclasses:
MapLayoutReport.Grid, MapLayoutReport.Page
Enclosing class:
MapLayoutReport
public class MapLayoutReport.Group extends MapLayoutReport.MapElement
A group is a containter for map elements. All other map element types (Text, Maps, Legends, etc) are added to Groups. The outer most group is created automatically by the MapLayoutReport. Subsequent groups create folders for the optional content in the PDF table of contents.

  • Method Details

    • p

      public MapLayoutReport.Group p()
      Return to the parent group
      Overrides:
      p in class MapLayoutReport.MapElement

    • page

      public MapLayoutReport.Page page()
      Start a new page in the top level group, using the default page size

    • page

      public MapLayoutReport.Page page​(double width, double height)
      Start a new page in the top level group, using the specified page size

    • reverseToc

      public MapLayoutReport.Group reverseToc​(boolean state)
      Reverse the order of entries in the table of contents so that the last element added is at the top of the TOC. The default value is true.

    • addText

      public MapLayoutReport.Text addText​(double x, double y, double width, double height, String label, String htmlText)
      Add a text box using an HTML string

    • addText

      public MapLayoutReport.Text addText​(double x, double y, double width, double height, String label, Callable<String> caller)
      Add a text box using an object that will be dynamically evaluated when the report is rendered

    • addReportChart

      public MapLayoutReport.ReportChart addReportChart​(double x, double y, double width, double height, String label, Report report)
      Add a report chart

    • addReportChart

      public MapLayoutReport.ReportChart addReportChart​(double x, double y, double width, double height, Report report)
      Add a report chart. The report title will be used as the label

    • addReportTable

      public MapLayoutReport.ReportTable addReportTable​(double x, double y, double width, double height, Report report)
      Add a report table. The report title will be used as the label

    • addReportTable

      public MapLayoutReport.ReportTable addReportTable​(double x, double y, double width, double height, String label, Report report)
      Add a report table.

    • addNorthArrow

      public MapLayoutReport.NorthArrow addNorthArrow​(double x, double y, double width, double height, String label, double angle)
      Add a north arrow

    • addLegend

      public MapLayoutReport.Legend addLegend​(double x, double y, double width, double height, String label, LayerList ll)
      Add a legend

    • addLegend

      public MapLayoutReport.Legend addLegend​(double x, double y, double width, double height, String label, int mapperIndex)
      Add a legend

    • addMap

      public MapLayoutReport.Mapper addMap​(double x, double y, double width, double height, String label, LayerList ll, int period)
      Add a map

    • addScalebar

      public MapLayoutReport.Scalebar addScalebar​(double x, double y, double width, double height, String label, MapLayoutReport.Mapper mapper)
      Add a scalebar, specifying the map by object reference

    • addScalebar

      public MapLayoutReport.Scalebar addScalebar​(double x, double y, double width, double height, String label, int mapperIndex)
      Add a scalebar, specifying the map by index number

    • addCircle

      public MapLayoutReport.Graphic addCircle​(double x, double y, double radius, String label)
      Add a circle element

    • addEllipse

      public MapLayoutReport.Graphic addEllipse​(double x, double y, double width, double height, String label)
      Add an ellipse element

    • addRectangle

      public MapLayoutReport.Graphic addRectangle​(double x, double y, double width, double height, String label)
      Add a rectangle element

    • addRoundedRectangle

      public MapLayoutReport.Graphic addRoundedRectangle​(double x, double y, double width, double height, double arcw, double arch, String label)
      Add a rounded rectangle element

    • addLine

      public MapLayoutReport.Graphic addLine​(double x0, double y0, double x1, double y1, String label)
      Add a line element

    • addGroup

      public MapLayoutReport.Group addGroup​(String label)
      Add a group element with a given label. The group will take all of space within the drawing area of the component

    • addGroup

      public MapLayoutReport.Group addGroup​(double x, double y, double width, double height, String label)
      Add a group element with a given position and size.

    • addGrid

      public MapLayoutReport.Grid addGrid​(double x, double y, double width, double height, double[] columns, double[] rows)
      Add a grid element with a given position, size and number of rows and columns. The number of rows and columns in the grid is determined by the number of values in the rows and columns arrays. The amount of space that each row and column is alloted is determined by the relative proportion of the value specified in the rows and columns arrays.
      Parameters:
      x - the x location of the upper left corner in page units
      y - the x location of the upper left corner in page units
      width - the width of the grid in page units
      height - the height of the grid in page units
      columns - an array of values indicating the relative size proportion of each column
      rows - an array of values indicating the relative size proportion of each row