net.sf.jasperreports.components.map.MapPrintElement Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.components.map;
import net.sf.jasperreports.components.map.type.MapTypeEnum;
import net.sf.jasperreports.engine.JRGenericElementType;
import net.sf.jasperreports.engine.type.OnErrorTypeEnum;
import net.sf.jasperreports.engine.xml.JRXmlConstants;
/**
* Utility class that creates generic print elements of map type.
*
* @author Teodor Danciu ([email protected])
*/
public final class MapPrintElement
{
/**
* The name of map generic elements.
*/
public static final String MAP_ELEMENT_NAME = "map";
/**
* The qualified type of Flash generic elements.
*/
public static final JRGenericElementType MAP_ELEMENT_TYPE =
new JRGenericElementType(JRXmlConstants.JASPERREPORTS_NAMESPACE, MAP_ELEMENT_NAME);
/**
* The name of the parameter that provides the latitude.
*/
public static final String PARAMETER_LATITUDE = "latitude";
/**
* The name of the parameter that provides the longitude.
*/
public static final String PARAMETER_LONGITUDE = "longitude";
/**
* The name of the parameter that provides the zoom.
*/
public static final String PARAMETER_ZOOM = "zoom";
/**
* The name of the parameter that provides the map type.
*/
public static final String PARAMETER_MAP_TYPE = "mapType";
/**
* The name of the parameter that provides the onErrorType attribute.
*/
public static final String PARAMETER_ON_ERROR_TYPE = "onErrorType";
/**
* The name of the parameter that provides the map scale.
*/
public static final String PARAMETER_MAP_SCALE = "mapScale";
/**
* The name of the parameter that provides the map image format.
*/
public static final String PARAMETER_IMAGE_TYPE = "imageType";
/**
* The name of the parameter that provides the list of marker objects for the map.
*/
public static final String PARAMETER_MARKERS = "markers";
/**
* The name of the parameter that provides the map language.
*/
public static final String PARAMETER_LANGUAGE = "language";
/**
* The cached image renderer.
*/
public static final String PARAMETER_CACHE_RENDERER = "cacheRenderer";
/**
* The name of the parameter that provides the marker icon url.
*/
public static final String PARAMETER_MARKER_ICON = "icon";
/**
* The name of the parameter that provides the marker icon url.
*/
public static final String PARAMETER_MARKER_ICON_URL = "icon.url";
/**
* The name of the parameter that provides the marker size.
*/
public static final String PARAMETER_MARKER_SIZE = "size";
/**
* The name of the parameter that provides the color for default markers.
*/
public static final String PARAMETER_MARKER_COLOR = "color";
/**
* The name of the parameter that provides the label for default markers.
*/
public static final String PARAMETER_MARKER_LABEL = "label";
/**
* The name of the parameter that provides the Google API map request parameters.
*/
public static final String PARAMETER_REQ_PARAMS = "reqParams";
/**
* The name of the flag parameter that specifies paths on the map
*/
public static final String PARAMETER_PATHS = "paths";
/**
* The name of the flag parameter that specifies whether the path is a polygon or a polyline. Default is false
*/
public static final String PARAMETER_PATH_IS_POLYGON = "isPolygon";
/**
* The name of the parameter that provides the stroke thickness, in pixels. Default is 5.
*/
public static final String PARAMETER_PATH_STROKE_WEIGHT = "strokeWeight";
/**
* The name of the parameter that provides the stroke color. Named colors are not supported.
*/
public static final String PARAMETER_PATH_STROKE_COLOR = "strokeColor";
/**
* The name of the parameter that provides the stroke opacity as a numerical fractional value between 0.0 and 1.0. Default value is 1.0.
*/
public static final String PARAMETER_PATH_STROKE_OPACITY = "strokeOpacity";
/**
* The name of the parameter that provides the fill color for polygons. If set, the path will be processed as polygon. Named colors are not supported.
*/
public static final String PARAMETER_PATH_FILL_COLOR = "fillColor";
/**
* The name of the parameter that provides the fill opacity as a numerical fractional value between 0.0 and 1.0. Default value is 0.0.
*/
public static final String PARAMETER_PATH_FILL_OPACITY = "fillOpacity";
/**
* The name of the parameter that provides the path locations.
*/
public static final String PARAMETER_PATH_LOCATIONS = "locations";
/**
*
*/
public static final Float DEFAULT_LATITUDE = 0f;
public static final Float DEFAULT_LONGITUDE = 0f;
public static final Integer DEFAULT_ZOOM = 0;
public static final MapTypeEnum DEFAULT_MAP_TYPE = MapTypeEnum.ROADMAP;
public static final OnErrorTypeEnum DEFAULT_ON_ERROR_TYPE = OnErrorTypeEnum.ERROR;
// /**
// * Creates a map element by copying all base element attributes
// * from a template instance.
// *
// * @param template the element from which to copy base attributes
// * @param latitude the latitude for the map
// * @param longitude the longitude for the map
// * @param elementParameters additional parameters to be set on the Flash element.
// * Hyperlink objects need to be set as element parameters.
// * @return a map element
// */
// public static JRGenericPrintElement makeMapElement(JRPrintElement template,
// Float latitude, Float longitude, Integer zoom, Map elementParameters)
// {
// // TODO use JRTemplateGenericElement
// JRBaseGenericPrintElement mapEl = new JRBaseGenericPrintElement(
// template.getDefaultStyleProvider());
// // copy all attribute from the template element
// mapEl.setX(template.getX());
// mapEl.setY(template.getY());
// mapEl.setWidth(template.getWidth());
// mapEl.setHeight(template.getHeight());
// mapEl.setStyle(template.getStyle());
// mapEl.setMode(template.getOwnModeValue());
// mapEl.setBackcolor(template.getOwnBackcolor());
// mapEl.setForecolor(template.getOwnForecolor());
// mapEl.setOrigin(template.getOrigin());
// mapEl.setKey(template.getKey());
//
// mapEl.setGenericType(MAP_ELEMENT_TYPE);
// mapEl.setParameterValue(PARAMETER_LATITUDE, latitude);
// mapEl.setParameterValue(PARAMETER_LONGITUDE, longitude);
// mapEl.setParameterValue(PARAMETER_ZOOM, zoom);
//
// if (elementParameters != null && !elementParameters.isEmpty())
// {
// for (Iterator> it = elementParameters.entrySet().iterator(); it.hasNext();)
// {
// Map.Entry entry = it.next();
// String name = entry.getKey();
// Object value = entry.getValue();
// mapEl.setParameterValue(name, value);
// }
// }
//
// return mapEl;
// }
private MapPrintElement()
{
}
}