Package org.mapfish.print.attribute.map

Class MapAttribute.OverriddenMapAttributeValues

java.lang.Object

org.mapfish.print.attribute.map.GenericMapAttribute.GenericMapAttributeValues

org.mapfish.print.attribute.map.MapAttribute.MapAttributeValues

org.mapfish.print.attribute.map.MapAttribute.OverriddenMapAttributeValues

Enclosing class:

MapAttribute

public class MapAttribute.OverriddenMapAttributeValues
extends MapAttribute.MapAttributeValues

A wrapper around a MapAttribute.MapAttributeValues instance and an OverviewMapAttribute.OverviewMapAttributeValues instance, which is used to render the overview map.

If attributes on the OverviewMapAttribute.OverviewMapAttributeValues instance are set, those attributes will be returned, otherwise the ones on MapAttribute.MapAttributeValues.

Field Summary

Fields inherited from class org.mapfish.print.attribute.map.MapAttribute.MapAttributeValues

areaOfInterest, bbox, center, dpi, layers, scale, zoomToFeatures

Fields inherited from class org.mapfish.print.attribute.map.GenericMapAttribute.GenericMapAttributeValues

DEFAULT_PROJECTION, dpiSensitiveStyle, height, longitudeFirst, pdfA, projection, rotation, useAdjustBounds, useNearestScale, width

Constructor Summary

Constructors

Constructor	Description
OverriddenMapAttributeValues(MapAttribute.MapAttributeValues params, OverviewMapAttribute.OverviewMapAttributeValues paramOverrides, Template template)	Constructor.

Method Summary

Modifier and Type	Method	Description
MapBounds	getCustomBounds()	Custom bounds for the overview-map.
java.lang.Double	getDpi()	Return the DPI value for the map.
java.util.List<MapLayer>	getLayers()
MapBounds	getMapBounds()	The bounds used to render the overview-map.
MapBounds	getOriginalBounds()	The bounds of the original map that this overview-map is associated to.
java.lang.Double	getRotation()	Gets the rotation.
ZoomLevels	getZoomLevels()
ZoomLevelSnapStrategy	getZoomLevelSnapStrategy()
java.lang.Double	getZoomSnapTolerance()
java.lang.Boolean	isUseAdjustBounds()	Return true if requestData has useNearestScale and configuration has some zoom levels defined.
java.lang.Boolean	isUseNearestScale()	Return true if requestData has useNearestScale and configuration has some zoom levels defined.
void	setMapExtentLayer(MapLayer mapExtentLayer)
void	setZoomedOutBounds(MapBounds zoomedOutBounds)

Methods inherited from class org.mapfish.print.attribute.map.MapAttribute.MapAttributeValues

copy, getProjection, getRawLayers, getWithOverrides, getZoomSnapGeodetic, postConstruct, recalculateBounds, setMapBounds, setRawLayers

Methods inherited from class org.mapfish.print.attribute.map.GenericMapAttribute.GenericMapAttributeValues

getDpiSuggestions, getHeight, getMapSize, getTemplate, getValueOr, getWidth, isDpiSensitiveStyle, parseProjection, replaceLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

OverriddenMapAttributeValues

public OverriddenMapAttributeValues(MapAttribute.MapAttributeValues params,
                                    OverviewMapAttribute.OverviewMapAttributeValues paramOverrides,
                                    Template template)

Constructor.

Parameters:

params - The fallback parameters.

paramOverrides - The parameters explicitly defined for the overview map.

template - The template this map is part of.

Method Detail

getMapBounds

public final MapBounds getMapBounds()

The bounds used to render the overview-map.

Overrides:

getMapBounds in class MapAttribute.MapAttributeValues

getCustomBounds

public final MapBounds getCustomBounds()

Custom bounds for the overview-map. Overwrites the bounds of the original map.

getOriginalBounds

public final MapBounds getOriginalBounds()

The bounds of the original map that this overview-map is associated to.

setZoomedOutBounds

public final void setZoomedOutBounds(MapBounds zoomedOutBounds)

getDpi

public final java.lang.Double getDpi()

Description copied from class: GenericMapAttribute.GenericMapAttributeValues

Return the DPI value for the map. This method is abstract because the dpi value is optional for the overview map, but must be given for the normal map. So, in the overview map the field is defined with a @HasDefaultValue annotation.

Overrides:

getDpi in class MapAttribute.MapAttributeValues

getZoomSnapTolerance

public final java.lang.Double getZoomSnapTolerance()

Overrides:

getZoomSnapTolerance in class MapAttribute.MapAttributeValues

getZoomLevelSnapStrategy

public final ZoomLevelSnapStrategy getZoomLevelSnapStrategy()

Overrides:

getZoomLevelSnapStrategy in class MapAttribute.MapAttributeValues

getZoomLevels

public final ZoomLevels getZoomLevels()

Overrides:

getZoomLevels in class GenericMapAttribute.GenericMapAttributeValues

getRotation

public final java.lang.Double getRotation()

Description copied from class: GenericMapAttribute.GenericMapAttributeValues

Gets the rotation.

Overrides:

getRotation in class MapAttribute.MapAttributeValues

Returns:

the rotation

isUseAdjustBounds

public final java.lang.Boolean isUseAdjustBounds()

Description copied from class: GenericMapAttribute.GenericMapAttributeValues

Return true if requestData has useNearestScale and configuration has some zoom levels defined.

Overrides:

isUseAdjustBounds in class MapAttribute.MapAttributeValues

isUseNearestScale

public final java.lang.Boolean isUseNearestScale()

Description copied from class: GenericMapAttribute.GenericMapAttributeValues

Return true if requestData has useNearestScale and configuration has some zoom levels defined.

Overrides:

isUseNearestScale in class MapAttribute.MapAttributeValues

setMapExtentLayer

public final void setMapExtentLayer(MapLayer mapExtentLayer)

getLayers

public final java.util.List<MapLayer> getLayers()

Overrides:

getLayers in class GenericMapAttribute.GenericMapAttributeValues