org.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationLink
- COSObjectable
public class PDAnnotationLink
This is the class that represents a link annotation.
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.
|
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 |
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.
PDAnnotationLink
public PDAnnotationLink()
Constructor.
PDAnnotationLink
public PDAnnotationLink(COSDictionary field)
Creates a Link annotation from a COSDictionary, expected to be
a correct object definition.
field
- the PDF objet to represent as a field.
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.
- 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.
- The string representation of the highlight mode.
getPreviousURI
public PDActionURI getPreviousURI()
This will set the previous URI action, in case it's
needed.
getQuadPoints
public float[] getQuadPoints()
This will retrieve the set of quadpoints which encompass the areas of
this annotation which will activate.
- An array of floats representing the quad points.
setDestination
public void setDestination(PDDestination dest)
The new destination value.
dest
- The updated destination.
setHighlightMode
public void setHighlightMode(String mode)
Set the highlight mode. See the HIGHLIGHT_MODE_XXX constants.
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.
setQuadPoints
public void setQuadPoints(float[] quadPoints)
This will set the set of quadpoints which encompass the areas of this
annotation which will activate.
quadPoints
- an array representing the set of area covered.