com.itextpdf.kernel.pdf.xobject

Class PdfImageXObject

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfStream>

com.itextpdf.kernel.pdf.xobject.PdfXObject

com.itextpdf.kernel.pdf.xobject.PdfImageXObject

public class PdfImageXObject
extends PdfXObject

A wrapper for Image XObject. ISO 32000-1, 8.9 Images.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PdfImageXObject.ImageBytesRetrievalProperties Manages the steps taken in extracting the image.

Constructor Summary

Constructors

Constructor and Description
PdfImageXObject(ImageData image) Creates Image XObject by image.
PdfImageXObject(ImageData image, PdfImageXObject imageMask) Creates Image XObject by image.
PdfImageXObject(PdfStream pdfStream) Create PdfImageXObject instance by PdfStream.

Method Summary

Modifier and Type	Method and Description
PdfImageXObject	copyTo(PdfDocument document) Copy Image XObject to the specified document.
void	flush() To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e.
BufferedImage	getBufferedImage() Gets image bytes, wrapped with buffered image.
float	getHeight() Gets height of image, Height key.
byte[]	getImageBytes() Gets decoded image bytes.
byte[]	getImageBytes(boolean decoded) Gets image bytes.
byte[]	getImageBytes(PdfImageXObject.ImageBytesRetrievalProperties properties) Gets image bytes.
float	getWidth() Gets width of image, Width key.
String	identifyImageFileExtension() Identifies recommended file extension to store the bytes of this PdfImageXObject.
String	identifyImageFileExtension(PdfImageXObject.ImageBytesRetrievalProperties properties) Identifies recommended file extension to store the bytes of this PdfImageXObject.
ImageType	identifyImageType() Identifies the type of the image that is stored in the bytes of this PdfImageXObject.
ImageType	identifyImageType(PdfImageXObject.ImageBytesRetrievalProperties properties) Identifies the type of the image that is stored in the bytes of this PdfImageXObject.
boolean	isMask() Returns whether this image is a mask that can be used for other images.
boolean	isSoftMask() Returns whether this image is a soft mask that can be used for other images.
PdfImageXObject	put(PdfName key, PdfObject value) Puts the value into Image XObject dictionary and associates it with the specified key.

Methods inherited from class com.itextpdf.kernel.pdf.xobject.PdfXObject

addAssociatedFile, calculateProportionallyFitRectangleWithHeight, calculateProportionallyFitRectangleWithWidth, getAssociatedFiles, isWrappedObjectMustBeIndirect, makeXObject, setLayer

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfImageXObject

public PdfImageXObject(ImageData image)

Creates Image XObject by image.

Parameters:

image - ImageData with actual image data.

PdfImageXObject

public PdfImageXObject(ImageData image,
                       PdfImageXObject imageMask)

Creates Image XObject by image.

Parameters:

image - ImageData with actual image data.

imageMask - PdfImageXObject with image mask.

PdfImageXObject

public PdfImageXObject(PdfStream pdfStream)

Create PdfImageXObject instance by PdfStream. Note, this constructor doesn't perform any additional checks

Parameters:

pdfStream - PdfStream with Image XObject.

See Also:

PdfXObject.makeXObject(PdfStream)

Method Detail

getWidth

public float getWidth()

Gets width of image, Width key.

Overrides:

getWidth in class PdfXObject

Returns:

float value.

getHeight

public float getHeight()

Gets height of image, Height key.

Overrides:

getHeight in class PdfXObject

Returns:

float value.

isMask

public boolean isMask()

Returns whether this image is a mask that can be used for other images.

A mask can hide parts of an image by making those parts fully transparent.

Returns:

whether this image is a mask that can be used for other images

isSoftMask

public boolean isSoftMask()

Returns whether this image is a soft mask that can be used for other images.

A soft mask sets the transparency for an image.

Returns:

whether this image is a soft mask.

flush

public void flush()

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call PdfObjectWrapper.makeIndirect(PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note, that not every wrapper require this, only those that have such warning in documentation.

Overrides:

flush in class PdfObjectWrapper<PdfStream>

copyTo

public PdfImageXObject copyTo(PdfDocument document)

Copy Image XObject to the specified document.

Parameters:

document - target document

Returns:

just created instance of PdfImageXObject.

getBufferedImage

public BufferedImage getBufferedImage()
                               throws IOException

Gets image bytes, wrapped with buffered image.

Returns:

BufferedImage image.

Throws:

IOException - if an error occurs during reading.

getImageBytes

public byte[] getImageBytes()

Gets decoded image bytes.

Returns:

byte array.

getImageBytes

public byte[] getImageBytes(boolean decoded)

Gets image bytes. Note, PdfName.DCTDecode, PdfName.JBIG2Decode and PdfName.JPXDecode filters will be ignored.

Parameters:

decoded - if true, decodes stream bytes.

Returns:

byte array.

getImageBytes

public byte[] getImageBytes(PdfImageXObject.ImageBytesRetrievalProperties properties)

Gets image bytes. Note, PdfName.DCTDecode, PdfName.JBIG2Decode and PdfName.JPXDecode filters will be ignored.

Parameters:

properties - an instance of PdfImageXObject.ImageBytesRetrievalProperties to configure the options.

Returns:

byte array.

identifyImageType

public ImageType identifyImageType()

Identifies the type of the image that is stored in the bytes of this PdfImageXObject. Note that this has nothing to do with the original type of the image. For instance, the return value of this method will never be ImageType.PNG as we lose this information when converting a PNG image into something that can be put into a PDF file. The possible values are: ImageType.JPEG, ImageType.JPEG2000, ImageType.JBIG2, ImageType.TIFF, ImageType.PNG

Returns:

the identified type of image

identifyImageType

public ImageType identifyImageType(PdfImageXObject.ImageBytesRetrievalProperties properties)

Identifies the type of the image that is stored in the bytes of this PdfImageXObject. Note that this has nothing to do with the original type of the image. For instance, the return value of this method will never be ImageType.PNG as we lose this information when converting a PNG image into something that can be put into a PDF file. The possible values are: ImageType.JPEG, ImageType.JPEG2000, ImageType.JBIG2, ImageType.TIFF, ImageType.PNG

Parameters:

properties - an instance of PdfImageXObject.ImageBytesRetrievalProperties to configure the options, these options can influence the type

Returns:

the identified type of image

identifyImageFileExtension

public String identifyImageFileExtension()

Identifies recommended file extension to store the bytes of this PdfImageXObject. Possible values are: 'png', 'jpg', 'jp2', 'tif', 'jbig2'. This extension can later be used together with the result of getImageBytes().

Returns:

a String with recommended file extension

See Also:

identifyImageType(ImageBytesRetrievalProperties)

identifyImageFileExtension

public String identifyImageFileExtension(PdfImageXObject.ImageBytesRetrievalProperties properties)

Identifies recommended file extension to store the bytes of this PdfImageXObject. Possible values are: 'png', 'jpg', 'jp2', 'tif', 'jbig2'. This extension can later be used together with the result of getImageBytes().

Parameters:

properties - an instance of PdfImageXObject.ImageBytesRetrievalProperties to configure the options, * these options can influence the file extension

Returns:

a String with recommended file extension

put

public PdfImageXObject put(PdfName key,
                           PdfObject value)

Puts the value into Image XObject dictionary and associates it with the specified key. If the key is already present, it will override the old value with the specified one.

Parameters:

key - key to insert or to override

value - the value to associate with the specified key

Returns:

object itself.