Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.annotation » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationLink [javadoc | source]
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.
Field Summary
public static final  String HIGHLIGHT_MODE_NONE    Constant values of the Text as defined in the PDF 1.6 reference Table 8.19. 
public static final  String HIGHLIGHT_MODE_INVERT    Constant values of the Text as defined in the PDF 1.6 reference Table 8.19. 
public static final  String HIGHLIGHT_MODE_OUTLINE    Constant values of the Text as defined in the PDF 1.6 reference Table 8.19. 
public static final  String HIGHLIGHT_MODE_PUSH    Constant values of the Text as defined in the PDF 1.6 reference Table 8.19. 
public static final  String SUB_TYPE    The type of annotation. 
Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
FLAG_INVISIBLE,  FLAG_HIDDEN,  FLAG_PRINTED,  FLAG_NO_ZOOM,  FLAG_NO_ROTATE,  FLAG_NO_VIEW,  FLAG_READ_ONLY,  FLAG_LOCKED,  FLAG_TOGGLE_NO_VIEW
Constructor:
 public 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 from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink Summary:
getAction,   getBorderStyle,   getDestination,   getHighlightMode,   getPreviousURI,   getQuadPoints,   setAction,   setBorderStyle,   setDestination,   setHighlightMode,   setPreviousURI,   setQuadPoints
Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
createAnnotation,   getAnnotationFlags,   getAnnotationName,   getAppearance,   getAppearanceStream,   getCOSObject,   getColour,   getContents,   getDictionary,   getModifiedDate,   getPage,   getRectangle,   getSubtype,   isHidden,   isInvisible,   isLocked,   isNoRotate,   isNoView,   isNoZoom,   isPrinted,   isReadOnly,   isToggleNoView,   setAnnotationFlags,   setAnnotationName,   setAppearance,   setAppearanceStream,   setColour,   setContents,   setHidden,   setInvisible,   setLocked,   setModifiedDate,   setNoRotate,   setNoView,   setNoZoom,   setPrinted,   setReadOnly,   setRectangle,   setToggleNoView
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink Detail:
 public PDAction getAction() throws IOException 
    Get the action to be performed when this annotation is to be activated.
 public PDBorderStyleDictionary getBorderStyle() 
    This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
 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.
 public String getHighlightMode() 
    Set the highlight mode for when the mouse is depressed. See the HIGHLIGHT_MODE_XXX constants.
 public PDActionURI getPreviousURI() 
    This will set the previous URI action, in case it's needed.
 public float[] getQuadPoints() 
    This will retrieve the set of quadpoints which encompass the areas of this annotation which will activate.
 public  void setAction(PDAction action) 
    Set the annotation action. As of PDF 1.6 this is only used for Widget Annotations
 public  void setBorderStyle(PDBorderStyleDictionary bs) 
    This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
 public  void setDestination(PDDestination dest) 
    The new destination value.
 public  void setHighlightMode(String mode) 
    Set the highlight mode. See the HIGHLIGHT_MODE_XXX constants.
 public  void setPreviousURI(PDActionURI pa) 
    This will set the previous URI action, in case it needs to be retrieved at later date.
 public  void setQuadPoints(float[] quadPoints) 
    This will set the set of quadpoints which encompass the areas of this annotation which will activate.