public class

DocumentSaveOptions

extends Object
java.lang.Object
   ↳ com.pspdfkit.api.DocumentSaveOptions

Class Overview

Options to be able to customize the document save.

Summary

Nested Classes
class DocumentSaveOptions.Builder A builder to help create the DocumentSaveOptions. 
Public Methods
boolean getApplyRedactionAnnotations()
Gets whether to apply the redaction annotations to the saved document.
boolean getFlattenAnnotations()
Gets whether to save save the document even if unmodified.
boolean getForceSave()
Gets whether to save save the document even if unmodified.
boolean getIncremental()
Gets whether to save incrementally.
void setApplyRedactionAnnotations(boolean applyRedactionAnnotations)
Sets whether to save redaction annotations.
void setFlattenAnnotations(boolean flattenAnnotations)
Sets whether to flatten the annotations into the document or not.
void setForceSave(boolean forceSave)
Forces PSPDFKit to save the document even if unmodified.
void setIncremental(boolean incremental)
Sets whether to save incrementally.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean getApplyRedactionAnnotations ()

Gets whether to apply the redaction annotations to the saved document.

Returns
  • If to apply redaction annotations.

public boolean getFlattenAnnotations ()

Gets whether to save save the document even if unmodified.

Returns
  • If to force save.

public boolean getForceSave ()

Gets whether to save save the document even if unmodified.

Returns
  • If to force save.

public boolean getIncremental ()

Gets whether to save incrementally.

Returns
  • Should save incrementally.

public void setApplyRedactionAnnotations (boolean applyRedactionAnnotations)

Sets whether to save redaction annotations. It is not possible to apply redaction annotations incrementally therefore a full save will be performed.

Parameters
applyRedactionAnnotations If to apply redaction annotations.

public void setFlattenAnnotations (boolean flattenAnnotations)

Sets whether to flatten the annotations into the document or not. If enabled, incremental save will be ignored.

Parameters
flattenAnnotations If to flatten the annotations or not.

public void setForceSave (boolean forceSave)

Forces PSPDFKit to save the document even if unmodified.

Parameters
forceSave Set force save.

public void setIncremental (boolean incremental)

Sets whether to save incrementally. An incremental save will not be performed if setApplyRedactionAnnotations(boolean) or setFlattenAnnotations(boolean) is set.

Parameters
incremental If to save incrementally.