org.apache.fop.pdf

Class PDFGoToRemote

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)
create an GoToR object.
PDFGoToRemote(PDFFileSpec pdfFileSpec, String dest)
create an GoToR object.
PDFGoToRemote(PDFFileSpec pdfFileSpec, int page)
create an GoToR object.

Method Summary

boolean
equals(Object obj)
Check if this equals another object.
String
getAction()
return the action string which will reference this object
String
toPDFString()

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

getAction

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, toPDFString

Constructor Details

PDFGoToRemote

public PDFGoToRemote(PDFFileSpec pdfFileSpec)
create an GoToR object.
Parameters:
pdfFileSpec - the fileSpec associated with the action

PDFGoToRemote

public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                     String dest)
create an GoToR object.
Parameters:
pdfFileSpec - the fileSpec associated with the action
dest - a named destination within the remote document

PDFGoToRemote

public PDFGoToRemote(PDFFileSpec pdfFileSpec,
                     int page)
create an GoToR object.
Parameters:
pdfFileSpec - the fileSpec associated with the action
page - a page reference within the remote document

Method Details

equals

public boolean equals(Object obj)
Check if this equals another object.
Parameters:
obj - the object to compare
Returns:
true if this equals other object

getAction

public String getAction()
return the action string which will reference this object
Overrides:
getAction in interface PDFAction
Returns:
the action String

toPDFString

public String toPDFString()
Overrides:
toPDFString in interface PDFObject

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.