Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.pdfbox.pdmodel.interactive.annotation

Class PDAnnotationLink

Implemented Interfaces:
COSObjectable
public class PDAnnotationLink
extends PDAnnotation
This is the class that represents a link annotation.
Version:
$Revision: 1.3 $
Authors:
Ben Litchfield
Paul King

Field Summary

static String
HIGHLIGHT_MODE_INVERT
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
static String
HIGHLIGHT_MODE_NONE
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
static String
HIGHLIGHT_MODE_OUTLINE
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
static String
HIGHLIGHT_MODE_PUSH
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
static String
SUB_TYPE
The type of annotation.

Fields inherited from class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation

FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINTED, FLAG_READ_ONLY, FLAG_TOGGLE_NO_VIEW

Constructor Summary

PDAnnotationLink()
Constructor.
PDAnnotationLink(COSDictionary field)
Creates a Link annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

PDDestination
getDestination()
Get the destination to be displayed when the annotation is activated.
String
getHighlightMode()
Set the highlight mode for when the mouse is depressed.
PDActionURI
getPreviousURI()
This will set the previous URI action, in case it's needed.
float[]
getQuadPoints()
This will retrieve the set of quadpoints which encompass the areas of this annotation which will activate.
void
setDestination(PDDestination dest)
The new destination value.
void
setHighlightMode(String mode)
Set the highlight mode.
void
setPreviousURI(PDActionURI pa)
This will set the previous URI action, in case it needs to be retrieved at later date.
void
setQuadPoints(float[] quadPoints)
This will set the set of quadpoints which encompass the areas of this annotation which will activate.

Methods inherited from class org.pdfbox.pdmodel.interactive.annotation.PDAnnotation

createAnnotation, getAction, getActions, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getBoderStyle, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getRectangle, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAction, setActions, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setBorderStyle, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView

Field Details

HIGHLIGHT_MODE_INVERT

public static final String HIGHLIGHT_MODE_INVERT
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.

HIGHLIGHT_MODE_NONE

public static final String HIGHLIGHT_MODE_NONE
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.

HIGHLIGHT_MODE_OUTLINE

public static final String HIGHLIGHT_MODE_OUTLINE
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.

HIGHLIGHT_MODE_PUSH

public static final String HIGHLIGHT_MODE_PUSH
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.

SUB_TYPE

public static final String SUB_TYPE
The type of annotation.

Constructor Details

PDAnnotationLink

public PDAnnotationLink()
Constructor.

PDAnnotationLink

public PDAnnotationLink(COSDictionary field)
Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
Parameters:
field - the PDF objet to represent as a field.

Method Details

getDestination

public PDDestination getDestination()
            throws IOException
Get the destination to be displayed when the annotation is activated. Either this or the A should be set but not both.
Returns:
The destination for this annotation.

getHighlightMode

public String getHighlightMode()
Set the highlight mode for when the mouse is depressed. See the HIGHLIGHT_MODE_XXX constants.
Returns:
The string representation of the highlight mode.

getPreviousURI

public PDActionURI getPreviousURI()
This will set the previous URI action, in case it's needed.
Returns:
The previous URI.

getQuadPoints

public float[] getQuadPoints()
This will retrieve the set of quadpoints which encompass the areas of this annotation which will activate.
Returns:
An array of floats representing the quad points.

setDestination

public void setDestination(PDDestination dest)
The new destination value.
Parameters:
dest - The updated destination.

setHighlightMode

public void setHighlightMode(String mode)
Set the highlight mode. See the HIGHLIGHT_MODE_XXX constants.
Parameters:
mode - The new highlight mode.

setPreviousURI

public void setPreviousURI(PDActionURI pa)
This will set the previous URI action, in case it needs to be retrieved at later date.
Parameters:
pa - The previous URI.

setQuadPoints

public void setQuadPoints(float[] quadPoints)
This will set the set of quadpoints which encompass the areas of this annotation which will activate.
Parameters:
quadPoints - an array representing the set of area covered.

Overview Package Class Use Tree Index Deprecated About