Class PDFUri

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFAction

org.apache.fop.pdf.PDFUri

All Implemented Interfaces:

CompressedObject, PDFWritable

public class PDFUri
extends PDFAction

class used to create a PDF Uri link

Field Summary

Fields

Modifier and Type	Field	Description
private String	altText
private String	uri

Fields inherited from class PDFObject

log

Constructor Summary

Constructors

Constructor	Description
PDFUri(String uri, String altText)	create a Uri instance.

Method Summary

Modifier and Type	Method	Description
String	getAction()	returns the action ncecessary for a uri
String	getAltText()
private String	getDictString()
String	toPDFString()	This method returns a String representation of the PDF object.

Methods inherited from class PDFAction

encodeScript

Methods inherited from class PDFObject

contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getChildren, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, supportsObjectStream, toPDF

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

uri

private String uri

altText

private String altText

Constructor Details

PDFUri

public PDFUri(String uri,
 String altText)

create a Uri instance.

Parameters:

uri - the uri to which the link should point

Method Details

getAction

public String getAction()

returns the action ncecessary for a uri

Specified by:

getAction in class PDFAction

Returns:

the action to place next to /A within a Link

getDictString

private String getDictString()

toPDFString

public 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

getAltText

public String getAltText()