com.aspose.pdf

Class PdfFormatConversionOptions

java.lang.Object

com.aspose.pdf.PdfFormatConversionOptions

public class PdfFormatConversionOptions
extends Object

represents set of options for convert PDF document

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PdfFormatConversionOptions.PuaProcessingStrategy Some PDF documents have special unicode symbols, which are belonged to Private Use Area (PUA), see description at https://en.wikipedia.org/wiki/Private_Use_Areas.
static class	PdfFormatConversionOptions.RemoveFontsStrategy Some documens have large size after converison into PDF/A format.
static class	PdfFormatConversionOptions.SegmentAlignStrategy Describes strategies used to align document text segments.

Field Summary

Fields

Modifier and Type	Field and Description
byte	AlignStrategy Strategy to align text.

Constructor Summary

Constructors

Constructor and Description
PdfFormatConversionOptions(int format) Constructor
PdfFormatConversionOptions(int format, int action) Constructor
PdfFormatConversionOptions(OutputStream outputLogStream, int format, int action) Constructor
PdfFormatConversionOptions(String outputLogFileName, int format) Constructor
PdfFormatConversionOptions(String outputLogFileName, int format, int action) Constructor
PdfFormatConversionOptions(String outputLogFileName, int format, int action, int transparencyAction) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAlignText() This flag controls text alignment in converted document.
static PdfFormatConversionOptions	getDefault() Gets PdfFormatConversionOptions object with default parameters
int	getErrorAction() Action for objects that can not be converted
byte	getExcludeFontsStrategy() Strategy(ies) to exclude superfluous fonts and reduce document file size.
int	getFormat() PDF format.
String	getLogFileName() Path to file where comments will be stored.
OutputStream	getLogStream() Stream where comments will be stored.
boolean	getOptimizeFileSize() Gets or sets a flag which enables/disables special conversion mode to get PDF/A document with reduced file size.
int	getPuaTextProcessingStrategy() Strategy to process symbols from unicode Private Use Area (PUA).
int	getTransparencyAction() Action for image masked objects
boolean	isLowMemoryMode() Is low memory conversion mode enabled
void	setAlignText(boolean value) This flag controls text alignment in converted document.
void	setErrorAction(int value) Action for objects that can not be converted
void	setExcludeFontsStrategy(byte value) Strategy(ies) to exclude superfluous fonts and reduce document file size.
void	setFormat(int value) PDF format.
void	setLogFileName(String value) Path to file where comments will be stored.
void	setLogStream(OutputStream value) Stream where comments will be stored.
void	setLowMemoryMode(boolean value) Is low memory conversion mode enabled
void	setOptimizeFileSize(boolean value) Gets or sets a flag which enables/disables special conversion mode to get PDF/A document with reduced file size.
void	setPuaTextProcessingStrategy(int value) Strategy to process symbols from unicode Private Use Area (PUA).
void	setTransparencyAction(int value) Action for image masked objects

Methods inherited from class java.lang.Object

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

Field Detail

AlignStrategy

public byte AlignStrategy

Strategy to align text. This parameter has sense only when flag AlignText is set to true.

See Also:

PdfFormatConversionOptions.SegmentAlignStrategy

Constructor Detail

PdfFormatConversionOptions

public PdfFormatConversionOptions(String outputLogFileName,
                          int format,
                          int action)

Constructor

Parameters:

outputLogFileName - Path to file where comments will be stored.

format - The pdf format.

action - Action for objects that can not be converted

See Also:

PdfFormat, ConvertErrorAction

PdfFormatConversionOptions

public PdfFormatConversionOptions(String outputLogFileName,
                          int format)

Constructor

Parameters:

outputLogFileName - Path to file where comments will be stored.

format - The pdf format.

See Also:

PdfFormat

PdfFormatConversionOptions

public PdfFormatConversionOptions(int format)

Constructor

Parameters:

format - The pdf format.

See Also:

PdfFormat

PdfFormatConversionOptions

public PdfFormatConversionOptions(int format,
                          int action)

Constructor

Parameters:

format - The pdf format.

action - Action for objects that can not be converted

See Also:

PdfFormat, ConvertErrorAction

PdfFormatConversionOptions

public PdfFormatConversionOptions(String outputLogFileName,
                          int format,
                          int action,
                          int transparencyAction)

Constructor

Parameters:

outputLogFileName - Path to file where comments will be stored.

format - The pdf format.

action - Action for objects that can not be converted

transparencyAction - Action for image masked objects

See Also:

PdfFormat, ConvertErrorAction, ConvertTransparencyAction

