Package ca.spatial.reportwriter

Class MapLayoutReport.MapElement

java.lang.Object
ca.spatial.reportwriter.MapLayoutReport.MapElement
Direct Known Subclasses:
MapLayoutReport.Graphic, MapLayoutReport.Group, MapLayoutReport.Legend, MapLayoutReport.Mapper, MapLayoutReport.NorthArrow, MapLayoutReport.ReportChart, MapLayoutReport.ReportTable, MapLayoutReport.Scalebar, MapLayoutReport.Text, MapLayoutReport.TopGroup
Enclosing class:
MapLayoutReport
public abstract class MapLayoutReport.MapElement extends Object
MapElement is the abstract base class for the components of a MapLayout. MapElements include text boxes, legends, maps, scale bars, north arrows, as well as groupings of the above components.

  • Method Details

    • p

      public MapLayoutReport.Group p()
      Return the parent of this element.

    • top

      public MapLayoutReport.TopGroup top()
      Return the top group.

    • r

      public MapLayoutReport r()
      Return the report object

    • getWidth

      public double getWidth()
      Get the width of the element, after adjustments to fit within the parent container.

    • getHeight

      public double getHeight()
      Get the height of the element, after adjustments to fit within the parent container.

    • background

      public MapLayoutReport.MapElement background​(Color color)
      Set the background colour for this element.

    • getBackground

      public Color getBackground()

    • neatline

      public MapLayoutReport.MapElement neatline​(int style)
      Turn on a simple neatline for this element.

    • margin

      public MapLayoutReport.MapElement margin​(double margin)
      Set the margin for this element. The margin will be applied equally on all sides outside of the neatline.

    • inset

      public MapLayoutReport.MapElement inset​(double inset)
      Set the inset for this element. The inset will be applied equally on all sides inside of the neatline.

    • visible

      public MapLayoutReport.MapElement visible​(boolean state)
      Set if the element is initially visible or not. Visibility can be manually selected in the TOC. The default value is true.

    • hidden

      public MapLayoutReport.MapElement hidden​(boolean state)
      Set if the element is visible in the table of contents or not. If it is not visible then it cannot be manually selected in the TOC. The default value is false.

    • bookmark

      public MapLayoutReport.MapElement bookmark​(boolean state)
      Set if a bookmark is placed in the outline for this element. The title is used as the name of the bookmark. The default value is false.

    • zoom

      public MapLayoutReport.MapElement zoom​(double zoom)
      Set the zoom factor for the element

    • contentWidth

      public double contentWidth​(int units)
      Compute the width of the content area

    • contentHeight

      public double contentHeight​(int units)
      Compute the width of the content area

    • subtype

      public String subtype()
      Get the type of this element

    • simplistWidth

      public double simplistWidth()
      Get the width of the drawing area within the element (not including margin and insets)

    • simplistHeight

      public double simplistHeight()
      Get the height of the drawing area within the element (not including margin and insets)