sfi.director.application.autodoc.FormatHandler Class Reference

Documentation format handler. More...

Inheritance diagram for sfi.director.application.autodoc.FormatHandler:

Public Member Functions
abstract void	generate (String filename, DocBuilder builder) throws DirectorException, IOException
	generate document
void	fromTemplate (OutputStream target, String tmplName, Hashtable vars) throws DirectorException,IOException
void	fromStrictTemplate (OutputStream target, String tmplName, Hashtable vars) throws DirectorException,IOException
void	fromStrictTemplate (OutputStream target, File tmplFile, Hashtable vars) throws DirectorException,IOException

Protected Member Functions
File	templatefile (String filename)
	Helper function - return a file within the doctemplates dir.

Protected Attributes
String	outEncoding = System.getProperty( "file.encoding" )

Detailed Description

Documentation format handler.

Generates a document in the respective target format from a DocBuilder object.

Member Function Documentation

void sfi.director.application.autodoc.FormatHandler.fromStrictTemplate	(	OutputStream	target,
		String	tmplName,
		Hashtable	vars
	)		throws DirectorException,IOException

References sfi.director.application.autodoc.FormatHandler.templatefile().

Referenced by sfi.director.application.autodoc.FormatLaTeX.generateLaTeX(), and sfi.director.application.autodoc.FormatODF.generateODF().

void sfi.director.application.autodoc.FormatHandler.fromStrictTemplate	(	OutputStream	target,
		File	tmplFile,
		Hashtable	vars
	)		throws DirectorException,IOException

References sfi.director.application.autodoc.FormatHandler.outEncoding.

void sfi.director.application.autodoc.FormatHandler.fromTemplate	(	OutputStream	target,
		String	tmplName,
		Hashtable	vars
	)		throws DirectorException,IOException

References sfi.director.application.autodoc.FormatHandler.templatefile().

Referenced by sfi.director.application.autodoc.Formatsplithtml.generateHTML(), and sfi.director.application.autodoc.Formathtml.generateHTML().

abstract void sfi.director.application.autodoc.FormatHandler.generate ( String  filename, DocBuilder  builder  ) throws DirectorException, IOException

pure virtual

generate document

Implemented in sfi.director.application.autodoc.FormatLaTeX, sfi.director.application.autodoc.FormatODF, sfi.director.application.autodoc.Formathtml, sfi.director.application.autodoc.Formatsdep, and sfi.director.application.autodoc.Formatraw.

Referenced by sfi.director.application.autodoc.DocBuilder.generate().

File sfi.director.application.autodoc.FormatHandler.templatefile ( String  filename )

protected

Helper function - return a file within the doctemplates dir.

References sfi.director.util.Setup.fileSeparator, and sfi.director.util.Setup.rootDir.

Referenced by sfi.director.application.autodoc.FormatHandler.fromStrictTemplate(), sfi.director.application.autodoc.FormatHandler.fromTemplate(), sfi.director.application.autodoc.FormatODF.generate(), sfi.director.application.autodoc.Formatsplithtml.generateHTML(), and sfi.director.application.autodoc.Formathtml.generateHTML().

Member Data Documentation

String sfi.director.application.autodoc.FormatHandler.outEncoding = System.getProperty( "file.encoding" )

protected

Referenced by sfi.director.application.autodoc.FormatHandler.fromStrictTemplate(), sfi.director.application.autodoc.FormatLaTeX.generateLaTeX(), and sfi.director.application.autodoc.FormatODF.generateODF().

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/application/autodoc/FormatHandler.java