PrintableMapBuilder.java

/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2015 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */

package org.geomajas.gwt2.plugin.print.client.template;

import org.geomajas.geometry.Bbox;
import org.geomajas.gwt2.client.map.MapPresenter;
import org.geomajas.gwt2.plugin.print.client.layerbuilder.PrintableLayerBuilder;

/**
 * Interface for building a printable version of a map.
 * 
 * @author Jan De Moerloose
 * @author An Buyle (support for extra layer with e.g. selected geometries)
 * @author Jan Venstermans
 */
public interface PrintableMapBuilder {

	/**
	 * Method for registering a {@link PrintableLayerBuilder}.
	 * This will allow for specific layers to be rendered in the printed map.
	 * Multiple layerBuilders can be registered at the same time.
	 *
	 * @param layerBuilder
	 */
	void registerLayerBuilder(PrintableLayerBuilder layerBuilder);

	/**
	 * Performs the build process of creation the printed map.
	 *
	 * @param mapPresenter
	 * @param worldBounds
	 * @param rasterResolution
	 */
	void build(MapPresenter mapPresenter, Bbox worldBounds, double rasterResolution);
}