|
| |
|
| java.lang.Object
 org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
| PDAnnotationLink | | public class PDAnnotationLink extends PDAnnotation (Code) | | This is the class that represents a link annotation.
author:
Ben Litchfield
author:
Paul King
version:
$Revision: 1.3 $ |
| HIGHLIGHT_MODE_INVERT | | final public static String HIGHLIGHT_MODE_INVERT(Code) | | Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
| HIGHLIGHT_MODE_NONE | | final public static String HIGHLIGHT_MODE_NONE(Code) | | Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
| HIGHLIGHT_MODE_OUTLINE | | final public static String HIGHLIGHT_MODE_OUTLINE(Code) | | Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
| HIGHLIGHT_MODE_PUSH | | final public static String HIGHLIGHT_MODE_PUSH(Code) | | Constant values of the Text as defined in the PDF 1.6 reference Table 8.19.
|
| SUB_TYPE | | final public static String SUB_TYPE(Code) | | The type of annotation.
|
| PDAnnotationLink | | public PDAnnotationLink()(Code) | | Constructor.
|
| PDAnnotationLink | | public PDAnnotationLink(COSDictionary field)(Code) | | Creates a Link annotation from a COSDictionary, expected to be
a correct object definition.
Parameters:
field - the PDF objet to represent as a field. |
| getDestination | | public PDDestination getDestination() throws IOException(Code) | | 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.
throws:
IOException - If there is an error creating the destination. |
| getHighlightMode | | public String getHighlightMode()(Code) | | 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()(Code) | | This will set the previous URI action, in case it's
needed.
The previous URI. |
| getQuadPoints | | public float[] getQuadPoints()(Code) | | 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)(Code) | | The new destination value.
Parameters:
dest - The updated destination. |
| setHighlightMode | | public void setHighlightMode(String mode)(Code) | | Set the highlight mode. See the HIGHLIGHT_MODE_XXX constants.
Parameters:
mode - The new highlight mode. |
| setPreviousURI | | public void setPreviousURI(PDActionURI pa)(Code) | | 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)(Code) | | 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. |
|
|
|