er.pdf

Class ERPDFUtilities

java.lang.Object

er.pdf.ERPDFUtilities

public class ERPDFUtilities
extends Object

Method Summary

Modifier and Type	Method and Description
static NSData	htmlAsPdf(String content) Turns a valid XHTML document string and renders it as a PDF document.
static NSData	htmlAsPdf(String content, String encoding) Turns a valid XHTML document string and renders it as a PDF document.
static NSData	htmlAsPdf(String content, String encoding, String urlPrefix) Turns a valid XHTML document string and renders it as a PDF document.
static NSData	htmlAsPdf(String html, String encoding, String urlPrefix, NSDictionary<String,Object> config) Turns a valid XHTML document string and renders it as a PDF document.
static WOActionResults	pageAsPdf(WOElement element) Creates and returns a component that will render the output of the passed wocomponent as a PDF when response generation is invoked.
static WOActionResults	pageAsPdf(WOElement element, NSDictionary<String,Object> config) Creates and returns a page component that will render the output of the passed component as a PDF when appendToResponse() is called.
static NSData	xml2Fop2Pdf(String xml, String fopxsl, NSDictionary<String,Object> config) takes xml as a string and a transform document as a url and transforms it to pdf like freakin' magic.

Methods inherited from class java.lang.Object

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

Method Detail

pageAsPdf

public static WOActionResults pageAsPdf(WOElement element)

Creates and returns a component that will render the output of the passed wocomponent as a PDF when response generation is invoked. Note that the output of the passed component needs to be valid XHTML.

Parameters:

element - the component you want to render as a PDF

Returns:

an element that wraps the passed component and renders the output as a PDF

pageAsPdf

public static WOActionResults pageAsPdf(WOElement element,
                                        NSDictionary<String,Object> config)

Creates and returns a page component that will render the output of the passed component as a PDF when appendToResponse() is called. Note that the output of the passed component needs to be valid XHTML.

Parameters:

element - the component you want to render as a PDF

config - a dictionary of binding values to use to configure the PDFWrapper component and subsequent rending engine. See PDFWrapper for details on available bindings.

Returns:

a component that wraps the passed element and renders the output as a PDF

htmlAsPdf

public static NSData htmlAsPdf(String content)

Turns a valid XHTML document string and renders it as a PDF document.

Parameters:

content - a string containing valid XHTML markup

Returns:

an NSData object containing raw PDF data.

htmlAsPdf

public static NSData htmlAsPdf(String content,
                               String encoding)

Turns a valid XHTML document string and renders it as a PDF document.

Parameters:

content - a string containing valid XHTML markup

encoding - the encoding type used by the html string

Returns:

an NSData object containing raw PDF data.

htmlAsPdf

public static NSData htmlAsPdf(String content,
                               String encoding,
                               String urlPrefix)

Turns a valid XHTML document string and renders it as a PDF document.

Parameters:

content - a string containing valid XHTML markup

encoding - the encoding type used by the html string

urlPrefix - the URL prefix to prepend to unqualified URLs in the html

Returns:

an NSData object containing raw PDF data.

htmlAsPdf

public static NSData htmlAsPdf(String html,
                               String encoding,
                               String urlPrefix,
                               NSDictionary<String,Object> config)

Turns a valid XHTML document string and renders it as a PDF document.

Parameters:

html - a string containing valid XHTML markup

encoding - the encoding type used by the html string

urlPrefix - the URL prefix to prepend to unqualified URLs in the html

config - a dictionary of binding values used to configure the rending engine specified in the "engine" key. See the chosen rendering engine's documentation for available config options.

Returns:

an NSData object containing raw PDF data.

xml2Fop2Pdf

public static NSData xml2Fop2Pdf(String xml,
                                 String fopxsl,
                                 NSDictionary<String,Object> config)
                          throws Throwable

takes xml as a string and a transform document as a url and transforms it to pdf like freakin' magic.

Parameters:

xml - a string of xml to be passed into the transformation process

fopxsl - the location of the xml->fo transform sheet (should be in the classpath)

config - dictionary of additional configuration elements for the fop engine

Returns:

NSData raw pdf file contents

Throws:

Throwable - java.io.IOException