org.apache.fop.render.Graphics2DAdapter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id: Graphics2DAdapter.java 679326 2008-07-24 09:35:34Z vhennebert $ */
package org.apache.fop.render;
import java.io.IOException;
/**
* This interface represents an optional feature that can be provided by
* a renderer. It is exposed by calling the getGraphics2DAdapter() method
* on the renderer. Renderers that support this feature allow painting
* of arbitrary images through a Graphics2D instance.
*/
public interface Graphics2DAdapter {
/**
* Paints an arbitrary images on a given Graphics2D instance. The renderer
* providing this functionality must set up a Graphics2D instance so that
* the image with the given extents (in mpt) can be painted by the painter
* passed to this method. The Graphics2DImagePainter is then passed this
* Graphics2D instance so the image can be painted.
* @param painter the painter which will paint the actual image
* @param context the renderer context for the current renderer
* @param x X position of the image
* @param y Y position of the image
* @param width width of the image
* @param height height of the image
* @throws IOException In case of an I/O error while writing the output format
*/
void paintImage(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter,
RendererContext context,
int x, int y, int width, int height) throws IOException;
/**
* Paints an arbitrary images on a given Graphics2D instance. The renderer
* providing this functionality must set up a Graphics2D instance so that
* the image with the given extents (in mpt) can be painted by the painter
* passed to this method. The Graphics2DImagePainter is then passed this
* Graphics2D instance so the image can be painted.
* @param painter the painter which will paint the actual image
* @param context the renderer context for the current renderer
* @param x X position of the image
* @param y Y position of the image
* @param width width of the image
* @param height height of the image
* @throws IOException In case of an I/O error while writing the output format
* @deprecated Use the variant with the Graphics2DImagePainter from XML Graphics Commons instead
*/
void paintImage(Graphics2DImagePainter painter,
RendererContext context,
int x, int y, int width, int height) throws IOException;
}