Package com.dynamicpdf.api

Class MergeOptions

java.lang.Object
com.dynamicpdf.api.MergeOptions
public class MergeOptions extends Object
Represents different options for merging PDF documents.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MergeOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDocumentInfo()
    Gets a boolean indicating whether to import document information when merging.
    boolean
    getDocumentJavaScript()
    Gets a boolean indicating whether to import document level JavaScript when merging.
    boolean
    getDocumentProperties()
    Gets a boolean indicating whether to import document properties when merging.
    boolean
    getEmbeddedFiles()
    Gets a boolean indicating whether to import embedded files when merging.
    boolean
    getFormFields()
    Gets a boolean indicating whether to import form fields when merging.
    boolean
    getFormsXfaData()
    Gets a boolean indicating whether to import XFA form data when merging.
    boolean
    getLogicalStructure()
    Gets a boolean indicating whether to import logical structure (tagging information) when merging.
    boolean
    getOpenAction()
    Gets a boolean indicating whether to import document's opening action (initial page and zoom settings) when merging.
    boolean
    getOptionalContentInfo()
    Gets a boolean indicating whether to import optional content when merging.
    boolean
    getOutlines()
    Gets a boolean indicating whether to import outlines and bookmarks when merging.
    boolean
    getOutputIntent()
    Gets a boolean indicating whether to import OutputIntent when merging.
    boolean
    getPageAnnotations()
    Gets a boolean indicating whether to import PageAnnotations when merging.
    boolean
    getPageLabelsAndSections()
    Gets a boolean indicating whether to import PageLabelsAndSections when merging.
    String
    getRootFormField()
    Gets the root form field for imported form fields.
    boolean
    getXmpMetadata()
    Gets a boolean indicating whether to import XmpMetadata when merging.
    void
    setDocumentInfo​(boolean value)
    Sets a boolean indicating whether to import document information when merging.
    void
    setDocumentJavaScript​(boolean value)
    Sets a boolean indicating whether to import document level JavaScript when merging.
    void
    setDocumentProperties​(boolean value)
    Sets a boolean indicating whether to import document properties when merging.
    void
    setEmbeddedFiles​(boolean value)
    Sets a boolean indicating whether to import embedded files when merging.
    void
    setFormFields​(boolean value)
    Sets a boolean indicating whether to import form fields when merging.
    void
    setFormsXfaData​(boolean value)
    Sets a boolean indicating whether to import XFA form data when merging.
    void
    setLogicalStructure​(boolean value)
    Sets a boolean indicating whether to import logical structure (tagging information) when merging.
    void
    setOpenAction​(boolean value)
    Sets a boolean indicating whether to import document's opening action (initial page and zoom settings) when merging.
    void
    setOptionalContentInfo​(boolean value)
    Sets a boolean indicating whether to import optional content when merging.
    void
    setOutlines​(boolean value)
    Sets a boolean indicating whether to import outlines and bookmarks when merging.
    void
    setOutputIntent​(boolean value)
    Sets a boolean indicating whether to import OutputIntent when merging.
    void
    setPageAnnotations​(boolean value)
    Sets a boolean indicating whether to import PageAnnotations when merging.
    void
    setPageLabelsAndSections​(boolean value)
    Sets a boolean indicating whether to import PageLabelsAndSections when merging.
    void
    setRootFormField​(String value)
    Gets the root form field for imported form fields.
    void
    setXmpMetadata​(boolean value)
    Sets a boolean indicating whether to import XmpMetadata when merging.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MergeOptions

      public MergeOptions()

  • Method Details

    • getDocumentInfo

      public boolean getDocumentInfo()
      Gets a boolean indicating whether to import document information when merging.
      Returns:
      A boolean indicating whether to import document information when merging.

    • setDocumentInfo

      public void setDocumentInfo​(boolean value)
      Sets a boolean indicating whether to import document information when merging.
      Parameters:
      value - A boolean indicating whether to import document information when merging.

    • getDocumentJavaScript

      public boolean getDocumentJavaScript()
      Gets a boolean indicating whether to import document level JavaScript when merging.
      Returns:
      A boolean indicating whether to import document level JavaScript when merging.

    • setDocumentJavaScript

      public void setDocumentJavaScript​(boolean value)
      Sets a boolean indicating whether to import document level JavaScript when merging.
      Parameters:
      value - A boolean indicating whether to import document level JavaScript when merging.

    • getDocumentProperties

      public boolean getDocumentProperties()
      Gets a boolean indicating whether to import document properties when merging.
      Returns:
      A boolean indicating whether to import document properties when merging.

    • setDocumentProperties

      public void setDocumentProperties​(boolean value)
      Sets a boolean indicating whether to import document properties when merging.
      Parameters:
      value - A boolean indicating whether to import document properties when merging.

    • getEmbeddedFiles

      public boolean getEmbeddedFiles()
      Gets a boolean indicating whether to import embedded files when merging.
      Returns:
      A boolean indicating whether to import embedded files when merging.

    • setEmbeddedFiles

      public void setEmbeddedFiles​(boolean value)
      Sets a boolean indicating whether to import embedded files when merging.
      Parameters:
      value - A boolean indicating whether to import embedded files when merging.

    • getFormFields

      public boolean getFormFields()
      Gets a boolean indicating whether to import form fields when merging.
      Returns:
      A boolean indicating whether to import form fields when merging.

    • setFormFields

      public void setFormFields​(boolean value)
      Sets a boolean indicating whether to import form fields when merging.
      Parameters:
      value - A boolean indicating whether to import form fields when merging.

    • getFormsXfaData

      public boolean getFormsXfaData()
      Gets a boolean indicating whether to import XFA form data when merging.
      Returns:
      A boolean indicating whether to import XFA form data when merging.

    • setFormsXfaData

      public void setFormsXfaData​(boolean value)
      Sets a boolean indicating whether to import XFA form data when merging.
      Parameters:
      value - A boolean indicating whether to import XFA form data when merging.

    • getLogicalStructure

      public boolean getLogicalStructure()
      Gets a boolean indicating whether to import logical structure (tagging information) when merging.
      Returns:
      A boolean indicating whether to import logical structure

    • setLogicalStructure

      public void setLogicalStructure​(boolean value)
      Sets a boolean indicating whether to import logical structure (tagging information) when merging.
      Parameters:
      value - A boolean indicating whether to import logical structure

    • getOpenAction

      public boolean getOpenAction()
      Gets a boolean indicating whether to import document's opening action (initial page and zoom settings) when merging.
      Returns:
      A boolean indicating whether to import document's opening

    • setOpenAction

      public void setOpenAction​(boolean value)
      Sets a boolean indicating whether to import document's opening action (initial page and zoom settings) when merging.
      Parameters:
      value - A boolean indicating whether to import document's opening

    • getOptionalContentInfo

      public boolean getOptionalContentInfo()
      Gets a boolean indicating whether to import optional content when merging.
      Returns:
      A boolean indicating whether to import optional content when merging.

    • setOptionalContentInfo

      public void setOptionalContentInfo​(boolean value)
      Sets a boolean indicating whether to import optional content when merging.
      Parameters:
      value - A boolean indicating whether to import optional content when merging.

    • getOutlines

      public boolean getOutlines()
      Gets a boolean indicating whether to import outlines and bookmarks when merging.
      Returns:
      A boolean indicating whether to import outlines and bookmarks when merging.

    • setOutlines

      public void setOutlines​(boolean value)
      Sets a boolean indicating whether to import outlines and bookmarks when merging.
      Parameters:
      value - A boolean indicating whether to import outlines and bookmarks when merging.

    • getOutputIntent

      public boolean getOutputIntent()
      Gets a boolean indicating whether to import OutputIntent when merging.
      Returns:
      A boolean indicating whether to import OutputIntent when merging.

    • setOutputIntent

      public void setOutputIntent​(boolean value)
      Sets a boolean indicating whether to import OutputIntent when merging.
      Parameters:
      value - A boolean indicating whether to import OutputIntent when merging.

    • getPageAnnotations

      public boolean getPageAnnotations()
      Gets a boolean indicating whether to import PageAnnotations when merging.
      Returns:
      A boolean indicating whether to import PageAnnotations when merging.

    • setPageAnnotations

      public void setPageAnnotations​(boolean value)
      Sets a boolean indicating whether to import PageAnnotations when merging.
      Parameters:
      value - A boolean indicating whether to import PageAnnotations when merging.

    • getPageLabelsAndSections

      public boolean getPageLabelsAndSections()
      Gets a boolean indicating whether to import PageLabelsAndSections when merging.
      Returns:
      A boolean indicating whether to import PageLabelsAndSections when merging.

    • setPageLabelsAndSections

      public void setPageLabelsAndSections​(boolean value)
      Sets a boolean indicating whether to import PageLabelsAndSections when merging.
      Parameters:
      value - A boolean indicating whether to import PageLabelsAndSections when merging.

    • getRootFormField

      public String getRootFormField()
      Gets the root form field for imported form fields. Useful when merging a PDF repeatedly to have a better contorl on the form field names.
      Returns:
      The root form field for imported form fields.

    • setRootFormField

      public void setRootFormField​(String value)
      Gets the root form field for imported form fields. Useful when merging a PDF repeatedly to have a better contorl on the form field names.
      Parameters:
      value - The root form field for imported form fields.

    • getXmpMetadata

      public boolean getXmpMetadata()
      Gets a boolean indicating whether to import XmpMetadata when merging.
      Returns:
      A boolean indicating whether to import XmpMetadata when merging.

    • setXmpMetadata

      public void setXmpMetadata​(boolean value)
      Sets a boolean indicating whether to import XmpMetadata when merging.
      Parameters:
      value - A boolean indicating whether to import XmpMetadata when merging.