PDAnnotationLink (Apache PDFBox 2.0.0 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
- - org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink

All Implemented Interfaces:

COSObjectable
```
public class PDAnnotationLink
extends PDAnnotation
```
This is the class that represents a link annotation.

Author:

Ben Litchfield, Paul King

Field Summary

Fields
Modifier and Type	Field and Description
`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.

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`PDAction`	`getAction()` Get the action to be performed when this annotation is to be activated.
`PDBorderStyleDictionary`	`getBorderStyle()` This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
`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`	`setAction(PDAction action)` Set the annotation action.
`void`	`setBorderStyle(PDBorderStyleDictionary bs)` 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`	`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.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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.
    
    See Also:
    Constant Field Values
  - 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.
    
    See Also:
    Constant Field Values
  - 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.
    
    See Also:
    Constant Field Values
  - 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.
    
    See Also:
    Constant Field Values
  - SUB_TYPE
```
public static final String SUB_TYPE
```
    The type of annotation.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - 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 Detail
  - getAction
```
public PDAction 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
```
public void setAction(PDAction action)
```
    Set the annotation action. Either this or the destination entry should be set, but not both.
    
    Parameters:
    action - The annotation action.
  - setBorderStyle
```
public void setBorderStyle(PDBorderStyleDictionary bs)
```
    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
```
public PDBorderStyleDictionary 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
```
public PDDestination getDestination()
                             throws IOException
```
    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.
  - setDestination
```
public void setDestination(PDDestination dest)
```
    The new destination value. Either this or the action entry should be set, but not both.
    
    Parameters:
    dest - The updated destination.
  - 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.
  - 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.
  - getPreviousURI
```
public PDActionURI 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.

Class PDAnnotationLink

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

HIGHLIGHT_MODE_NONE

HIGHLIGHT_MODE_INVERT

HIGHLIGHT_MODE_OUTLINE

HIGHLIGHT_MODE_PUSH

SUB_TYPE

Constructor Detail

PDAnnotationLink

PDAnnotationLink

Method Detail

getAction

setAction

setBorderStyle

getBorderStyle

getDestination

setDestination

getHighlightMode

setHighlightMode

setPreviousURI

getPreviousURI

setQuadPoints

getQuadPoints