org.apache.fop.svg
Class SVGDriver


public class SVGDriver

Primary class that drives overall FOP process.

Once this class is instantiated, methods are called to set the Renderer to use, the (possibly multiple) ElementMapping(s) to use and the PrintWriter to use to output the results of the rendering (where applicable). In the case of the Renderer and ElementMapping(s), the Driver may be supplied either with the object itself, or the name of the class, in which case Driver will instantiate the class itself. The advantage of the latter is it enables runtime determination of Renderer and ElementMapping(s).

Once the Driver is set up, the buildFOTree method is called. Depending on whether DOM or SAX is being used, the invocation of the method is either buildFOTree(Document) or buildFOTree(Parser, InputSource) respectively.

A third possibility may be used to build the FO Tree, namely calling getDocumentHandler() and firing the SAX events yourself.

Once the FO Tree is built, the format() and render() methods may be called in that order.

Here is an example use of Driver from CommandLine.java:

Driver driver = new Driver();
driver.setRenderer("org.apache.fop.render.pdf.PDFRenderer", version);
driver.addElementMapping("org.apache.fop.fo.StandardElementMapping");
driver.addElementMapping("org.apache.fop.svg.SVGElementMapping");
driver.setWriter(new PrintWriter(new FileWriter(args[1])));
driver.buildFOTree(parser, fileInputSource(args[0]));
driver.format();
driver.render();

Constructor Summary
SVGDriver()
          create a new Driver

Method Summary
 voidaddElementMapping(ElementMapping mapping)
          add the given element mapping.
 voidaddElementMapping(String mappingClassName)
          add the element mapping with the given class name
 voidaddPropertyList(String listClassName)
          add the element mapping with the given class name
 voidbuildSVGTree(XMLReader parser, InputSource source)
          build the formatting object tree using the given SAX Parser and SAX InputSource
 voidbuildSVGTree(Document document)
          build the formatting object tree using the given DOM Document
 voidformat()
          format the formatting object tree into an area tree
 ContentHandlergetContentHandler()
          return the tree builder (a SAX DocumentHandler).
 SVGDocumentgetSVGDocument()
           

Constructor Detail

SVGDriver

public SVGDriver()
create a new Driver
Method Detail

addElementMapping

public void addElementMapping(ElementMapping mapping)
add the given element mapping. an element mapping maps element names to Java classes

addElementMapping

public void addElementMapping(String mappingClassName)
add the element mapping with the given class name

addPropertyList

public void addPropertyList(String listClassName)
add the element mapping with the given class name

buildSVGTree

public void buildSVGTree(XMLReader parser, InputSource source)
throws org.apache.fop.apps.FOPException
build the formatting object tree using the given SAX Parser and SAX InputSource

buildSVGTree

public void buildSVGTree(Document document)
throws org.apache.fop.apps.FOPException
build the formatting object tree using the given DOM Document

format

public void format()
throws org.apache.fop.apps.FOPException
format the formatting object tree into an area tree

getContentHandler

public ContentHandler getContentHandler()
return the tree builder (a SAX DocumentHandler). used in situations where SAX is used but not via a FOP-invoked SAX parser. A good example is an XSLT engine that fires SAX events but isn't a SAX Parser itself.

getSVGDocument

public SVGDocument getSVGDocument()

Association Links

to Class org.apache.fop.fo.SVGTreeBuilder

the FO tree builder

to Class java.io.PrintWriter

the PrintWriter to use to output the results of the renderer