flex.acrobat.pdf
Class XDPXFAHelper

java.lang.Object
  flex.acrobat.pdf.AbstractHelper
      flex.acrobat.pdf.XFAHelper
          flex.acrobat.pdf.XDPXFAHelper

All Implemented Interfaces:

flex.acrobat.pdf.XFAConstants

public final class XDPXFAHelper
extends XFAHelper

XDPXFAHelper is utility class for manipulating XFA datasets in XDP files containing XFA templates and ultimately saved as a PDF document. XDP based XFA templates require dynamic rendering and as such are only supported by Acrobat Reader 8 (or later).

The XDP must not contain PDF <chunk> elements and must wrap an XFA template shell that specifies the <dynamicRender> element.

An example usage of this class is included below:

 private void importDataset(File template, File generated, Document dataset)
 {
     XDPXFAHelper helper = new XDPXFAHelper();
     helper.open(template);
     helper.importDataset(dataset);
     helper.save(generated);
     helper.close();
     // ...
 }
 

Field Summary

Fields inherited from interface flex.acrobat.pdf.XFAConstants

XFA_DATA_NAMESPACE, XFA_TEMPLATE_NAMESPACE, XFADATA_DATA_QUALIFIED_NODE, XFADATA_DATANODE_ATTR_VALUE, XFADATA_DATANODE_QUALIFIED_ATTR, XFADATA_DATASETS_NODE, XFADATA_DATASETS_QUALIFIED_NODE, XFADATA_PREFIX

Constructor Summary

XDPXFAHelper()
Constructor.

Method Summary

void	open(File file) Opens a raw XDP document that contains an XFA template shell from a file.
void	open(InputStream in) Opens a raw XDP document that contains an XFA template shell from an InputStream.
void	open(String location) Opens a raw XDP document that contains an XFA template shell from a file path location.
void	openFromByteArray(byte[] bytes) Opens a raw XDP document that contains an XFA template shell from a byte array.

Methods inherited from class flex.acrobat.pdf.XFAHelper

close, importDataset, importDataset, save, save, save, saveToByteArray

Methods inherited from class java.lang.Object

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

Constructor Detail

XDPXFAHelper

public XDPXFAHelper()

Constructor.

Method Detail

open

public void open(File file)
          throws IOException

Opens a raw XDP document that contains an XFA template shell from a file. The XDP will be wrapped in a shell PDF so that the parent XFAHelper can manipulate the template.

Overrides:

open in class XFAHelper

Parameters:

file - - a File representing a suitable XDP document.

Throws:

IOException

open

public void open(InputStream in)
          throws IOException

Opens a raw XDP document that contains an XFA template shell from an InputStream. The XDP will be wrapped in a shell PDF so that the parent XFAHelper can manipulate the template.

Overrides:

open in class XFAHelper

Parameters:

in - Any InputStream that will return the bytes representing a suitable XDP document.

Throws:

IOException

open

public void open(String location)
          throws IOException

Opens a raw XDP document that contains an XFA template shell from a file path location. The XDP will be wrapped in a shell PDF so that the parent XFAHelper can manipulate the template.

Overrides:

open in class XFAHelper

Parameters:

location - - a String representing the fully qualified path to a suitable XDP document.

Throws:

IOException

openFromByteArray

public void openFromByteArray(byte[] bytes)

Opens a raw XDP document that contains an XFA template shell from a byte array. The XDP will be wrapped in a shell PDF so that the parent XFAHelper can manipulate the template.

Overrides:

openFromByteArray in class XFAHelper

Parameters:

bytes - An array of bytes representing a suitable XDP document.