Class PDAnnotationLink
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
- All Implemented Interfaces:
COSObjectable
This is the class that represents a link annotation.
- Version:
- $Revision: 1.3 $
- Author:
- Ben Litchfield, Paul King
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.static final String
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.static final String
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.static final String
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.static final String
The type of annotation.Fields inherited from class org.apache.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
ConstructorsConstructorDescriptionConstructor.PDAnnotationLink
(COSDictionary field) Creates a Link annotation from a COSDictionary, expected to be a correct object definition. -
Method Summary
Modifier and TypeMethodDescriptionGet the action to be performed when this annotation is to be activated.This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.Get the destination to be displayed when the annotation is activated.Set the highlight mode for when the mouse is depressed.This will set the previous URI action, in case it's needed.float[]
This will retrieve the set of quadpoints which encompass the areas of this annotation which will activate.void
Set the annotation action.void
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.void
setDestination
(PDDestination dest) The new destination value.void
setHighlightMode
(String mode) Set the highlight mode.void
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.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getColour, getContents, getCOSObject, getDictionary, getModifiedDate, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
-
Field Details
-
HIGHLIGHT_MODE_NONE
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.- See Also:
-
HIGHLIGHT_MODE_INVERT
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.- See Also:
-
HIGHLIGHT_MODE_OUTLINE
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.- See Also:
-
HIGHLIGHT_MODE_PUSH
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.- See Also:
-
SUB_TYPE
The type of annotation.- See Also:
-
-
Constructor Details
-
PDAnnotationLink
public PDAnnotationLink()Constructor. -
PDAnnotationLink
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
-
getAction
Get the action to be performed when this annotation is to be activated. Either this or the destination entry should be set, but not both.- Returns:
- The action to be performed when this annotation is activated.
-
setAction
Set the annotation action. Either this or the destination entry should be set, but not both.- Parameters:
action
- The annotation action.
-
setBorderStyle
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.- Parameters:
bs
- the border style dictionary to set.
-
getBorderStyle
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.- Returns:
- the border style dictionary.
-
getDestination
Get the destination to be displayed when the annotation is activated. Either this or the action entry should be set, but not both.- Returns:
- The destination for this annotation.
- Throws:
IOException
- If there is an error creating the destination.
-
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.
-
setHighlightMode
Set the highlight mode. See the HIGHLIGHT_MODE_XXX constants.- Parameters:
mode
- The new highlight mode.
-
setPreviousURI
This will set the previous URI action, in case it needs to be retrieved at later date.- Parameters:
pa
- The previous URI.
-
getPreviousURI
This will set the previous URI action, in case it's needed.- Returns:
- 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.
-
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.
-