org.foray.pdf.object
Class PDFGoToRemote

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFAction
          org.foray.pdf.object.PDFGoToRemote

public class PDFGoToRemote
extends PDFAction

class representing a /GoToR object.

Field Summary

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

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFGoToRemote(PDFDocument doc, PDFFileSpec pdfFileSpec)
Create a GoToR object.

PDFGoToRemote(PDFDocument doc, PDFFileSpec pdfFileSpec, int page)
Create a GoToR object for a specific page in a remote document.

PDFGoToRemote(PDFDocument doc, PDFFileSpec pdfFileSpec, String dest)
Create a GoToR object for a named destination in a remote object.

Method Summary

String	getAction() Return the action string which will reference this object.
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

PDFGoToRemote

public PDFGoToRemote(PDFDocument doc,
                     PDFFileSpec pdfFileSpec)

Create a GoToR object.

Parameters:

doc - The parent PDF document.

pdfFileSpec - the fileSpec associated with the action

PDFGoToRemote

public PDFGoToRemote(PDFDocument doc,
                     PDFFileSpec pdfFileSpec,
                     int page)

Create a GoToR object for a specific page in a remote document.

Parameters:

doc - The parent PDF document.

pdfFileSpec - The fileSpec associated with the action.

page - A page reference within the remote document.

PDFGoToRemote

public PDFGoToRemote(PDFDocument doc,
                     PDFFileSpec pdfFileSpec,
                     String dest)

Create a GoToR object for a named destination in a remote object.

Parameters:

doc - The parent PDF document.

pdfFileSpec - The fileSpec associated with the action.

dest - A named destination within the remote document.

Method Detail

getAction

public String getAction()

Return the action string which will reference this object.

Specified by:

getAction in class PDFAction

Returns:

the action String

toPDF

public 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.