Class PDFImage

java.lang.Object

com.orsonpdf.PDFObject

com.orsonpdf.Stream

com.orsonpdf.PDFImage

public class PDFImage
extends Stream

Represents an image in a PDF document.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	height	The height.
(package private) Image	image	The image.
(package private) String	softMaskImageRef
(package private) int	width	The width.

Constructor Summary

Constructors

Constructor	Description
PDFImage(int number, Image img, String softMaskImageRef)	Creates a new image object.

Method Summary

Modifier and Type	Method	Description
protected Dictionary	createDictionary(int streamLength)	Creates a dictionary reflecting the current configuration for this image.
byte[]	getRawStreamData()	Returns the raw image data.

Methods inherited from class Stream

addFilter, getObjectBytes, removeFilters

Methods inherited from class PDFObject

getGeneration, getNumber, getReference, toPDFBytes

Methods inherited from class Object

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

Field Details

width

int width

The width.

height

int height

The height.

image

Image image

The image.

softMaskImageRef

String softMaskImageRef

Constructor Details

PDFImage

public PDFImage(int number,
 Image img,
 String softMaskImageRef)

Creates a new image object.

Parameters:

number - the PDF object number.

img - the AWT image object (null not permitted).

softMaskImageRef - the soft mask image reference (null permitted).

Method Details

getRawStreamData

public byte[] getRawStreamData()

Returns the raw image data. Each call will resample the image data and populate a new array. Note that the stream may encode this data before it is written to the PDF output.

Specified by:

getRawStreamData in class Stream

Returns:

The raw stream data.

createDictionary

protected Dictionary createDictionary(int streamLength)

Creates a dictionary reflecting the current configuration for this image.

Overrides:

createDictionary in class Stream

Parameters:

streamLength - the stream length.

Returns:

A dictionary.