com.aspose.pdf.devices

Class TiffSettings

java.lang.Object

com.aspose.pdf.devices.TiffSettings

public final class TiffSettings
extends Object

This class represents settings for importing pdf to Tiff.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TiffSettings.IndexedConversionType Class represented indexed conversion types

Constructor Summary

Constructors

Constructor and Description
TiffSettings() Initializes a new instance of the TiffSettings class.
TiffSettings(boolean skipBlankPages) Initializes a new instance of the TiffSettings class.
TiffSettings(int compressionType) Initializes a new instance of the TiffSettings class.
TiffSettings(int compressionType, int colorDepth, Margins margins) Initializes a new instance of the TiffSettings class.
TiffSettings(int compressionType, int colorDepth, Margins margins, boolean skipBlankPages) Initializes a new instance of the TiffSettings class.
TiffSettings(int compressionType, int colorDepth, Margins margins, boolean skipBlankPages, int shapeType) Initializes a new instance of the TiffSettings class.
TiffSettings(Margins margins) Initializes a new instance of the TiffSettings class.

Method Summary

Modifier and Type	Method and Description
float	getBrightness() Get value boundary of the transformation of colors in white and black.
int	getCompression() Gets the type of the compression.
int	getCoordinateType() Gets the page coordinate type (Media/Crop boxes).
int	getDepth() Gets the color depth.
int	getIndexedConversionType() Gets the IndexedConversionType.
Margins	getMargins() Gets the margins.
int	getShape() Gets the type of the shape.
boolean	getSkipBlankPages() Gets a value indicating whether to skip blank pages.
boolean	isUseAlternativeImageEngine() Gets a flag determines whether alternative imaging engine is used or not.
void	setBrightness(float value) Set value boundary of the transformation of colors in white and black.
void	setCompression(int value) Sets the type of the compression.
void	setCoordinateType(int value) Sets the page coordinate type (Media/Crop boxes).
void	setDepth(int value) Gets the color depth.
void	setIndexedConversionType(int value) Sets the IndexedConversionType.
void	setShape(int value) Sets the type of the shape.
void	setSkipBlankPages(boolean value) Sets a value indicating whether to skip blank pages.
void	setUseAlternativeImageEngine(boolean useAlternativeImageEngine) Sets a flag determines whether alternative imaging engine is used or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

TiffSettings

public TiffSettings()

Initializes a new instance of the TiffSettings class.

TiffSettings

public TiffSettings(int compressionType)

Initializes a new instance of the TiffSettings class.

Parameters:

compressionType - Type of the compression.

See Also:

CompressionType

TiffSettings

public TiffSettings(Margins margins)

Initializes a new instance of the TiffSettings class.

Parameters:

margins - The margins.

TiffSettings

public TiffSettings(int compressionType,
                    int colorDepth,
                    Margins margins)

Initializes a new instance of the TiffSettings class.

Parameters:

compressionType - Type of the compression.

colorDepth - The color depth.

margins - The margins.

See Also:

CompressionType

TiffSettings

public TiffSettings(int compressionType,
                    int colorDepth,
                    Margins margins,
                    boolean skipBlankPages)

Initializes a new instance of the TiffSettings class.

Parameters:

compressionType - Type of the compression.

colorDepth - The color depth.

margins - The margins.

skipBlankPages - if set to true need to skip blank pages

See Also:

CompressionType, ColorDepth

TiffSettings

public TiffSettings(int compressionType,
                    int colorDepth,
                    Margins margins,
                    boolean skipBlankPages,
                    int shapeType)

Initializes a new instance of the TiffSettings class.

Parameters:

compressionType - Type of the compression.

colorDepth - The color depth.

margins - The margins.

skipBlankPages - if set to true need to skip blank pages.

shapeType - Type of the shape.

See Also:

CompressionType

TiffSettings

public TiffSettings(boolean skipBlankPages)

Initializes a new instance of the TiffSettings class.

Parameters:

skipBlankPages - if set to true [skip blank pages].

Method Detail

getIndexedConversionType

public int getIndexedConversionType()

Gets the IndexedConversionType. Default value is Simple.

Returns:

IndexedConversionType element

See Also:

TiffSettings.IndexedConversionType

setIndexedConversionType

public void setIndexedConversionType(int value)

Sets the IndexedConversionType.

Parameters:

value - IndexedConversionType element

See Also:

TiffSettings.IndexedConversionType

getMargins

public Margins getMargins()

Gets the margins.

Returns:

Margins object

getSkipBlankPages

public boolean getSkipBlankPages()

Gets a value indicating whether to skip blank pages.

Value: true if need to skip blank pages; otherwise, false.

Default value is false

Returns:

boolean value

setSkipBlankPages

public void setSkipBlankPages(boolean value)

Sets a value indicating whether to skip blank pages.

Value: true if need to skip blank pages; otherwise, false.

Default value is false

Parameters:

value - boolean value

getCompression

public int getCompression()

Gets the type of the compression.

Value: The type of the compression.

Default value is CompressionType.LZW

Returns:

CompressionType element

See Also:

CompressionType

setCompression

public void setCompression(int value)

Sets the type of the compression.

Value: The type of the compression.

Default value is CompressionType.LZW

Parameters:

value - CompressionType element

See Also:

CompressionType

getDepth

public int getDepth()

Gets the color depth.

Value: The color depth.

Default value is ColorDepth.Default

Returns:

ColorDepth element

See Also:

ColorDepth

setDepth

public void setDepth(int value)

Gets the color depth.

Value: The color depth.

Default value is ColorDepth.Default

Parameters:

value - ColorDepth element

See Also:

ColorDepth

getShape

public int getShape()

Gets the type of the shape.

Value: The type of the shape.

Default value is ShapeType.None

Returns:

ShapeType element

See Also:

ShapeType

setShape

public void setShape(int value)

Sets the type of the shape.

Value: The type of the shape.

Default value is ShapeType.None

Parameters:

value - ShapeType element

See Also:

ShapeType

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

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:

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

getCoordinateType

public int getCoordinateType()

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

Returns:

PageCoordinateType value

See Also:

PageCoordinateType

setCoordinateType

public void setCoordinateType(int value)

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

Parameters:

value - PageCoordinateType

See Also:

PageCoordinateType

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

setUseAlternativeImageEngine

public void setUseAlternativeImageEngine(boolean useAlternativeImageEngine)

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

Parameters:

useAlternativeImageEngine - boolean value