gnu.apdf

Class PDFImage

java.lang.Object

gnu.apdf.PDFObject

gnu.apdf.PDFStream

gnu.apdf.PDFImage

All Implemented Interfaces:

Serializable

public class PDFImage
extends PDFStream

This implements the Image XObject. This will usually not be used directly; calling one of the drawBitmap methods of PDFCanvas will use this to put all the necessary code into the pdf file - the image will be encoded in ascii base 85 and deflated in zip format.

Author:

Eric Z. Beard (original version by Peter Mount), Matthew Hreljac, mhreljac@hotmail.com, Jon Sevy, jsevy@cs.drexel.edu

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PDFImage() Creates a new PDFImage instance.
PDFImage(Bitmap bitmap) Create a new PDFImage instance based on the supplied Bitmap.
PDFImage(Bitmap bitmap, int x, int y, int width, int height) Create a new PDFImage instance, based on the subset of the supplied Bitmap at the specified location and with specified size.

Method Summary

Modifier and Type	Method and Description
int	getHeight() Get the value of height.
static String	getRGBString(int p) Converts a pixel color to a hex string
int	getWidth() Get the value of width.
void	setHeight(int v) Set the value of height.
void	setImage(Bitmap bitmap, int x, int y, int w, int h) Set the Bitmap to be embedded, which is the specified subset of the supplied Bitmap.
void	setWidth(int v) Set the value of width.
void	write(OutputStream os) Compression needs to be improved here
void	writeStream(OutputStream os) Writes the image to the stream

Methods inherited from class gnu.apdf.PDFStream

getDeflate, getOutputStream, getStream, getStreamDataString, getWriter, setDeflate

Methods inherited from class gnu.apdf.PDFObject

getGeneration, getName, getPDFDocument, getSerialID, getType, setName, toArray, toString, writeEnd, writeStart

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFImage

public PDFImage()

Creates a new PDFImage instance.

PDFImage

public PDFImage(Bitmap bitmap)

Create a new PDFImage instance based on the supplied Bitmap. This will be positioned at location (0, 0) within the PDFPage it's embedded in.

Parameters:

bitmap - the Bitmap object to embed in the PDF document

PDFImage

public PDFImage(Bitmap bitmap,
                int x,
                int y,
                int width,
                int height)

Create a new PDFImage instance, based on the subset of the supplied Bitmap at the specified location and with specified size.

Parameters:

bitmap - the Bitmap to embed

x - subset bitmap position

y - subset bitmap position

w - subset bitmap width

h - subset bitmap height

Method Detail

getWidth

public int getWidth()

Get the value of width.

Returns:

value of width.

setWidth

public void setWidth(int v)

Set the value of width.

Parameters:

v - Value to assign to width.

getHeight

public int getHeight()

Get the value of height.

Returns:

value of height.

setHeight

public void setHeight(int v)

Set the value of height.

Parameters:

v - Value to assign to height.

setImage

public void setImage(Bitmap bitmap,
                     int x,
                     int y,
                     int w,
                     int h)

Set the Bitmap to be embedded, which is the specified subset of the supplied Bitmap.

Parameters:

bitmap - the Bitmap to embed

x - subset bitmap position

y - subset bitmap position

w - subset bitmap width

h - subset bitmap height

writeStream

public void writeStream(OutputStream os)
                 throws IOException

Writes the image to the stream

Overrides:

writeStream in class PDFStream

Parameters:

os - an OutputStream value

Throws:

IOException - if an error occurs

write

public void write(OutputStream os)
           throws IOException

Compression needs to be improved here

Overrides:

write in class PDFStream

Parameters:

os - OutputStream to send the object to

Throws:

IOException - on error

getRGBString

public static String getRGBString(int p)

Converts a pixel color to a hex string

Parameters:

p - Integer representation of pixel's color

Returns:

a String value giving RGB hex strings concatenated