com.realobjects.pdfreactor

Class PDFreactor

java.lang.Object

com.realobjects.pdfreactor.PDFreactor

public class PDFreactor
extends Object

PDFreactor converts HTML and XML documents into PDF or image.

This sample demonstrates the use of PDFreactor:

 PDFreactor pdfReactor = new PDFreactor();
 
 Configuration config = new Configuration();
 
 //required
 config.setDocument("https://www.realobjects.com/");
 // optional
 config.setAddBookmarks(true);
 config.setAddLinks(true);
 
 Result result = pdfReactor.convert(config);
 byte[] pdf = result.getDocument();

Important: On a system without a graphical environment you have to enable the headless mode by setting the appropriate system property. Please see the manual for details.

For more information please have a look at the PDFreactor manual.

Field Summary

Fields

Modifier and Type	Field and Description
static Version	VERSION

Constructor Summary

Constructors

Constructor and Description
PDFreactor()

Method Summary

Modifier and Type	Method and Description
Result	convert(Configuration configuration) Converts the specified Configuration into PDF or image.
Result	convert(Configuration configuration, OutputStream outputStream) Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.
byte[]	convertAsBinary(Configuration configuration) Converts the specified Configuration into PDF or image.
void	convertAsBinary(Configuration configuration, OutputStream outputStream) Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final Version VERSION

Constructor Detail

PDFreactor

public PDFreactor()

Method Detail

convert

public Result convert(Configuration configuration)

Converts the specified Configuration into PDF or image.

Parameters:

configuration - The Configuration.

Returns:

The Result.

Throws:

com.realobjects.pdfreactor.Exceptions.PDFreactorException - If the conversion could not be completed.

convertAsBinary

public byte[] convertAsBinary(Configuration configuration)

Converts the specified Configuration into PDF or image.

Parameters:

configuration - The Configuration.

Returns:

The resulting PDF or image.

Throws:

com.realobjects.pdfreactor.Exceptions.PDFreactorException - If the conversion could not be completed.

convertAsBinary

public void convertAsBinary(Configuration configuration,
                            OutputStream outputStream)

Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.

Parameters:

configuration - The Configuration.

outputStream - The OutputStream to write into.

Throws:

com.realobjects.pdfreactor.Exceptions.PDFreactorException - If the conversion could not be completed.

convert

public Result convert(Configuration configuration,
                      OutputStream outputStream)

Converts the specified Configuration into PDF or image and writes it directly in the supplied OutputStream.

Note that the Result.getDocument() and the Result.getDocumentArray() methods will always return null.

Parameters:

configuration - The Configuration.

outputStream - The OutputStream to write into.

Returns:

The Result.

Throws:

com.realobjects.pdfreactor.Exceptions.PDFreactorException - If the conversion could not be completed.