PageCopyOptions (4-Heights(R) PDF Toolbox)

java.lang.Object
- com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase
- - com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject
  - - com.pdf_tools.fourheights.pdftoolbox.pdf.PageCopyOptions

public class PageCopyOptions
extends NativeObject

Constructor Summary

Constructors
Constructor and Description

PageCopyOptions()

Constructors
Constructor and Description
`PageCopyOptions()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PageCopyOptions`	`createDynamicObject(long handle)`
`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.
`FormFieldCopyStrategy`	`getFormFields()` Copy strategy for form fields and widgets.
`CopyStrategy`	`getLinks()` Copy strategy for links.
`NamedDestinationCopyStrategy`	`getNamedDestinations()` Copy strategy for named destinations (Getter)
`NameConflictResolution`	`getOcgConflictResolution()` Resolution of conflicting layer (OCC) information.
`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(FormFieldCopyStrategy value)` Copy strategy for form fields and widgets.
`void`	`setLinks(CopyStrategy value)` Copy strategy for links.
`void`	`setNamedDestinations(NamedDestinationCopyStrategy value)` Copy strategy for named destinations (Setter)
`void`	`setOcgConflictResolution(NameConflictResolution value)` Resolution of conflicting layer (OCC) information.
`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.pdf_tools.fourheights.pdftoolbox.internal.NativeObject
equals, hashCode

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PageCopyOptions
```
public PageCopyOptions()
```
- Method Detail
  - createDynamicObject
```
public static PageCopyOptions createDynamicObject(long handle)
```
  - 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 - if value is null
  - getFormFields
```
public FormFieldCopyStrategy getFormFields()
```
    Copy strategy for form fields and widgets. (Getter)
    
    Specifies how form fields and widgets are treated when copying a page.
    
    Default value: forms.FormFieldCopyStrategy.COPY
  - setFormFields
```
public void setFormFields(FormFieldCopyStrategy value)
```
    Copy strategy for form fields and widgets. (Setter)
    
    Specifies how form fields and widgets are treated when copying a page.
    
    Default value: forms.FormFieldCopyStrategy.COPY
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null
  - 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 - if value is null
  - 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 - if value is null
  - 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 products.
    
    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 products.
    
    Default value: CopyStrategy.COPY
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null
  - 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 - if value is null
  - getOcgConflictResolution
```
public NameConflictResolution getOcgConflictResolution()
```
    Resolution of conflicting layer (OCC) information. (Getter)
    
    When copying pages from multiple documents, name conflicts in the layer information (optional content groups, OCG) can occur. This property specifies how such conflicts are resolved.
    
    Default value: NameConflictResolution.MERGE
  - setOcgConflictResolution
```
public void setOcgConflictResolution(NameConflictResolution value)
```
    Resolution of conflicting layer (OCC) information. (Setter)
    
    When copying pages from multiple documents, name conflicts in the layer information (optional content groups, OCG) can occur. This property specifies how such conflicts are resolved.
    
    Default value: NameConflictResolution.MERGE
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null
  - getNamedDestinations
```
public NamedDestinationCopyStrategy getNamedDestinations()
```
    Copy strategy for named destinations (Getter)
    
    Specify whether named destinations are resolved when copying a page.
    
    Default value: navigation.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: navigation.NamedDestinationCopyStrategy.COPY
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null
  - 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 decreases performance.
    
    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 decreases performance.
    
    Default value: true

Class PageCopyOptions

Constructor Summary

Method Summary

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

Methods inherited from class java.lang.Object

Constructor Detail

PageCopyOptions

Method Detail

createDynamicObject

getLinks

Copy strategy for links. (Getter)

setLinks

Copy strategy for links. (Setter)

getFormFields

Copy strategy for form fields and widgets. (Getter)

setFormFields

Copy strategy for form fields and widgets. (Setter)

getSignedSignatures

Removal strategy for signed signature fields. (Getter)

setSignedSignatures

Removal strategy for signed signature fields. (Setter)

getUnsignedSignatures

Copy strategy for unsigned signature fields. (Getter)

setUnsignedSignatures

Copy strategy for unsigned signature fields. (Setter)

getAnnotations

Copy strategy for annotations. (Getter)

setAnnotations

Copy strategy for annotations. (Setter)

getCopyOutlineItems

Copy outline items (bookmarks). (Getter)

setCopyOutlineItems

Copy outline items (bookmarks). (Setter)

getCopyAssociatedFiles

Copy associated files. (Getter)

setCopyAssociatedFiles

Copy associated files. (Setter)

getCopyLogicalStructure

Copy the logical structure and tagging information. (Getter)

setCopyLogicalStructure

Copy the logical structure and tagging information. (Setter)

getFormFieldConflictResolution

Resolution of conflicting form field names. (Getter)

setFormFieldConflictResolution

Resolution of conflicting form field names. (Setter)

getOcgConflictResolution

Resolution of conflicting layer (OCC) information. (Getter)

setOcgConflictResolution

Resolution of conflicting layer (OCC) information. (Setter)

getNamedDestinations

Copy strategy for named destinations (Getter)

setNamedDestinations

Copy strategy for named destinations (Setter)

getOptimizeResources

Find and merge redundant resources. (Getter)

setOptimizeResources

Find and merge redundant resources. (Setter)