Package org.xhtmlrenderer.simple


package org.xhtmlrenderer.simple

Includes those classes you need to render XHTML documents quickly, right out of the box, and with no special setup needed; start here! All the classes in this package are oriented towards ease-of-use. You should be able to render documents on screen, convert them to image files and print them with almost no work at all. We'll document the most important classes here; see the individual class documents for details on how to use them in your programs.

All classes in this package are intended for ease-of-use, with no customization required. To render a document quickly, use XHTMLPanel--just instantiate the panel, add it to a scroll pane or FSScrollPane, and call XHTMLPanel.setDocument(Document). You can render from a Document, from a URL, from a file, and from an InputStream.

The Graphics2DRenderer allows you to render XHTML right to image files-- without displaying them onscreen at all. You can use any XHTML/XML/CSS combination and dump it straight to a JPEG, GIF, or other file format supported by the Java image APIs.

FSScrollPane is a JScrollPane with key bindings for scrolling through a document-- just as you would expect from a browsable XHTML document. Drop your XHTMLPanel in a FSScrollPane and your users can move up or down by line or page, and jump to the start or end of the document, just as they are used to.

XHTMLPrintable supports the AWT Printable interface, allowing you to print a document without rendering it onscreen first.

For overviews, tutorials, examples, guides, and tool documentation, please see:
  • Classes
    Class
    Description
    FSScrollPane is a JScrollPane set up to support keyboard navigation of an XHTML/XML document rendered with Flying Saucer.
    Graphics2DRenderer supports headless rendering of XHTML documents, and is useful for rendering documents directly to images.
    ImageRenderer supports rendering of XHTML documents to image formats, writing out the generated image to an output stream or a file in a given image format.
    Handles a general XML document
    XHTMLPanel is a simple Swing component that renders valid XHTML content in a Java program.
    XHTMLPrintable allows you to print XHTML content to a printer instead of rendering it to screen.