ElegantJ PDF Library Java API Specification v1.1

com.elegantj.pdf
Class PDFLinkAnnotation

java.lang.Object
  extended bycom.elegantj.pdf.PDFObject
      extended bycom.elegantj.pdf.PDFGraphicsObject
          extended bycom.elegantj.pdf.PDFAnnotation
              extended bycom.elegantj.pdf.PDFLinkAnnotation

public class PDFLinkAnnotation
extends PDFAnnotation

This class represents PDFLinkAnnotation object It functions as an HTML link


Field Summary
 
Fields inherited from class com.elegantj.pdf.PDFAnnotation
llX, llY, urX, urY
 
Fields inherited from class com.elegantj.pdf.PDFGraphicsObject
BEVEL_JOINS, BUTT_CAPS, MITER_JOINS, ROUND_CAPS, ROUND_JOINS, SQUARE_CAPS
 
Constructor Summary
PDFLinkAnnotation(int x, int y, int width, int height, java.net.URL url)
          Constructs a PDFLinkAnnotation object with default region of the destination page shown
PDFLinkAnnotation(Page page, int x, int y, int width, int height, int dest_X, int dest_Y)
          Constructs a PDFLinkAnnotation object
 
Method Summary
 java.lang.Object clone()
          Returns the clone of this object
 int getBorderWidth()
          Method returns the width of the border of annotation
 int getZoomFactor()
          Method returns the zoom factor of the destination page
 void setBorderWidth(int width)
          Method which sets the width of the border for annotation
 void setColor(java.awt.Color color)
          Method which sets the color for the link annotation's border
 void setZoomFactor(int zoomFactor)
          Method which sets the zoom factor of the destination page Note : if you want to use default zoom then don't set it
 
Methods inherited from class com.elegantj.pdf.PDFObject
getPDFObjectID, getPDFObjectRefStr, getPDFObjectType, setPDFObjectID, setPDFObjectType
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDFLinkAnnotation

public PDFLinkAnnotation(int x,
                         int y,
                         int width,
                         int height,
                         java.net.URL url)
Constructs a PDFLinkAnnotation object with default region of the destination page shown

Parameters:
x - The x coordinate of annotation
y - The y coordinate of annotation
width - The width of the annotation
height - The height of the annotation
url - The URL of the page which is opened on clicking this rectangle specified by x, y, width and height

PDFLinkAnnotation

public PDFLinkAnnotation(Page page,
                         int x,
                         int y,
                         int width,
                         int height,
                         int dest_X,
                         int dest_Y)
Constructs a PDFLinkAnnotation object

Parameters:
page - The destination page
x - The x coordinate of annotation
y - The y coordinate of annotation
width - The width of the annotation
height - The height of the annotation
dest_X - The lower left x cordinate of destination page
dest_Y - The lower left y cordinate of destination page
Method Detail

setZoomFactor

public void setZoomFactor(int zoomFactor)
Method which sets the zoom factor of the destination page Note : if you want to use default zoom then don't set it

Parameters:
zoomFactor - The zoom factor of the destination page

getZoomFactor

public int getZoomFactor()
Method returns the zoom factor of the destination page

Returns:
The zoom factor of the destination page

setColor

public void setColor(java.awt.Color color)
Method which sets the color for the link annotation's border

Parameters:
color - the color for the link annotation's border

setBorderWidth

public void setBorderWidth(int width)
Method which sets the width of the border for annotation

Parameters:
width - The width of the border for annotation

getBorderWidth

public int getBorderWidth()
Method returns the width of the border of annotation


clone

public java.lang.Object clone()
Returns the clone of this object

Specified by:
clone in class PDFAnnotation
Returns:
The clone of this object

ElegantJ PDF Library Java API Specification v1.1

For any feedback, suggestion, or query, please revert back to support@elegantjpdf.com

Copyright(c)
Elegant Microweb Technologies Pvt. Ltd.
www.elegantmicroweb.com
www.elegantjpdf.com
All Rights Reserved.