Package org.apache.fop.pdf
Class PDFLaunch
- java.lang.Object
-
- org.apache.fop.pdf.PDFObject
-
- org.apache.fop.pdf.PDFAction
-
- org.apache.fop.pdf.PDFLaunch
-
- All Implemented Interfaces:
PDFWritable
public class PDFLaunch extends PDFAction
This class represents the /Launch action.
-
-
Field Summary
Fields Modifier and Type Field Description private PDFReference
externalFileSpec
private boolean
newWindow
-
Constructor Summary
Constructors Constructor Description PDFLaunch(PDFFileSpec fileSpec)
Creates a new /Launch action.PDFLaunch(PDFFileSpec fileSpec, boolean newWindow)
Creates a new /Launch action.PDFLaunch(PDFReference fileSpec)
Creates a new /Launch action.
-
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()
represent the action to call this method should be implemented to return the action which gets called by the Link Object.java.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
-
externalFileSpec
private PDFReference externalFileSpec
-
newWindow
private boolean newWindow
-
-
Constructor Detail
-
PDFLaunch
public PDFLaunch(PDFFileSpec fileSpec)
Creates a new /Launch action.- Parameters:
fileSpec
- the file specification to launch
-
PDFLaunch
public PDFLaunch(PDFFileSpec fileSpec, boolean newWindow)
Creates a new /Launch action.- Parameters:
fileSpec
- the file specification to launchnewWindow
- boolean indicating whether the target should be displayed in a new window
-
PDFLaunch
public PDFLaunch(PDFReference fileSpec)
Creates a new /Launch action.- Parameters:
fileSpec
- a reference to the file specification
-
-
Method Detail
-
getAction
public java.lang.String getAction()
represent the action to call this method should be implemented to return the action which gets called by the Link Object. This could be a reference to another object or the specific destination of the link
-
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.
-
-