|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFLink
class representing an /Annot object of /Subtype /Link
Field Summary | |
static int |
EXTERNAL
Used to represent an external link. |
static int |
INTERNAL
Used to represent an internal link. |
Fields inherited from class org.apache.fop.pdf.PDFObject |
DATE_FORMAT, log |
Constructor Summary | |
PDFLink(java.awt.geom.Rectangle2D r)
create objects associated with a link annotation (GoToR) |
Method Summary | |
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
|
void |
setAction(PDFAction action)
Set the pdf action for this link. |
void |
setStructParent(int structParent)
Sets the value of the StructParent entry for this link. |
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. |
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int EXTERNAL
public static final int INTERNAL
Constructor Detail |
public PDFLink(java.awt.geom.Rectangle2D r)
r
- the rectangle of the link hotspot in absolute coordinatesMethod Detail |
public void setAction(PDFAction action)
action
- the pdf action that is activated for this linkpublic void setStructParent(int structParent)
structParent
- key in the structure parent treepublic java.lang.String toPDFString()
toPDFString
in class PDFObject
protected boolean contentEquals(PDFObject obj)
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 for PDFObject.getObjectID()
.
contentEquals
in class PDFObject
obj
- object to compare to.
|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |