org.apache.fop.pdf
Class PDFGoToRemote

java.lang.Object
  org.apache.fop.pdf.PDFObject
      org.apache.fop.pdf.PDFAction
          org.apache.fop.pdf.PDFGoToRemote

All Implemented Interfaces:

PDFWritable

public class PDFGoToRemote
extends PDFAction

Class representing a /GoToR object.

Field Summary

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFGoToRemote(PDFFileSpec pdfFileSpec, boolean newWindow)
Create an GoToR object.

PDFGoToRemote(PDFFileSpec pdfFileSpec, int page, boolean newWindow)
create an GoToR object.

PDFGoToRemote(PDFFileSpec pdfFileSpec, java.lang.String dest, boolean newWindow)
create an GoToR object.

Method Summary

boolean	equals(java.lang.Object obj) Check if this equals another object.
java.lang.String	getAction() return the action string which will reference this object
java.lang.String	toPDFString() This method returns a String representation of the PDF object.

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFGoToRemote

public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                     boolean newWindow)

Create an GoToR object.

Parameters:

pdfFileSpec - the fileSpec associated with the action

newWindow - boolean indicating whether the target should be displayed in a new window

PDFGoToRemote

public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                     int page,
                     boolean newWindow)

create an GoToR object.

Parameters:

pdfFileSpec - the fileSpec associated with the action

page - a page reference within the remote document

newWindow - boolean indicating whether the target should be displayed in a new window

PDFGoToRemote

public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                     java.lang.String dest,
                     boolean newWindow)

create an GoToR object.

Parameters:

pdfFileSpec - the fileSpec associated with the action

dest - a named destination within the remote document

newWindow - boolean indicating whether the target should be displayed in a new window

Method Detail

getAction

public java.lang.String getAction()

return the action string which will reference this object

Specified by:

getAction in class PDFAction

Returns:

the action String

toPDFString

public java.lang.String toPDFString()

This method returns a String representation of the PDF object. The result is normally converted/encoded to a byte array by toPDF(). Only use this method to implement the serialization if the object can be fully represented as text. If the PDF representation of the object contains binary content use toPDF() or output(OutputStream) instead. This applies to any object potentially containing a string object because string object are encrypted and therefore need to be binary.

Overrides:

toPDFString in class PDFObject

Returns:

String the String representation

equals

public boolean equals(java.lang.Object obj)

Check if this equals another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare

Returns:

true if this equals other object