com.cete.dynamicpdf.merger
Class MergeOptions

java.lang.Object
  |
  +--com.cete.dynamicpdf.merger.MergeOptions

public class MergeOptions

extends java.lang.Object

Currently the only merge option is whether or not to preserve the form fields on the PDF being merged in. Specifying true will keep the form fields on the merged PDF where specifying false will remove the form fields from the PDF.

Licensing:
This class is a DynamicPDF Merger Standard Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Merger Standard Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

MergeOptions()
Initializes a new instance of the MergeOptions class.

MergeOptions(boolean mergeFormFields)
Initializes a new instance of the MergeOptions class.

MergeOptions(boolean mergeFormFields, java.lang.String rootFormField)
Initializes a new instance of the MergeOptions class.

Method Summary

static MergeOptions	getAll() Gets a MergeOptions object with all options set to true.
boolean	getAllOtherData() Gets a value indicating if all other document data should be imported.
static MergeOptions	getAppend() Gets a MergeOptions object that you would typically use when appending documents.
boolean	getDocumentInfo() Gets a value indicating if document information should be imported.
boolean	getDocumentJavaScript() Gets a value indicating if document level JavaScript should be imported.
boolean	getDocumentProperties() Gets a value indicating if document properties should be imported.
boolean	getFormFields() Gets a value indicating if form fields should be imported.
boolean	getFormsXfaData() Gets a value indicating if form XFA data should be imported.
boolean	getMergeFormFields() Deprecated. As of DynamicPDF v4.0.0, replaced by MergeOptions.getFormFields()
static MergeOptions	getNone() Gets a MergeOptions object with all options set to false.
boolean	getOpenAction() Gets a value indicating if the documents openning action (initial page and zoom settings) should be imported.
boolean	getOutlines() Gets a value indicating if outlines and bookmarks should be imported.
boolean	getPageAnnotations() Gets a value indicating if annotations should be imported.
boolean	getPageLabelsAndSections() Gets a value indicating if page labels and sections should be imported.
boolean	getPrepress() Gets a value indicating if prepress data should be imported.
java.lang.String	getRootFormField() Gets the root form field.
Outline	getRootOutline() Gets the root outline for imported outlines.
boolean	getXmpMetadata() Gets a value indicating if Xmp Metadata should be imported.
void	setAllOtherData(boolean value) Sets a value indicating if all other document data should be imported.
void	setDocumentInfo(boolean value) Sets a value indicating if document information should be imported.
void	setDocumentJavaScript(boolean value) Sets a value indicating if document level JavaScript should be imported.
void	setDocumentProperties(boolean value) Sets a value indicating if document properties should be imported.
void	setFormFields(boolean value) Sets a value indicating if form fields should be imported.
void	setFormsXfaData(boolean value) Sets a value indicating if form XFA data should be imported.
void	setMergeFormFields(boolean mergeFormFields) Deprecated. As of DynamicPDF v4.0.0, replaced by MergeOptions.setFormFields(boolean value)
void	setOpenAction(boolean value) Sets a value indicating if the documents openning action (initial page and zoom settings) should be imported.
void	setOutLines(boolean value) Sets a value indicating if outlines and bookmarks should be imported.
void	setPageAnnotations(boolean value) Sets a value indicating if annotations should be imported.
void	setPageLabelsAndSections(boolean value) Sets a value indicating if page labels and sections should be imported.
void	setPrepress(boolean value) Sets a value indicating if prepress data should be imported.
void	setRootFormField(java.lang.String rootFormField) Sets the root form field.
void	setRootOutLine(Outline value) Sets the root outline for imported outlines.
void	setXmpMetaData(boolean value) Sets a value indicating if Xmp Metadata should be imported.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeOptions

public MergeOptions()

Initializes a new instance of the MergeOptions class.

MergeOptions

public MergeOptions(boolean mergeFormFields)

Initializes a new instance of the MergeOptions class.

Parameters:

mergeFormFields - A value indicating if form fields should be merged.

MergeOptions

public MergeOptions(boolean mergeFormFields,
                    java.lang.String rootFormField)

Initializes a new instance of the MergeOptions class.

Parameters:

mergeFormFields - A value indicating if form fields should be merged.

rootFormField - The root form field that all merged form fields will be placed under.

Method Detail

setMergeFormFields

public void setMergeFormFields(boolean mergeFormFields)

Deprecated. As of DynamicPDF v4.0.0, replaced by MergeOptions.setFormFields(boolean value)

Sets a value indicating if form fields should be merged.

Parameters:

mergeFormFields - A value indicating if form fields should be merged.

getMergeFormFields

public boolean getMergeFormFields()

Deprecated. As of DynamicPDF v4.0.0, replaced by MergeOptions.getFormFields()

Gets a value indicating if form fields should be merged.

Returns:

A value indicating if form fields should be merged.

getFormFields

public boolean getFormFields()

Gets a value indicating if form fields should be imported.

Returns:

boolean value indicating if form fields should be imported.

