org.xhtmlrenderer.simple.Graphics2DRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of flying-saucer-core Show documentation
Show all versions of flying-saucer-core Show documentation
Flying Saucer is a CSS 2.1 renderer written in Java. This artifact contains the core rendering and layout code as well as Java2D output.
/*
* {{{ header & license
* Copyright (c) 2004, 2005 Joshua Marinacci
*
* This program 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 2.1
* of the License, or (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* }}}
*/
package org.xhtmlrenderer.simple;
import org.w3c.dom.Document;
import org.xhtmlrenderer.layout.SharedContext;
import java.awt.*;
import java.awt.image.BufferedImage;
/**
*
* Graphics2DRenderer supports headless rendering of XHTML documents, and is useful
* for rendering documents directly to images.
*
* Graphics2DRenderer supports the {@link XHTMLPanel#setDocument(Document)},
* {@link XHTMLPanel#layout()}, and {@link XHTMLPanel#render()} methods from
* {@link XHTMLPanel}, as well as easy-to-use static utility methods.
* For example, to render a document in an image that is 600 pixels wide use the
* {@link #renderToImageAutoSize(String,int,int)} method like this:
*
* BufferedImage img = Graphics2DRenderer.renderToImage( "test.xhtml", width);
*
*
*
*
*
*
* @author Joshua Marinacci
*/
public class Graphics2DRenderer {
/**
* The panel we are using to render the document.
*/
protected XHTMLPanel panel;
/**
* Dimensions of the image to render, in pixels.
*/
protected Dimension dim;
/**
* Creates a new renderer with no document specified.
*/
public Graphics2DRenderer() {
panel = new XHTMLPanel();
panel.setInteractive(false);
}
// ASK maybe we could change the graphics2d to be a font rendering context?
/**
* Lay out the document with the specified dimensions,
* without rendering.
*
* @param g2 the canvas to layout on.
* @param dim dimensions of the container for the document
*/
public void layout(Graphics2D g2, Dimension dim) {
this.dim = dim;
if (dim != null) {
panel.setSize(dim);
}
panel.doDocumentLayout(g2);
}
/**
* Renders the document to the given canvas. Call layout() first.
*
* @param g2 Canvas to render to.
*/
public void render(Graphics2D g2) {
if (g2.getClip() == null) {
g2.setClip(getMinimumSize());
}
panel.paintComponent(g2);
}
/**
* Set the document to be rendered, lays it out, and
* renders it.
*
* @param url the URL for the document to render.
*/
public void setDocument(String url) {
panel.setDocument(url);
}
/**
* Sets the document to render, lays it out, and renders it.
*
* @param doc the Document to render
* @param base_url base URL for relative links within the Document.
*/
public void setDocument(Document doc, String base_url) {
panel.setDocument(doc, base_url);
}
/**
* Sets the SharedContext for rendering.
*
* @param ctx The new renderingContext value
*/
public void setSharedContext(SharedContext ctx) {
panel.setSharedContext(ctx);
}
/**
* Returns the size image needed to render the document without anything
* going off the side. Could be different than the dimensions passed into
* layout because of text that couldn't break or a table that's set to be
* too big.
*
* @return A rectangle sized to the minimum size required for the
* document.
*/
public Rectangle getMinimumSize() {
if (panel.getPreferredSize() != null) {
return new Rectangle(0, 0,
(int) panel.getPreferredSize().getWidth(),
(int) panel.getPreferredSize().getHeight());
} else {
return new Rectangle(0, 0, panel.getWidth(), panel.getHeight());
}
}
/**
* Gets the SharedContext for layout and rendering.
*
* @return see desc
*/
public SharedContext getSharedContext() {
return panel.getSharedContext();
}
/** Returns the panel used internally for rendering. */
public XHTMLPanel getPanel() {
return panel;
}
/**
* A static utility method to automatically create an image from a
* document; the image supports transparency. To render an image that does not support transparency,
* use the overloaded version of this method {@link #renderToImage(String, int, int, int)}.
*
* @param url URL for the document to render.
* @param width Width in pixels of the layout container
* @param height Height in pixels of the layout container
* @return Returns an Image containing the rendered document.
*/
public static BufferedImage renderToImage(String url, int width, int height) {
return renderToImage(url, width, height, BufferedImage.TYPE_INT_ARGB);
}
/**
* A static utility method to automatically create an image from a
* document. The buffered image type must be specified.
*
* @param url URL for the document to render.
* @param width Width in pixels of the layout container
* @param height Height in pixels of the layout container
* @param bufferedImageType On of the pre-defined image types for a java.awt.image.BufferedImage, such
* as TYPE_INT_ARGB or TYPE_INT_RGB.
* @return Returns an Image containing the rendered document.
*/
public static BufferedImage renderToImage(String url, int width, int height, int bufferedImageType) {
Graphics2DRenderer g2r = new Graphics2DRenderer();
g2r.setDocument(url);
Dimension dim = new Dimension(width, height);
BufferedImage buff = new BufferedImage((int) dim.getWidth(), (int) dim.getHeight(), bufferedImageType);
Graphics2D g = (Graphics2D) buff.getGraphics();
g2r.layout(g, dim);
g2r.render(g);
g.dispose();
return buff;
}
/**
* A static utility method to automatically create an image from a
* document, where height is determined based on document content.
* To estimate a size before rendering, use {@link #setDocument(String)}
* and then {@link #getMinimumSize()}. The rendered image supports transparency.
*
* @param url java.net.URL for the document to render.
* @param width Width in pixels of the layout container
* @return Returns an java.awt.Image containing the rendered document.
*/
public static BufferedImage renderToImageAutoSize(String url, int width){
return renderToImageAutoSize(url, width, BufferedImage.TYPE_INT_ARGB);
}
/**
* A static utility method to automatically create an image from a
* document, where height is determined based on document content.
* To estimate a size before rendering, use {@link #setDocument(String)}
* and then {@link #getMinimumSize()}.
*
* @param url java.net.URL for the document to render.
* @param width Width in pixels of the layout container
* @param bufferedImageType On of the pre-defined image types for a java.awt.image.BufferedImage, such
* as TYPE_INT_ARGB or TYPE_INT_RGB.
* @return Returns an java.awt.Image containing the rendered document.
*/
public static BufferedImage renderToImageAutoSize(String url, int width, int bufferedImageType) {
Graphics2DRenderer g2r = new Graphics2DRenderer();
g2r.setDocument(url);
Dimension dim = new Dimension(width, 1000);
// do layout with temp buffer
BufferedImage buff = new BufferedImage((int) dim.getWidth(), (int) dim.getHeight(), bufferedImageType);
Graphics2D g = (Graphics2D) buff.getGraphics();
g2r.layout(g, new Dimension(width, 1000));
g.dispose();
// get size
Rectangle rect = g2r.getMinimumSize();
// render into real buffer
buff = new BufferedImage((int) rect.getWidth(), (int) rect.getHeight(), bufferedImageType);
g = (Graphics2D) buff.getGraphics();
g2r.render(g);
g.dispose();
// return real buffer
return buff;
}
}
/*
* $Id$
*
* $Log$
* Revision 1.22 2008/03/17 22:26:15 pdoubleya
* Issue 225: allow user to specify type for buffered image, instead of just defaulting to transparent image support.
*
* Revision 1.21 2007/08/19 22:22:54 peterbrant
* Merge R8pbrant changes to HEAD
*
* Revision 1.20.2.1 2007/08/13 22:32:09 peterbrant
* Rename doLayout() to doDocumentLayout() to avoid confusion with AWT's doLayout()
*
* Revision 1.20 2007/05/21 21:58:47 peterbrant
* More cleanup (remove experimental threading code)
*
* Revision 1.19 2007/04/03 13:12:06 peterbrant
* Add notification interface for layout and render exceptions / Minor clean up (remove obsolete body expand hack, remove unused API, method name improvements)
*
* Revision 1.18 2006/05/12 18:18:10 peterbrant
* Remove dead code
*
* Revision 1.17 2006/04/07 07:28:39 pdoubleya
* JavaDoc
*
* Revision 1.16 2006/01/04 19:50:16 peterbrant
* More pagination bug fixes / Implement simple pagination for tables
*
* Revision 1.15 2005/10/27 00:09:07 tobega
* Sorted out Context into RenderingContext and LayoutContext
*
* Revision 1.14 2005/10/26 17:01:44 peterbrant
* Allow the "use threads" config property to be set on individual instances of
* XHTMLPanel.
*
* Revision 1.13 2005/09/29 06:15:06 tobega
* Patch from Peter Brant:
* List of changes:
* - Fix extents height calculation
* - Small refactoring to Boxing to combine a method
* - Make render and layout threads interruptible and add
* RootPanel.shutdown() method to shut them down in an orderly manner
* - Fix NPE in Graphics2DRenderer. It looks like
* BasicPanel.intrinsic_size will always be null anyway?
* - Fix NPE in RootPanel when enclosingScrollPane is null.
* - Both RenderLoop.collapseRepaintEvents and
* LayoutLoop.collapseLayoutEvents will go into an infinite loop if the
* next event isn't collapsible. I added a common implementation to
* RenderQueue which doesn't have this problem.
*
* Revision 1.12 2005/09/28 00:25:16 joshy
* a bit more cleanup
* Issue number:
* Obtained from:
* Submitted by:
* Reviewed by:
*
* Revision 1.11 2005/09/26 22:40:21 tobega
* Applied patch from Peter Brant concerning margin collapsing
*
* Revision 1.10 2005/06/16 07:24:52 tobega
* Fixed background image bug.
* Caching images in browser.
* Enhanced LinkListener.
* Some house-cleaning, playing with Idea's code inspection utility.
*
* Revision 1.9 2005/06/15 10:56:14 tobega
* cleaned up a bit of URL mess, centralizing URI-resolution and loading to UserAgentCallback
*
* Revision 1.8 2005/06/01 21:36:43 tobega
* Got image scaling working, and did some refactoring along the way
*
* Revision 1.7 2005/03/24 23:11:41 pdoubleya
* Comments.
*
*
*/