Package 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 Modifier and Type Field Description private java.lang.String
destination
private boolean
newWindow
private int
pageReference
private PDFReference
pdfFileSpec
the file specification
-
Constructor Summary
Constructors Constructor Description 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.PDFGoToRemote(PDFReference pdfFileSpec, int page, boolean newWindow)
Create an GoToR object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
contentEquals(PDFObject obj)
Check if the other PDFObject has the same content as the current object.java.lang.String
getAction()
return the action string which will reference this objectjava.lang.String
toPDFString()
This method returns a String representation of the PDF object.-
Methods inherited from class org.apache.fop.pdf.PDFAction
encodeScript
-
Methods inherited from class org.apache.fop.pdf.PDFObject
encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getChildren, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF
-
-
-
-
Field Detail
-
pdfFileSpec
private PDFReference pdfFileSpec
the file specification
-
pageReference
private int pageReference
-
destination
private java.lang.String destination
-
newWindow
private boolean newWindow
-
-
Constructor Detail
-
PDFGoToRemote
public PDFGoToRemote(PDFFileSpec pdfFileSpec, boolean newWindow)
Create an GoToR object.- Parameters:
pdfFileSpec
- the fileSpec associated with the actionnewWindow
- 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 actionpage
- a page reference within the remote documentnewWindow
- boolean indicating whether the target should be displayed in a new window
-
PDFGoToRemote
public PDFGoToRemote(PDFReference pdfFileSpec, int page, boolean newWindow)
Create an GoToR object.- Parameters:
pdfFileSpec
- the fileSpec associated with the actionpage
- a page reference within the remote documentnewWindow
- 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 actiondest
- a named destination within the remote documentnewWindow
- 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
-
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 classPDFObject
- Returns:
- String the String representation
-
contentEquals
protected boolean contentEquals(PDFObject obj)
Check if the other PDFObject has the same content as the current object.Note: This function has a contract which is less binding than
Object.equals(Object)
. Whereas equals would require all values to be identical, this method is not required to check everything. In the case of PDFObjects, this means that the overriding function does not have to check forPDFObject.getObjectID()
.- Overrides:
contentEquals
in classPDFObject
- Parameters:
obj
- object to compare to.- Returns:
- true if the other object has the same content.
-
-