gnu.apdf

Class PDFPage

java.lang.Object

gnu.apdf.PDFObject

gnu.apdf.PDFPage

All Implemented Interfaces:

Serializable

public class PDFPage
extends PDFObject
implements Serializable

This class defines a single page within a document. It is linked to a single PDFGraphics object

Author:

Peter T Mount, Eric Z. Beard, ericzbeard@hotmail.com, Gilbert DeLeeuw, gil1@users.sourceforge.net, Jon Sevy, jsevy@cs.drexel.edu

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PDFPage.procset This defines a procset

Constructor Summary

Constructors

Constructor and Description
PDFPage() This constructs a Page object, which will hold any contents for this page.
PDFPage(int orientation) Constructs a page using A4 media, but using the supplied orientation.
PDFPage(PDFPageFormat pageFormat) Constructs a page using the supplied media size and orientation.

Method Summary

Modifier and Type	Method and Description
void	add(PDFObject ob) This adds an object that describes some content to this page.
void	addAnnotation(PDFObject ob) This adds an Annotation to the page.
void	addImageResource(PDFImage object) This adds an image resource to the page.
PDFAnnot	addLink(int x, int y, int w, int h, PDFObject dest) Adds a hyperlink to the document.
PDFAnnot	addLink(int x, int y, int w, int h, PDFObject dest, int vx, int vy, int vw, int vh) Adds a hyperlink to the document.
PDFAnnot	addNote(String note, int x, int y, int w, int h) This method adds a text note to the document.
PDFOutline	addOutline(String title) This method attaches an outline to the current page being generated.
PDFOutline	addOutline(String title, int x, int y, int w, int h) This method attaches an outline to the current page being generated.
void	addPatternResource(PDFPattern object) This adds a pattern resource to the page.
void	addShadingResource(PDFShading object) This adds a shading resource to the page.
void	addToProcset(String proc) Adds to procset.
int	cx(int x, int y) This utility method converts the y coordinate from Java to User space within the page.
int[]	cxy(int x, int y) This utility method converts the Java coordinates to User space within the page.
int	cy(int x, int y) This utility method converts the y coordinate from Java to User space within the page.
PDFCanvas	getCanvas() This returns a PDFGraphics object, which can then be used to render on to this page.
PDFFont	getFont(String type, Typeface typeface) Returns a PDFFont, creating it if not yet used.
Rect	getImageableArea() Gets the imageable area of the page.
int	getOrientation() Returns the pages orientation: PageFormat.PORTRAIT, PageFormat.LANDSACPE or PageFromat.REVERSE_LANDSACPE
PDFPageFormat	getPageFormat() Returns the page's PageFormat.
void	setOrientation(int orientation) Sets the page's orientation.
void	setThumbnail(PDFObject thumbnail) This adds an object that describes a thumbnail for this page.
void	write(OutputStream os) Writes the object to the output stream.

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

PDFPage

public PDFPage()

This constructs a Page object, which will hold any contents for this page.

Once created, it is added to the document via the PDF.add() method. (For Advanced use, via the PDFPages.add() method).

This defaults to a4 media.

PDFPage

public PDFPage(int orientation)

Constructs a page using A4 media, but using the supplied orientation.

Parameters:

orientation - Orientation: 0, 90 or 270

See Also:

PDFPageFormat.PORTRAIT, PDFPageFormat.LANDSCAPE, PDFPageFormat#REVERSE_LANDSCAPE

PDFPage

public PDFPage(PDFPageFormat pageFormat)

Constructs a page using the supplied media size and orientation.

Parameters:

pageFormat - PageFormat describing the page size

Method Detail

addToProcset

public void addToProcset(String proc)

Adds to procset.

Parameters:

proc - the String to be added.

getCanvas

public PDFCanvas getCanvas()

This returns a PDFGraphics object, which can then be used to render on to this page. If a previous PDFGraphics object was used, this object is appended to the page, and will be drawn over the top of any previous objects.

Returns:

a new PDFGraphics object to be used to draw this page.

getFont

public PDFFont getFont(String type,
                       Typeface typeface)

Returns a PDFFont, creating it if not yet used.

Parameters:

type - Font type, usually /Type1

font - Font name

style - java.awt.Font style, ie Font.NORMAL

Returns:

a PDFFont object.

getPageFormat

public PDFPageFormat getPageFormat()

Returns the page's PageFormat.

Returns:

PageFormat describing the page size in device units (72dpi)

getImageableArea

public Rect getImageableArea()

Gets the imageable area of the page.

Returns:

a Rectangle containing the bounds of the imageable area.

setOrientation

public void setOrientation(int orientation)

