org.foray.pdf.object
Class PDFDestination

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFDestination

All Implemented Interfaces:

org.axsl.pdf.PdfDestination

public class PDFDestination
extends PDFObject
implements org.axsl.pdf.PdfDestination

A PDF Explicit Destination, a destination that points to a specific page / location / view. An Explicit Destination is by definition an array object. See PDF Reference, 2nd Edition, Section 7.2.1 for more information about PDF Destinations in general, and Explicit Destinations in particular.

Field Summary

Fields inherited from class org.foray.pdf.object.PDFObject

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFDestination(PDFDocument doc, PDFPage page, float xPosition, float yPosition)
Constructor.

Method Summary

void	registerName(String name)
protected String	toPDF() Generates the PDF text necessary to represent the object, returning it as a String.

Methods inherited from class org.foray.pdf.object.PDFObject

bufferToByteArray, byteArrayToStream, getCharsPerLine, getGeneration, getLogger, getNumber, getPDFDocument, output, pdfID, pdfReference, setNumber, stringToByteArray

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFDestination

public PDFDestination(PDFDocument doc,
                      PDFPage page,
                      float xPosition,
                      float yPosition)

Constructor.

Parameters:

doc - The parent PDF document.

page - The page on which the destination exists.

xPosition - The x axis location of the destination on the page.

yPosition - The y axis location of the destination on the page.

Method Detail

toPDF

protected String toPDF()

Description copied from class: PDFObject

Generates the PDF text necessary to represent the object, returning it as a String.

Returns:

The PDF text necessary to represent the object.

registerName

public void registerName(String name)
                  throws org.axsl.pdf.PdfException

Specified by:

registerName in interface org.axsl.pdf.PdfDestination

Throws:

org.axsl.pdf.PdfException