PdfTextCompression

Inheritance: java.lang.Object

public class PdfTextCompression

Specifies a type of compression applied to all content in the PDF file except images.

Examples:

Shows how to apply text compression when saving a document to PDF.


 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 for (int i = 0; i < 100; i++)
     builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
             "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions options = new PdfSaveOptions();

 // Set the "TextCompression" property to "PdfTextCompression.None" to not apply any
 // compression to text when we save the document to PDF.
 // Set the "TextCompression" property to "PdfTextCompression.Flate" to apply ZIP compression
 // to text when we save the document to PDF. The larger the document, the bigger the impact that this will have.
 options.setTextCompression(pdfTextCompression);

 doc.save(getArtifactsDir() + "PdfSaveOptions.TextCompression.pdf", options);
 

Fields

FieldDescription
FLATEFlate (ZIP) compression.
NONENo compression.
length

Methods

MethodDescription
fromName(String pdfTextCompressionName)
getName(int pdfTextCompression)
getValues()
toString(int pdfTextCompression)

FLATE

public static int FLATE

Flate (ZIP) compression.

NONE

public static int NONE

No compression.

length

public static int length

fromName(String pdfTextCompressionName)

public static int fromName(String pdfTextCompressionName)

Parameters:

ParameterTypeDescription
pdfTextCompressionNamejava.lang.String

Returns: int

getName(int pdfTextCompression)

public static String getName(int pdfTextCompression)

Parameters:

ParameterTypeDescription
pdfTextCompressionint

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int pdfTextCompression)

public static String toString(int pdfTextCompression)

Parameters:

ParameterTypeDescription
pdfTextCompressionint

Returns: java.lang.String