Package com.nomagic.magicreport.format

Class DocBookFormatter

java.lang.Object

com.nomagic.magicreport.format.DefaultFormatter

com.nomagic.magicreport.format.DocBookFormatter

All Implemented Interfaces:

IFormatter

@OpenApiAll
public class DocBookFormatter
extends DefaultFormatter

This class provides implementation for DocBook format output. Extend from DefaultFormatter, this class provide additional support for BufferedImage.

Since:

Jan 30, 2013

Version:

1.0 Jan 30, 2013

Field Summary

Fields inherited from class com.nomagic.magicreport.format.DefaultFormatter

properties, styledDocument

Fields inherited from interface com.nomagic.magicreport.format.IFormatter

DOT_PER_INCH

Constructor Summary

Constructors

Constructor	Description
DocBookFormatter(Properties properties)	Create a HTML formatter with specific properties.

Method Summary

Modifier and Type	Method	Description
protected ITool.RetainedString	createBookmark(Bookmark bookmark)	Create a DocBook bookmark string from given Bookmark object.
protected ITool.RetainedString	createImage(Image image)	Create a DocBook image string from given Image object.
protected ITool.RetainedString	createLink(Link link)	Create a RTF link string from given Link object.
Object	format(Object value)	Convert an Object value into HTML format.

Methods inherited from class com.nomagic.magicreport.format.DefaultFormatter

getImageFlag, getObjectFormater, getProperties, registerObjectFormatter, setProperties, setStyledDocument, writeImage, writeImage, writeImage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocBookFormatter

public DocBookFormatter(Properties properties)

Create a HTML formatter with specific properties.

Parameters:

properties - template properties

Method Details

format

public Object format(Object value)

Convert an Object value into HTML format.

Specified by:

format in interface IFormatter

Overrides:

format in class DefaultFormatter

Parameters:

value - converting value

Returns:

object in default format.

createImage

protected ITool.RetainedString createImage(Image image)
                                    throws IOException

Create a DocBook image string from given Image object.

Parameters:

image - an Image object

Returns:

The String in DocBook image format.

Throws:

IOException - when IO error occurs.

createBookmark

protected ITool.RetainedString createBookmark(Bookmark bookmark)
                                       throws IOException

Create a DocBook bookmark string from given Bookmark object.

Parameters:

bookmark - an Bookmark object

Returns:

The String in DocBook bookmark format.

Throws:

IOException - when IO error occurs

createLink

protected ITool.RetainedString createLink(Link link)
                                   throws IOException

Create a RTF link string from given Link object.

Parameters:

link - an Link object

Returns:

The String in RTF link format.

Throws:

IOException - when IO error occurs