Package com.itextpdf.text.pdf

Class PdfImage

java.lang.Object

com.itextpdf.text.pdf.PdfObject

com.itextpdf.text.pdf.PdfDictionary

com.itextpdf.text.pdf.PdfStream

com.itextpdf.text.pdf.PdfImage

All Implemented Interfaces:

Serializable

public class PdfImage
extends PdfStream

PdfImage is a PdfStream containing an image-Dictionary and -stream.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Image	image
protected PdfName	name	This is the PdfName of the image.
(package private) static final int	TRANSFERSIZE

Fields inherited from class com.itextpdf.text.pdf.PdfStream

BEST_COMPRESSION, BEST_SPEED, compressed, compressionLevel, DEFAULT_COMPRESSION, ENDSTREAM, inputStream, inputStreamLength, NO_COMPRESSION, rawLength, ref, SIZESTREAM, STARTSTREAM, streamBytes, writer

Fields inherited from class com.itextpdf.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class com.itextpdf.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfImage(Image image, String name, PdfIndirectReference maskRef)	Constructs a PdfImage-object.

Method Summary

Modifier and Type	Method	Description
private void	generateImgResName(Image img)	Called when no resource name is provided in our constructor.
Image	getImage()
protected void	importAll(PdfImage dup)
PdfName	name()	Returns the PdfName of the image.
(package private) static void	transferBytes(InputStream in, OutputStream out, int len)

Methods inherited from class com.itextpdf.text.pdf.PdfStream

flateCompress, flateCompress, getRawLength, superToPdf, toPdf, toString, writeContent, writeLength

Methods inherited from class com.itextpdf.text.pdf.PdfDictionary

checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size

Methods inherited from class com.itextpdf.text.pdf.PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class java.lang.Object

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

Field Details

TRANSFERSIZE

static final int TRANSFERSIZE

See Also:

• Constant Field Values

name

protected PdfName name

This is the PdfName of the image.

image

protected Image image

Constructor Details

PdfImage

public PdfImage(Image image,
 String name,
 PdfIndirectReference maskRef)
         throws BadPdfFormatException

Constructs a PdfImage-object.

Parameters:

image - the Image-object

name - the PdfName for this image

Throws:

BadPdfFormatException - on error

Method Details

name

public PdfName name()

Returns the PdfName of the image.

Returns:

the name

getImage

public Image getImage()

transferBytes

static void transferBytes(InputStream in,
 OutputStream out,
 int len)
                   throws IOException

Throws:

IOException

importAll

protected void importAll(PdfImage dup)

generateImgResName

private void generateImgResName(Image img)

Called when no resource name is provided in our constructor. This generates a name that is required to be unique within a given resource dictionary.

Since:

5.0.1