org.apache.fop.pdf

Class PDFLink

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFLink

All Implemented Interfaces:

PDFWritable

public class PDFLink
extends PDFObject

class representing an /Annot object of /Subtype /Link

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
PDFLink(java.awt.geom.Rectangle2D r) create objects associated with a link annotation (GoToR)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Check if this equals another object.
void	setAction(PDFAction action) Set the pdf action for this link.
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

Field Detail

EXTERNAL

public static final int EXTERNAL

Used to represent an external link.

See Also:

Constant Field Values

INTERNAL

public static final int INTERNAL

Used to represent an internal link.

See Also:

Constant Field Values

Constructor Detail

PDFLink

public PDFLink(java.awt.geom.Rectangle2D r)

create objects associated with a link annotation (GoToR)

Parameters:

r - the rectangle of the link hotspot in absolute coordinates

Method Detail

setAction

public void setAction(PDFAction action)

Set the pdf action for this link.

Parameters:

action - the pdf action that is activated for this 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 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