PdfFormatConversionOptions

public PdfFormatConversionOptions(OutputStream outputLogStream,
                          int format,
                          int action)

Constructor

Parameters:

outputLogStream - Stream where comments will be stored

format - The pdf format

action - Action for objects that can not be converted

See Also:

PdfFormat, ConvertErrorAction

Method Detail

isLowMemoryMode

public boolean isLowMemoryMode()

Is low memory conversion mode enabled

Returns:

boolean value

setLowMemoryMode

public void setLowMemoryMode(boolean value)

Is low memory conversion mode enabled

Parameters:

value - boolean value

getFormat

public int getFormat()

PDF format.

Returns:

PdfFormat element

See Also:

PdfFormat

setFormat

public void setFormat(int value)

PDF format.

Parameters:

value - PdfFormat element

See Also:

PdfFormat

getLogFileName

public String getLogFileName()

Path to file where comments will be stored.

Returns:

String object

setLogFileName

public void setLogFileName(String value)

Path to file where comments will be stored.

Parameters:

value - String object

getLogStream

public OutputStream getLogStream()

Stream where comments will be stored.

Returns:

OutputStream object

setLogStream

public void setLogStream(OutputStream value)

Stream where comments will be stored.

Parameters:

value - OutputStream object

getErrorAction

public int getErrorAction()

Action for objects that can not be converted

Returns:

ConvertErrorAction element

See Also:

ConvertErrorAction

setErrorAction

public void setErrorAction(int value)

Action for objects that can not be converted

Parameters:

value - ConvertErrorAction element

See Also:

ConvertErrorAction

getTransparencyAction

public int getTransparencyAction()

Action for image masked objects

Returns:

ConvertTransparencyAction element

See Also:

ConvertTransparencyAction

setTransparencyAction

public void setTransparencyAction(int value)

Action for image masked objects

Parameters:

value - ConvertTransparencyAction element

See Also:

ConvertTransparencyAction

getDefault

public static PdfFormatConversionOptions getDefault()

Gets PdfFormatConversionOptions object with default parameters

Returns:

PdfFormatConversionOptions object

getAlignText

public boolean getAlignText()

This flag controls text alignment in converted document. By default document conversion doesn't affect text alignment and leave text as is. But in some cases font substitution causes text overlapping or extra spaces in converted document. When this flag is set special alignment operations will be performed. This flag should be set only for documents which have problems with overlapped text or extra text spaces cause using of this flag decrease performance and in some cases could corrupt text content.

Returns:

boolean value

setAlignText

public void setAlignText(boolean value)

This flag controls text alignment in converted document. By default document conversion doesn't affect text alignment and leave text as is. But in some cases font substitution causes text overlapping or extra spaces in converted document. When this flag is set special alignment operations will be performed. This flag should be set only for documents which have problems with overlapped text or extra text spaces cause using of this flag decrease performance and in some cases could corrupt text content.

Parameters:

value - boolean value

getPuaTextProcessingStrategy

public int getPuaTextProcessingStrategy()

Strategy to process symbols from unicode Private Use Area (PUA).

Returns:

PuaProcessingStrategy element

See Also:

PdfFormatConversionOptions.PuaProcessingStrategy

setPuaTextProcessingStrategy

public void setPuaTextProcessingStrategy(int value)

Strategy to process symbols from unicode Private Use Area (PUA).

Parameters:

value - PuaProcessingStrategy element

See Also:

PdfFormatConversionOptions.PuaProcessingStrategy

getOptimizeFileSize

public boolean getOptimizeFileSize()

Gets or sets a flag which enables/disables special conversion mode to get PDF/A document with reduced file size. Set of this flag and mode could significantly reduce file size but at the same time it could significantly decrease performance of conversion.

setOptimizeFileSize

public void setOptimizeFileSize(boolean value)

Gets or sets a flag which enables/disables special conversion mode to get PDF/A document with reduced file size. Set of this flag and mode could significantly reduce file size but at the same time it could significantly decrease performance of conversion.

getExcludeFontsStrategy

public byte getExcludeFontsStrategy()

Strategy(ies) to exclude superfluous fonts and reduce document file size. This parameter has sense only when flag OptimizeFileSize is set to true. By default combination of strategies SubsetFonts and RemoveDuplicatedFonts is used.

setExcludeFontsStrategy

public void setExcludeFontsStrategy(byte value)

Strategy(ies) to exclude superfluous fonts and reduce document file size. This parameter has sense only when flag OptimizeFileSize is set to true. By default combination of strategies SubsetFonts and RemoveDuplicatedFonts is used.