ElegantJ PDF Library Java API Specification v1.1

com.elegantj.pdf
Class PDFTextAnnotation

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

public class PDFTextAnnotation
extends PDFAnnotation

This class represents PDFTextAnnotation object Annotations are notes or other objects that are associated with a page but are separate from the page description itself.


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
PDFTextAnnotation(java.lang.String text, int x, int y, int width, int height)
          Constructs a PDF Text Annotation object
 
Method Summary
 java.lang.Object clone()
          Returns the clone of this object
 java.lang.String getTitle()
          Method which returns the title of Text Annotation
 boolean isOpen()
          Method which returns initial flag for open the Text Annotation
 void setColor(java.awt.Color color)
          Method which sets the color for the Text Annotation
 void setOpen(boolean flag)
          Method which sets the flag which specifies that the annotation should initially be displayed opened
 void setTitle(java.lang.String title)
          Method which sets the title of Text Annotation
 
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

PDFTextAnnotation

public PDFTextAnnotation(java.lang.String text,
                         int x,
                         int y,
                         int width,
                         int height)
Constructs a PDF Text Annotation object

Parameters:
text - the text to be displayed, usually in a pop-up window.
x - the x coordinate of annotation
y - the y coordinate of annotation
width - the width of the annotation
height - the height of the annotation
Method Detail

setTitle

public void setTitle(java.lang.String title)
Method which sets the title of Text Annotation


getTitle

public java.lang.String getTitle()
Method which returns the title of Text Annotation

Returns:
the title of Text Annotation

setColor

public void setColor(java.awt.Color color)
Method which sets the color for the Text Annotation

Parameters:
color - The color for the Text Annotation

setOpen

public void setOpen(boolean flag)
Method which sets the flag which specifies that the annotation should initially be displayed opened

Parameters:
flag - Specifies that the annotation should initially be displayed opened

isOpen

public boolean isOpen()
Method which returns initial flag for open the Text Annotation

Returns:
true if the annotation will initially be displayed opened, false otherwise

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.