setFormFields

public void setFormFields(boolean value)

Sets a value indicating if form fields should be imported.

Parameters:

value - indicating if form fields should be imported.

getFormsXfaData

public boolean getFormsXfaData()

Gets a value indicating if form XFA data should be imported.

Returns:

boolean value indicating if form XFA data should be imported.

setFormsXfaData

public void setFormsXfaData(boolean value)

Sets a value indicating if form XFA data should be imported.

Parameters:

value - indicating if form XFA data should be imported.

getPageAnnotations

public boolean getPageAnnotations()

Gets a value indicating if annotations should be imported.

Returns:

boolean value indicating if annotations should be imported.

setPageAnnotations

public void setPageAnnotations(boolean value)

Sets a value indicating if annotations should be imported.

Returns:

value indicating if annotations should be imported.

getOutlines

public boolean getOutlines()

Gets a value indicating if outlines and bookmarks should be imported.

Returns:

boolean value indicating if outlines and bookmarks should be imported.

setOutLines

public void setOutLines(boolean value)

Sets a value indicating if outlines and bookmarks should be imported.

Parameters:

value - indicating if outlines and bookmarks should be imported.

getDocumentInfo

public boolean getDocumentInfo()

Gets a value indicating if document information should be imported.

Returns:

boolean value indicating if document information should be imported.

setDocumentInfo

public void setDocumentInfo(boolean value)

Sets a value indicating if document information should be imported.

Parameters:

value - indicating if document information should be imported.

getDocumentProperties

public boolean getDocumentProperties()

Gets a value indicating if document properties should be imported.

Returns:

boolean value indicating if document properties should be imported.

setDocumentProperties

public void setDocumentProperties(boolean value)

Sets a value indicating if document properties should be imported.

Parameters:

value - indicating if document properties should be imported.

getOpenAction

public boolean getOpenAction()

Gets a value indicating if the documents openning action (initial page and zoom settings) should be imported.

Returns:

boolean value indicating if the documents openning action (initial page and zoom settings) should be imported.

setOpenAction

public void setOpenAction(boolean value)

Sets a value indicating if the documents openning action (initial page and zoom settings) should be imported.

Parameters:

value - indicating if the documents openning action (initial page and zoom settings) should be imported.

getAllOtherData

public boolean getAllOtherData()

Gets a value indicating if all other document data should be imported.

Returns:

boolean value indicating if all other document data should be imported.

setAllOtherData

public void setAllOtherData(boolean value)

Sets a value indicating if all other document data should be imported.

Parameters:

value - indicating if all other document data should be imported.

getDocumentJavaScript

public boolean getDocumentJavaScript()

Gets a value indicating if document level JavaScript should be imported.

Returns:

boolean value indicating if document level JavaScript should be imported.

setDocumentJavaScript

public void setDocumentJavaScript(boolean value)

Sets a value indicating if document level JavaScript should be imported.

Parameters:

value - indicating if document level JavaScript should be imported.

getPageLabelsAndSections

public boolean getPageLabelsAndSections()

Gets a value indicating if page labels and sections should be imported.

Returns:

boolean value indicating if page labels and sections should be imported.

setPageLabelsAndSections

public void setPageLabelsAndSections(boolean value)

Sets a value indicating if page labels and sections should be imported.

Parameters:

value - indicating if page labels and sections should be imported.

getXmpMetadata

public boolean getXmpMetadata()

Gets a value indicating if Xmp Metadata should be imported.

Returns:

boolean value indicating if Xmp Metadata should be imported.

setXmpMetaData

public void setXmpMetaData(boolean value)

Sets a value indicating if Xmp Metadata should be imported.

Parameters:

value - indicating if Xmp Metadata should be imported.

getPrepress

public boolean getPrepress()

Gets a value indicating if prepress data should be imported.

Returns:

boolean value indicating if prepress data should be imported.

setPrepress

public void setPrepress(boolean value)

Sets a value indicating if prepress data should be imported.

Parameters:

value - indicating if prepress data should be imported.

getRootOutline

public Outline getRootOutline()

Gets the root outline for imported outlines.

Returns:

Outline the root outline for imported outlines.

setRootOutLine

public void setRootOutLine(Outline value)

Sets the root outline for imported outlines.

Parameters:

value - the root outline for imported outlines.

setRootFormField

public void setRootFormField(java.lang.String rootFormField)

Sets the root form field.

Parameters:

rootFormField - The root form field.

getRootFormField

public java.lang.String getRootFormField()

Gets the root form field.

Returns:

The root form field.

getAll

public static MergeOptions getAll()

Gets a MergeOptions object with all options set to true.

Returns:

MergeOptions object with all options set to true.

getAppend

public static MergeOptions getAppend()

Gets a MergeOptions object that you would typically use when appending documents.

Returns:

MergeOptions object that you would typically use when appending documents.

getNone

public static MergeOptions getNone()

Gets a MergeOptions object with all options set to false.

Returns:

MergeOptions object with all options set to false.