org.mapfish.print.attribute

Class NorthArrowAttribute.NorthArrowAttributeValues

java.lang.Object

org.mapfish.print.attribute.NorthArrowAttribute.NorthArrowAttributeValues

Enclosing class:

NorthArrowAttribute

public class NorthArrowAttribute.NorthArrowAttributeValues
extends java.lang.Object

The value of NorthArrowAttribute.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	backgroundColor The background color for the north-arrow graphic (default: rgba(255, 255, 255, 0)).
java.lang.String	graphic The path to a graphic to use for the north-arrow.

Constructor Summary

Constructors

Constructor and Description
NorthArrowAttributeValues(java.awt.Dimension size, boolean createSubReport) Constructor.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getBackgroundColor()
java.lang.String	getGraphic()
java.awt.Dimension	getSize()
boolean	isCreateSubReport()
void	postConstruct() Initialize default values and validate that the config is correct.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

graphic

public java.lang.String graphic

The path to a graphic to use for the north-arrow.

It can either be an URL ("http://xyx.com/img/north-arrow.png") or a file in the configuration folder ("file://NorthArrow.svg"). Both SVG graphics and raster graphics (png, jpeg, tiff, ...) are supported.

While the resulting graphic used in the JasperReport template is a square, this graphic can have an arbitrary aspect ratio. The graphic will be scaled to the output size and rotated around its center.

If no graphic is given, a default north-arrow is used.

backgroundColor

public java.lang.String backgroundColor

The background color for the north-arrow graphic (default: rgba(255, 255, 255, 0)).

Constructor Detail

NorthArrowAttributeValues

public NorthArrowAttributeValues(java.awt.Dimension size,
                                 boolean createSubReport)

Constructor.

Parameters:

size - The size of the scalebar graphic in the Jasper report (in pixels).

createSubReport - Create a sub-report?

Method Detail

postConstruct

public final void postConstruct()

Initialize default values and validate that the config is correct.

getSize

public final java.awt.Dimension getSize()

getGraphic

public final java.lang.String getGraphic()

getBackgroundColor

public final java.awt.Color getBackgroundColor()

isCreateSubReport

public final boolean isCreateSubReport()