Package org.openpdf.renderer.annotation

Class LinkAnnotation

java.lang.Object

org.openpdf.renderer.annotation.PDFAnnotation

org.openpdf.renderer.annotation.LinkAnnotation

public class LinkAnnotation
extends PDFAnnotation

PDF annotation describing a link to either a location within the current document, a location in another PDF file, an application/file to be opened or a web site. In the PDF structure a link can be a destination ("DEST") or an action ("A"). Both ways are handled as actions internally, i.e. for getting the links destination, you should get the action from this annotation object. It can be one of the following actions:

GotoAction - for a file internal destination

GoToRAction - for a destination in a remote PDF file

GoToEAction - for a destination in an embedded PDF file

UriAction - for a web link

LaunchAction - for launching an application/opening a file

Since:

06.07.2009

Nested Class Summary

Nested classes/interfaces inherited from class org.openpdf.renderer.annotation.PDFAnnotation

PDFAnnotation.Flags

Field Summary

Fields

Modifier and Type	Field	Description
private PDFAction	action

Fields inherited from class org.openpdf.renderer.annotation.PDFAnnotation

GOTO, GOTOE, GOTOR, URI

Constructor Summary

Constructors

Constructor	Description
LinkAnnotation(PDFObject annotObject)	Constructor

Method Summary

Modifier and Type	Method	Description
PDFAction	getAction()	Get the contained PDFAction

Methods inherited from class org.openpdf.renderer.annotation.PDFAnnotation

createAnnotation, getAnnotationName, getAppearanceState, getContents, getFlags, getModified, getPageCommandsForAnnotation, getPdfObj, getRect, getScalingTransformation, getSubType, getType, isFlagSet, parseRect, toString

Methods inherited from class java.lang.Object

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

Field Details

action

private PDFAction action

Constructor Details

LinkAnnotation

public LinkAnnotation(PDFObject annotObject)
               throws IOException

Constructor

Parameters:

annotObject -

Throws:

IOException

Method Details

getAction

public PDFAction getAction()

Get the contained PDFAction

Returns:

PDFAction - can be null in case the contains a destination object