Class Java2DRenderer
Renders an XML files, formatted with CSS, as an image. Input is a document in the form of file or URL, and output is a BufferedImage. A Java2DRenderer is not intended to be re-used for multiple document sources; just create new Java2DRenderers for each one you need. Java2DRenderer is not thread-safe. Standard usage pattern is
File xhtml = ... Java2DRenderer rend = new Java2DRenderer(xhtml); BufferedImage image = rend.getImage();
The document is not loaded, and layout and render don't take place, until #getImage(int)
is called.
Subsequent calls to getImage()
don't result in a reload; create a new Java2DRenderer instance to do so.
As with RootPanel
, you can access the
SharedContext
instance that will be used by this renderer and change settings
to control the rendering process; use getSharedContext()
.
By default, this renderer will render to an RGB image which does not support transparency. To use another type
of BufferedImage, either set the image type using setBufferedImageType(int)
before calling
getImage()
, or else override the createBufferedImage(int, int)
to have full control over
the image we render to.
Not thread-safe.
- See Also:
-
ITextRenderer
-
Constructor Summary
ConstructorsConstructorDescriptionJava2DRenderer
(File file, int width) Creates a new instance for a given File.Java2DRenderer
(File file, int width, int height) Creates a new instance for a given File.Java2DRenderer
(String url, int width) Renderer for a given URL (which is also used as the base) and a specified width; height is calculated automatically.Java2DRenderer
(String url, int width, int height) Renderer for a given URL and a specified width; height is calculated automatically.Java2DRenderer
(String url, String baseurl, int width) Renderer for a given URL and a specified width; height is calculated automatically.Java2DRenderer
(String url, String baseUrl, int width, int height) Creates a new instance for a given URL.Java2DRenderer
(Document doc, int width, int height) Creates a new instance pointing to the given Document. -
Method Summary
Modifier and TypeMethodDescriptiongetImage()
Renders the XML document if necessary and returns the resulting image.Returns the SharedContext to be used by renderer.void
setBufferedImageType
(int bufferedImageType) Sets the type for the BufferedImage used as output for this renderer; must be one of the values fromBufferedImage
allowed in that class' constructor as a type argument.void
setRenderingHints
(Map hints) Sets the rendering hints to apply to the Graphics2D instance used by the renderer; seeGraphics2D.setRenderingHints(java.util.Map)
.
-
Constructor Details
-
Java2DRenderer
Creates a new instance for a given URL. Does not render until#getImage(int)
is called for the first time.- Parameters:
url
- The location of the document to be rendered.baseurl
- The base url for the document, against which relative paths are resolved.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout.
-
Java2DRenderer
Creates a new instance for a given File. Does not render until#getImage(int)
is called for the first time.- Parameters:
file
- The file to be rendered.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout.height
- Target height, in pixels, for the image- Throws:
IOException
-
Java2DRenderer
Creates a new instance pointing to the given Document. Does not render until#getImage(int)
is called for the first time.- Parameters:
doc
- The document to be rendered.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout.height
- Target height, in pixels, for the image.
-
Java2DRenderer
Creates a new instance for a given File. Does not render until#getImage(int)
is called for the first time.- Parameters:
file
- The file to be rendered.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout. Heght is calculated based on content- Throws:
IOException
-
Java2DRenderer
Renderer for a given URL (which is also used as the base) and a specified width; height is calculated automatically.- Parameters:
url
- The location of the document to be rendered.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout. Heght is calculated based on content
-
Java2DRenderer
Renderer for a given URL and a specified width; height is calculated automatically.- Parameters:
url
- The location of the document to be rendered.baseurl
- The base url for the document, against which relative paths are resolved.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout. Heght is calculated based on content
-
Java2DRenderer
Renderer for a given URL and a specified width; height is calculated automatically.- Parameters:
url
- The location of the document to be rendered.baseurl
- The base url for the document, against which relative paths are resolved.width
- Target width, in pixels, for the image; required to provide horizontal bounds for the layout.height
- Target height, in pixels, for the image
-
-
Method Details
-
setRenderingHints
Sets the rendering hints to apply to the Graphics2D instance used by the renderer; seeGraphics2D.setRenderingHints(java.util.Map)
. The Map need not specify values for all properties; any settings in this map will be applied as override to the default settings, and will not replace the entire Map for the Graphics2D instance.- Parameters:
hints
- values to override in default rendering hints for Graphics2D we are rendering to
-
setBufferedImageType
public void setBufferedImageType(int bufferedImageType) Sets the type for the BufferedImage used as output for this renderer; must be one of the values fromBufferedImage
allowed in that class' constructor as a type argument. See docs for the type parameter inBufferedImage(int, int, int)
. Defaults to RGB with no support for transparency. The type is used when the image is first created, so to change the default type do so before callinggetImage()
.- Parameters:
bufferedImageType
- the BufferedImage type to be used to create the image on which the document will be rendered.
-
getImage
Renders the XML document if necessary and returns the resulting image. If already rendered, same image reference will be returned.#getImage(int)
with the target width.- Returns:
- The XML rendered as a BufferedImage.
-