com.itextpdf.kernel.pdf.xobject

Class PdfImageXObject.ImageBytesRetrievalProperties

java.lang.Object

com.itextpdf.kernel.pdf.xobject.PdfImageXObject.ImageBytesRetrievalProperties

Enclosing class:

PdfImageXObject

public static final class PdfImageXObject.ImageBytesRetrievalProperties
extends Object

Manages the steps taken in extracting the image.

Use getApplyFiltersOnly to get the image as close to the stored state as possible. No pixels will be manipulated.

Use getFullOption to get an image as displayed in the document. The full options will be extended in the future to support more color spaces and can lead to different outcomes for some image types.

Method Summary

Modifier and Type	Method and Description
static PdfImageXObject.ImageBytesRetrievalProperties	getApplyFiltersOnly() Create a property set with only the options applyFilters activates.
static PdfImageXObject.ImageBytesRetrievalProperties	getFullOption() Create a property set with all options activated.
boolean	isApplyDecodeArray() Returns whether to apply an images decode transformation or not.
boolean	isApplyFilters() Returns whether to apply the bytestreams filters.
boolean	isApplyTintTransformations() Returns whether tint transformations will be applied.
boolean	isApplyTransparency() Returns whether transparency will be applied to the result.
void	setApplyDecodeArray(boolean applyDecodeArray) Sets whether to apply an image's decode transformation.
void	setApplyFilters(boolean applyFilters) Sets whether to apply the bytestreams filters.
void	setApplyTintTransformations(boolean applyTintTransformations) Sets whether tint transformations will be applied.
void	setApplyTransparency(boolean applyTransparency) Sets whether transparency will be applied to the result.

Methods inherited from class java.lang.Object

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

Method Detail

getApplyFiltersOnly

public static PdfImageXObject.ImageBytesRetrievalProperties getApplyFiltersOnly()

Create a property set with only the options applyFilters activates.

Use this to retrieve images as close to the stored state as possible. No pixels will be manipulated.

Returns:

A property set with only the options applyFilters activated.

getFullOption

public static PdfImageXObject.ImageBytesRetrievalProperties getFullOption()

Create a property set with all options activated.

Use this to retrieve images as closely as possible to how they are being displayed in the document.

Returns:

A property set with all options activated.

isApplyTransparency

public boolean isApplyTransparency()

Returns whether transparency will be applied to the result.

Returns:

Whether transparency will be applied to the result

setApplyTransparency

public void setApplyTransparency(boolean applyTransparency)

Sets whether transparency will be applied to the result.

Parameters:

applyTransparency - set to true to apply transparency.

isApplyDecodeArray

public boolean isApplyDecodeArray()

Returns whether to apply an images decode transformation or not.

An image’s Decode array specifies a linear mapping of each integer component.

Returns:

whether to apply an images decode transformation or not

setApplyDecodeArray

public void setApplyDecodeArray(boolean applyDecodeArray)

Sets whether to apply an image's decode transformation.

An image’s Decode array specifies a linear mapping of each integer component.

Parameters:

applyDecodeArray - whether to apply an images decode transformation

isApplyTintTransformations

public boolean isApplyTintTransformations()

Returns whether tint transformations will be applied.

Some color spaces define application-specific colors. To be able to display these images in an rgb or cmyk color space, there can be tint transformations defined to translate these colors.

Returns:

whether any tint transformations will be applied.

setApplyTintTransformations

public void setApplyTintTransformations(boolean applyTintTransformations)

Sets whether tint transformations will be applied.

Some color spaces define application-specific colors. To be able to display these images in an rgb or cmyk color space, there can be tint transformations defined to translate these colors.

Parameters:

applyTintTransformations - whether to apply tint transformations

isApplyFilters

public boolean isApplyFilters()

Returns whether to apply the bytestreams filters.

Without this option, the other options are disregarded.

Returns:

whether to apply the filters to the byte stream.

setApplyFilters

public void setApplyFilters(boolean applyFilters)

Sets whether to apply the bytestreams filters.

Without this option, the other options are disregarded.

Parameters:

applyFilters - whether to apply the bytestreams filters