TiffSettings

Inheritance: java.lang.Object, com.aspose.pdf.devices.TiffSettings

public final class TiffSettings extends Object

This class represents settings for importing pdf to Tiff.

Constructors

Constructor	Description
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.
TiffSettings	Initializes a new instance of the {@code TiffSettings} class.

Methods

Method	Description
getBrightness	Get value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1
getCompression	Gets the type of the compression. Value: The type of the compression. Default value is CompressionType.LZW
getCoordinateType	Gets the page coordinate type (Media/Crop boxes). CropBox value is used by default.
getDepth	Gets the color depth. Value: The color depth. Default value is ColorDepth.Default
getIndexedConversionType	Gets the IndexedConversionType. Default value is Simple.
getMargins	Gets the margins.
getShape	Gets the type of the shape. Value: The type of the shape. Default value is ShapeType.None
getSkipBlankPages	Gets a value indicating whether to skip blank pages. Value: {@code true} if need to skip blank pages; otherwise, {@code false}. Default value is false
isUseAlternativeImageEngine	Gets a flag determines whether alternative imaging engine is used or not. True value is used by default for Linux OS. For Windows OS default value is false.
setBrightness	Set value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1
setCompression	Sets the type of the compression. Value: The type of the compression. Default value is CompressionType.LZW
setCoordinateType	Sets the page coordinate type (Media/Crop boxes). CropBox value is used by default.
setDepth	Gets the color depth. Value: The color depth. Default value is ColorDepth.Default
setIndexedConversionType	Sets the IndexedConversionType.
setShape	Sets the type of the shape. Value: The type of the shape. Default value is ShapeType.None
setSkipBlankPages	Sets a value indicating whether to skip blank pages. Value: {@code true} if need to skip blank pages; otherwise, {@code false}. Default value is false
setUseAlternativeImageEngine	Sets a flag determines whether alternative imaging engine is used or not.

TiffSettings

public TiffSettings()

Initializes a new instance of the {@code TiffSettings} class.

TiffSettings

public TiffSettings(boolean skipBlankPages)

Initializes a new instance of the {@code TiffSettings} class.

Parameters:

Parameter	Type	Description
skipBlankPages		if set to {@code true} [skip blank pages].

TiffSettings

Initializes a new instance of the {@code TiffSettings} class.

TiffSettings

Initializes a new instance of the {@code TiffSettings} class.

TiffSettings

Initializes a new instance of the {@code TiffSettings} class.

TiffSettings

Initializes a new instance of the {@code TiffSettings} class.

TiffSettings

Initializes a new instance of the {@code TiffSettings} class.

TiffSettings

Initializes a new instance of the {@code TiffSettings} class.

getBrightness

public float getBrightness()

Get value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1

Returns: float value of brightness should be in the range from 0 to 1. By default value is equal to 0.33f

getCompression

public CompressionType getCompression()

Gets the type of the compression.

Value: The type of the compression.

Default value is CompressionType.LZW

Returns: CompressionType element @see CompressionType

getCoordinateType

public PageCoordinateType getCoordinateType()

Gets the page coordinate type (Media/Crop boxes). CropBox value is used by default.

Returns: PageCoordinateType value @see PageCoordinateType

getDepth

public ColorDepth getDepth()

Gets the color depth.

Value: The color depth.

Default value is ColorDepth.Default

Returns: ColorDepth element @see ColorDepth

getIndexedConversionType

public int getIndexedConversionType()

Gets the IndexedConversionType. Default value is Simple.

Returns: IndexedConversionType element @see IndexedConversionType

getMargins

public Margins getMargins()

Gets the margins.

Returns: Margins object

getShape

public ShapeType getShape()

Gets the type of the shape.

Value: The type of the shape.

Default value is ShapeType.None

Returns: ShapeType element @see ShapeType

getSkipBlankPages

public boolean getSkipBlankPages()

Gets a value indicating whether to skip blank pages.

Value: {@code true} if need to skip blank pages; otherwise, {@code false}.

Default value is false

Returns: boolean value

isUseAlternativeImageEngine

public boolean isUseAlternativeImageEngine()

Gets a flag determines whether alternative imaging engine is used or not. True value is used by default for Linux OS. For Windows OS default value is false.

Returns: boolean value

setBrightness

public void setBrightness(float value)

Set value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1

Parameters:

Parameter	Type	Description
value		: Value of brightness should be in the range from 0 to 1. By default value is equal to 0.33f

setCompression

Sets the type of the compression.

Value: The type of the compression.

Default value is CompressionType.LZW

setCoordinateType

Sets the page coordinate type (Media/Crop boxes). CropBox value is used by default.

setDepth

Gets the color depth.

Value: The color depth.

Default value is ColorDepth.Default

setIndexedConversionType

public void setIndexedConversionType(int value)

Sets the IndexedConversionType.

Parameters:

Parameter	Type	Description
value		IndexedConversionType element @see IndexedConversionType

setShape

Sets the type of the shape.

Value: The type of the shape.

Default value is ShapeType.None

setSkipBlankPages

public void setSkipBlankPages(boolean value)

Sets a value indicating whether to skip blank pages.

Value: {@code true} if need to skip blank pages; otherwise, {@code false}.

Default value is false

Parameters:

Parameter	Type	Description
value		boolean value

setUseAlternativeImageEngine

public void setUseAlternativeImageEngine(boolean useAlternativeImageEngine)

Sets a flag determines whether alternative imaging engine is used or not.

Parameters:

Parameter	Type	Description
useAlternativeImageEngine		boolean value

TiffDevice TiffSettings.IndexedConversionType