COSObjectable
public class PDAnnotationLink extends PDAnnotation
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
HIGHLIGHT_MODE_INVERT |
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
static java.lang.String |
HIGHLIGHT_MODE_NONE |
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
static java.lang.String |
HIGHLIGHT_MODE_OUTLINE |
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
static java.lang.String |
HIGHLIGHT_MODE_PUSH |
Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
static java.lang.String |
SUB_TYPE |
The type of annotation.
|
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 | Description |
---|---|
PDAnnotationLink() |
Constructor.
|
PDAnnotationLink(COSDictionary field) |
Creates a Link annotation from a COSDictionary, expected to be
a correct object definition.
|
Modifier and Type | Method | 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.
|
java.lang.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(java.lang.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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
public static final java.lang.String HIGHLIGHT_MODE_NONE
public static final java.lang.String HIGHLIGHT_MODE_INVERT
public static final java.lang.String HIGHLIGHT_MODE_OUTLINE
public static final java.lang.String HIGHLIGHT_MODE_PUSH
public static final java.lang.String SUB_TYPE
public PDAnnotationLink()
public PDAnnotationLink(COSDictionary field)
field
- the PDF objet to represent as a field.public PDAction getAction()
public void setAction(PDAction action)
action
- The annotation action.public void setBorderStyle(PDBorderStyleDictionary bs)
bs
- the border style dictionary to set.public PDBorderStyleDictionary getBorderStyle()
public PDDestination getDestination() throws java.io.IOException
java.io.IOException
- If there is an error creating the destination.public void setDestination(PDDestination dest)
dest
- The updated destination.public java.lang.String getHighlightMode()
public void setHighlightMode(java.lang.String mode)
mode
- The new highlight mode.public void setPreviousURI(PDActionURI pa)
pa
- The previous URI.public PDActionURI getPreviousURI()
public void setQuadPoints(float[] quadPoints)
quadPoints
- an array representing the set of area covered.public float[] getQuadPoints()