org.apache.fop.pdf

Class PDFLink

Implemented Interfaces:
PDFWritable

public class PDFLink
extends PDFObject

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(Rectangle2D r)
create objects associated with a link annotation (GoToR)

Method Summary

boolean
equals(Object obj)
Check if this equals another object.
void
setAction(PDFAction action)
Set the pdf action for this link.
String
toPDFString()

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

Field Details

EXTERNAL

public static final int EXTERNAL
Used to represent an external link.
Field Value:
0

INTERNAL

public static final int INTERNAL
Used to represent an internal link.
Field Value:
1

Constructor Details

PDFLink

public PDFLink(Rectangle2D r)
create objects associated with a link annotation (GoToR)
Parameters:
r - the rectangle of the link hotspot in absolute coordinates

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

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 String toPDFString()
Overrides:
toPDFString in interface PDFObject

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