com.adobe.icc.ddg.api
Interface DocumentRenderHandler


public interface DocumentRenderHandler

Handler interface to process the document (PDF, by default) rendered for Letter templates.


Field Summary
static int INTERACTIVE_DOCUMENT_HANDLER
           
static int NONINTERACTIVE_DOCUMENT_HANDLER
           
static java.lang.String XDP_KEY
          XDP Template key for preProcessDocument API.
static java.lang.String XML_KEY
          XML Data key for preProcessDocument API.
 
Method Summary
 int getHandlerType()
          Return the type of handler, i.e.
 byte[] postProcessDocument(byte[] inputDocument)
          Process the document before it gets returned to the caller.
 java.util.Map preProcessDocument(byte[] xdpBytes, byte[] xmlBytes)
          Pre-process the XDP and XML bytes of the document to be rendered.
 

Field Detail

INTERACTIVE_DOCUMENT_HANDLER

static final int INTERACTIVE_DOCUMENT_HANDLER
See Also:
Constant Field Values

NONINTERACTIVE_DOCUMENT_HANDLER

static final int NONINTERACTIVE_DOCUMENT_HANDLER
See Also:
Constant Field Values

XDP_KEY

static final java.lang.String XDP_KEY
XDP Template key for preProcessDocument API.

See Also:
Constant Field Values

XML_KEY

static final java.lang.String XML_KEY
XML Data key for preProcessDocument API.

See Also:
Constant Field Values
Method Detail

preProcessDocument

java.util.Map preProcessDocument(byte[] xdpBytes,
                                 byte[] xmlBytes)
Pre-process the XDP and XML bytes of the document to be rendered.

Parameters:
xdpBytes - XDP bytes for the document
xmlBytes - XML data bytes for the document
Returns:
Map of processed XDP and XML bytes, using the "xdpBytes" key for XDP and "xmlBytes" key for XML.

postProcessDocument

byte[] postProcessDocument(byte[] inputDocument)
Process the document before it gets returned to the caller.

Parameters:
inputDocument - the rendered document bytes
Returns:
the processed document bytes

getHandlerType

int getHandlerType()
Return the type of handler, i.e. whether this is a handler for interactive documents (DocumentRenderHandler.INTERACTIVE_DOCUMENT_HANDLER) or non-interactive documents (DocumentRenderHandler.NONINTERACTIVE_DOCUMENT_HANDLER).

Would be used to determine when the handler is to be invoked - when rendering interactive or non-interactive documents.

Returns:
the type of handler


[an error occurred while processing this directive] [an error occurred while processing this directive]