Sets the page's orientation.

Normally, this should be done when the page is created, to avoid problems.

Parameters:

orientation - a PageFormat orientation constant: PageFormat.PORTRAIT, PageFormat.LANDSACPE or PageFromat.REVERSE_LANDSACPE

getOrientation

public int getOrientation()

Returns the pages orientation: PageFormat.PORTRAIT, PageFormat.LANDSACPE or PageFromat.REVERSE_LANDSACPE

Returns:

current orientation of the page

See Also:

java.awt.PDFPageFormat.PageFormat

add

public void add(PDFObject ob)

This adds an object that describes some content to this page.

Note: Objects that describe contents must be added using this method _AFTER_ the PDF.add() method has been called.

Parameters:

ob - PDFObject describing some contents

addAnnotation

public void addAnnotation(PDFObject ob)

This adds an Annotation to the page.

As with other objects, the annotation must be added to the pdf document using PDF.add() before adding to the page.

Parameters:

ob - Annotation to add.

addNote

public PDFAnnot addNote(String note,
                        int x,
                        int y,
                        int w,
                        int h)

This method adds a text note to the document.

Parameters:

note - Text of the note

x - Coordinate of note

y - Coordinate of note

w - Width of the note

h - Height of the note

Returns:

Returns the annotation, so other settings can be changed.

addLink

public PDFAnnot addLink(int x,
                        int y,
                        int w,
                        int h,
                        PDFObject dest)

Adds a hyperlink to the document.

Parameters:

x - Coordinate of active area

y - Coordinate of active area

w - Width of the active area

h - Height of the active area

dest - Page that will be displayed when the link is activated. When displayed, the zoom factor will be changed to fit the display.

Returns:

Returns the annotation, so other settings can be changed.

addLink

public PDFAnnot addLink(int x,
                        int y,
                        int w,
                        int h,
                        PDFObject dest,
                        int vx,
                        int vy,
                        int vw,
                        int vh)

Adds a hyperlink to the document.

Parameters:

x - Coordinate of active area

y - Coordinate of active area

w - Width of the active area

h - Height of the active area

dest - Page that will be displayed when the link is activated

vx - Coordinate of view area

vy - Coordinate of view area

vw - Width of the view area

vh - Height of the view area

Returns:

Returns the annotation, so other settings can be changed.

addImageResource

public void addImageResource(PDFImage object)

This adds an image resource to the page.

Parameters:

resourceName - the XObject resource to be added.

addPatternResource

public void addPatternResource(PDFPattern object)

This adds a pattern resource to the page.

Parameters:

resourceName - the XObject resource to be added.

addShadingResource

public void addShadingResource(PDFShading object)

This adds a shading resource to the page.

Parameters:

resourceName - the XObject resource to be added.

setThumbnail

public void setThumbnail(PDFObject thumbnail)

This adds an object that describes a thumbnail for this page.

Note: The object must already exist in the PDF, as only the object ID is stored.

Parameters:

thumbnail - PDFObject containing the thumbnail

addOutline

public PDFOutline addOutline(String title)

This method attaches an outline to the current page being generated. When selected, the outline displays the top of the page.

Parameters:

title - Outline title to attach

Returns:

PDFOutline object created, for addSubOutline if required.

addOutline

public PDFOutline addOutline(String title,
                             int x,
                             int y,
                             int w,
                             int h)

This method attaches an outline to the current page being generated. When selected, the outline displays the top of the page.

Note: If the outline is not in the top level (ie below another outline) then it must not be passed to this method.

Parameters:

title - Outline title to attach

x - Left coordinate of region

y - Bottom coordinate of region

w - Width of region

h - Height coordinate of region

Returns:

PDFOutline object created, for addSubOutline if required.

write

public void write(OutputStream os)
           throws IOException

Description copied from class: PDFObject

Writes the object to the output stream. This method must be overidden.

Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine.

Specified by:

write in class PDFObject

Parameters:

os - OutputStream to send the object to

Throws:

IOException - on error

cy

public int cy(int x,
              int y)

This utility method converts the y coordinate from Java to User space within the page.

Parameters:

x - Coordinate in Java space

y - Coordinate in Java space

Returns:

y Coordinate in User space

cx

public int cx(int x,
              int y)

This utility method converts the y coordinate from Java to User space within the page.

Parameters:

x - Coordinate in Java space

y - Coordinate in Java space

Returns:

x Coordinate in User space

cxy

public int[] cxy(int x,
                 int y)

This utility method converts the Java coordinates to User space within the page.

Parameters:

x - Coordinate in Java space

y - Coordinate in Java space

Returns:

array containing the x & y Coordinate in User space