Class PageCopyOptions
- java.lang.Object
-
- com.pdftools.internal.NativeBase
-
- com.pdftools.internal.NativeObject
-
- com.pdftools.documentassembly.PageCopyOptions
-
public class PageCopyOptions extends NativeObject
This class determines whether and how different PDF elements are copied.
-
-
Constructor Summary
Constructors Constructor Description PageCopyOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CopyStrategy
getAnnotations()
Copy strategy for annotations.boolean
getCopyAssociatedFiles()
Copy associated files.boolean
getCopyLogicalStructure()
Copy the logical structure and tagging information.boolean
getCopyOutlineItems()
Copy outline items (bookmarks).NameConflictResolution
getFormFieldConflictResolution()
Resolution of conflicting form field names.CopyStrategy
getFormFields()
Copy strategy for form fields.CopyStrategy
getLinks()
Copy strategy for links.NamedDestinationCopyStrategy
getNamedDestinations()
Copy strategy for named destinations (Getter)boolean
getOptimizeResources()
Find and merge redundant resources.RemovalStrategy
getSignedSignatures()
Removal strategy for signed signature fields.CopyStrategy
getUnsignedSignatures()
Copy strategy for unsigned signature fields.void
setAnnotations(CopyStrategy value)
Copy strategy for annotations.void
setCopyAssociatedFiles(boolean value)
Copy associated files.void
setCopyLogicalStructure(boolean value)
Copy the logical structure and tagging information.void
setCopyOutlineItems(boolean value)
Copy outline items (bookmarks).void
setFormFieldConflictResolution(NameConflictResolution value)
Resolution of conflicting form field names.void
setFormFields(CopyStrategy value)
Copy strategy for form fields.void
setLinks(CopyStrategy value)
Copy strategy for links.void
setNamedDestinations(NamedDestinationCopyStrategy value)
Copy strategy for named destinations (Setter)void
setOptimizeResources(boolean value)
Find and merge redundant resources.void
setSignedSignatures(RemovalStrategy value)
Removal strategy for signed signature fields.void
setUnsignedSignatures(CopyStrategy value)
Copy strategy for unsigned signature fields.-
Methods inherited from class com.pdftools.internal.NativeObject
equals, hashCode
-
-
-
-
Method Detail
-
getLinks
public CopyStrategy getLinks()
Copy strategy for links. (Getter)
Specifies how links (document internal and external links) are treated when copying a page.
Default value:
CopyStrategy.COPY
-
setLinks
public void setLinks(CopyStrategy value)
Copy strategy for links. (Setter)
Specifies how links (document internal and external links) are treated when copying a page.
Default value:
CopyStrategy.COPY
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getFormFields
public CopyStrategy getFormFields()
Copy strategy for form fields. (Getter)
Specifies how form fields are treated when copying a page.
Default value:
CopyStrategy.COPY
-
setFormFields
public void setFormFields(CopyStrategy value)
Copy strategy for form fields. (Setter)
Specifies how form fields are treated when copying a page.
Default value:
CopyStrategy.COPY
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getSignedSignatures
public RemovalStrategy getSignedSignatures()
Removal strategy for signed signature fields. (Getter)
Signed digital signatures are always invalidated when copying a page and therefore have to be removed. This property specifies, whether the visual representation of the signature is preserved.
Default value:
RemovalStrategy.REMOVE
-
setSignedSignatures
public void setSignedSignatures(RemovalStrategy value)
Removal strategy for signed signature fields. (Setter)
Signed digital signatures are always invalidated when copying a page and therefore have to be removed. This property specifies, whether the visual representation of the signature is preserved.
Default value:
RemovalStrategy.REMOVE
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getUnsignedSignatures
public CopyStrategy getUnsignedSignatures()
Copy strategy for unsigned signature fields. (Getter)
Specifies how signature fields are treated, that are not yet signed.
Default value:
CopyStrategy.COPY
-
setUnsignedSignatures
public void setUnsignedSignatures(CopyStrategy value)
Copy strategy for unsigned signature fields. (Setter)
Specifies how signature fields are treated, that are not yet signed.
Default value:
CopyStrategy.COPY
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getAnnotations
public CopyStrategy getAnnotations()
Copy strategy for annotations. (Getter)
Specifies how interactive annotations (like sticky notes or text highlights) are treated when copying a page. This does not include links, form fields and signature fields which are not considered annotations in this product.
Default value:
CopyStrategy.COPY
-
setAnnotations
public void setAnnotations(CopyStrategy value)
Copy strategy for annotations. (Setter)
Specifies how interactive annotations (like sticky notes or text highlights) are treated when copying a page. This does not include links, form fields and signature fields which are not considered annotations in this product.
Default value:
CopyStrategy.COPY
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getCopyOutlineItems
public boolean getCopyOutlineItems()
Copy outline items (bookmarks). (Getter)
Specifies whether outline items (also known as bookmarks) pointing to the copied page should be copied to the target document automatically.
Default value:
true
-
setCopyOutlineItems
public void setCopyOutlineItems(boolean value)
Copy outline items (bookmarks). (Setter)
Specifies whether outline items (also known as bookmarks) pointing to the copied page should be copied to the target document automatically.
Default value:
true
-
getCopyAssociatedFiles
public boolean getCopyAssociatedFiles()
Copy associated files. (Getter)
Specifies whether embedded files associated with a page or any of its subobjects are also copied when copying the page.
Default value:
true
-
setCopyAssociatedFiles
public void setCopyAssociatedFiles(boolean value)
Copy associated files. (Setter)
Specifies whether embedded files associated with a page or any of its subobjects are also copied when copying the page.
Default value:
true
-
getCopyLogicalStructure
public boolean getCopyLogicalStructure()
Copy the logical structure and tagging information. (Getter)
Specifies whether the logical structure and tagging information associated with a page or its content is also copied when copying the page.
This is required if the target document conformance is PDF/A Level a.
Default value:
true
-
setCopyLogicalStructure
public void setCopyLogicalStructure(boolean value)
Copy the logical structure and tagging information. (Setter)
Specifies whether the logical structure and tagging information associated with a page or its content is also copied when copying the page.
This is required if the target document conformance is PDF/A Level a.
Default value:
true
-
getFormFieldConflictResolution
public NameConflictResolution getFormFieldConflictResolution()
Resolution of conflicting form field names. (Getter)
Form field of different files can have the same name (identifier). This property specifies how name conflicts are resolved, when copying pages from multiple source files.
Default value:
NameConflictResolution.MERGE
-
setFormFieldConflictResolution
public void setFormFieldConflictResolution(NameConflictResolution value)
Resolution of conflicting form field names. (Setter)
Form field of different files can have the same name (identifier). This property specifies how name conflicts are resolved, when copying pages from multiple source files.
Default value:
NameConflictResolution.MERGE
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getNamedDestinations
public NamedDestinationCopyStrategy getNamedDestinations()
Copy strategy for named destinations (Getter)
Specify whether named destinations are resolved when copying a page.
Default value:
NamedDestinationCopyStrategy.COPY
-
setNamedDestinations
public void setNamedDestinations(NamedDestinationCopyStrategy value)
Copy strategy for named destinations (Setter)
Specify whether named destinations are resolved when copying a page.
Default value:
NamedDestinationCopyStrategy.COPY
- Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
-
getOptimizeResources
public boolean getOptimizeResources()
Find and merge redundant resources. (Getter)
Find and merge redundant resources such as fonts and images. This can lead to much smaller files, especially when copying pages from multiple similar source files. However, it also results in longer processing time.
Default value:
true
-
setOptimizeResources
public void setOptimizeResources(boolean value)
Find and merge redundant resources. (Setter)
Find and merge redundant resources such as fonts and images. This can lead to much smaller files, especially when copying pages from multiple similar source files. However, it also results in longer processing time.
Default value:
true
-
-