er.pdf

Class ERPDFWrapper

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.pdf.ERPDFWrapper

All Implemented Interfaces:

WOActionResults

Direct Known Subclasses:

ERFOPWrapper

public class ERPDFWrapper
extends ERXDynamicElement
implements WOActionResults

ERPDFWrapper will render the containing component content as a PDF document. The contained content must be valid XHTML markup suitable for processing by the chosen rendering engine. ERPDFWrapper is intended to be the outer most element on the page and should not have any trailing content or whitespace after the closing tag.

Author:

sharpy, q

Bindings

Name	Description
secure	true if HTTPS should be used for unqualified URLs in the HTML, defaults to the request type
enabled	true if a PDF should be created instead of HTML during appendToResponse phase defaults to true
filename	the filename on the client, defaults to result.pdf
fonts	(optional) array of font filenames to include for PDF generation
framework	(optional) framework name where font files are
additionalPDFs	(optional) array of PDF filenames to append to the generated PDF

Nested Class Summary

Nested classes/interfaces inherited from class er.extensions.components.ERXDynamicElement

ERXDynamicElement.ContextData<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected WOElement	_component

Fields inherited from class er.extensions.components.ERXDynamicElement

log

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
ERPDFWrapper(String name, NSDictionary<String,WOAssociation> associations, WOElement template)

Method Summary

Modifier and Type	Method and Description
protected NSData	appendPDFs(NSData data, WOContext context) Appends PDFs that have been denoted by the additionalPDFs binding to the current PDF data object.
void	appendToResponse(WOResponse response, WOContext context)
WOResponse	generateResponse()
protected NSData	responseAsPdf(WOResponse response, WOContext context)

Methods inherited from class er.extensions.components.ERXDynamicElement

afterProcessing, appendTagAttributeToResponse, arrayValueForBinding, arrayValueForBinding, associations, beforeProcessing, bindingIsSettable, bindingNamed, booleanValueForBinding, booleanValueForBinding, hasBinding, id, integerValueForBinding, nameInContext, secureInContext, setValueForBinding, stringValueForBinding, stringValueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeAction, invokeChildrenAction, takeChildrenValuesFromRequest, takeValuesFromRequest, toString

Methods inherited from class java.lang.Object

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

Field Detail

_component

protected WOElement _component

Constructor Detail

ERPDFWrapper

public ERPDFWrapper(String name,
                    NSDictionary<String,WOAssociation> associations,
                    WOElement template)

Method Detail

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Overrides:

appendToResponse in class com.webobjects.appserver._private.WODynamicGroup

responseAsPdf

protected NSData responseAsPdf(WOResponse response,
                               WOContext context)

appendPDFs

protected NSData appendPDFs(NSData data,
                            WOContext context)

Appends PDFs that have been denoted by the additionalPDFs binding to the current PDF data object.

Parameters:

data - the current PDF data object

context - context of the transaction

Returns:

PDF data with appended PDFs or the unaltered data object if no files were given to append

generateResponse

public WOResponse generateResponse()

Specified by:

generateResponse in interface WOActionResults