org.faceless.pdf2
Class AnnotationNote

java.lang.Object
  extended byorg.faceless.pdf2.PDFObject
      extended byorg.faceless.pdf2.PDFMap
          extended byorg.faceless.pdf2.PDFAnnotation
              extended byorg.faceless.pdf2.AnnotationNote
All Implemented Interfaces:
Cloneable

public final class AnnotationNote
extends PDFAnnotation

This class represents the type of PDFAnnotation created by the "Note Tool" in Acrobat. This is normally represented by an icon on screen until the user clicks on it, at which point a window pops up and displays the contents.

Since:
2.0

Constructor Summary
AnnotationNote()
          Create a new Note of the default type - a yellow "Note".
 
Method Summary
 String getAuthor()
          Return the author (or "Label") of the annotation
 String getContents()
          Return the contents of the notes' pop-up window, as set by setContents(java.lang.String)
 float[] getRectangle()
          Return the rectangle this annotation applies to on the page, or null if no rectangle applies for this type of annotation.
 String getType()
          Returns the type of Note.
 boolean isOpen()
          Return whether this Note is open by default
 void setAuthor(String label)
          Set the author of the annotation.
 void setContents(String contents)
          Set the contents pop-up window displayed when the annotation is open.
 void setOpen(boolean open)
          Set whether this Note is saved in it's opened or closed state.
 void setRectangle(float x1, float y1, float x2, float y2)
          Set the rectangle for the annotation.
 void setType(String type, Color color)
          Set the type of the note, which affects the type of icon thats used to display it.
 
Methods inherited from class org.faceless.pdf2.PDFAnnotation
equals, getCreationDate, getInReplyTo, getModifyDate, getPage, getSubject, getUniqueID, isPrintable, isReadOnly, isVisible, setInReplyTo, setPage, setPrintable, setReadOnly, setSubject, setUniqueID, setVisible, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AnnotationNote

public AnnotationNote()
Create a new Note of the default type - a yellow "Note".

Method Detail

setType

public void setType(String type,
                    Color color)
Set the type of the note, which affects the type of icon thats used to display it. In Acrobat 4 and 5, the types that were available are: In Acrobat 6 a large number of new types were added:

All of these types will work in Acrobat 4.x and later, although attempting to edit the annotation type of an Acrobat 6.x annotation in an earlier release will probably result in the icon reverting to the original "Note" icon.


getType

public String getType()
Returns the type of Note. May be one of the values passed in to the constructor, but not guaranteed to be.

Overrides:
getType in class PDFAnnotation

setRectangle

public void setRectangle(float x1,
                         float y1,
                         float x2,
                         float y2)
Description copied from class: PDFAnnotation
Set the rectangle for the annotation.

Note that all co-ordinates are in absolute page co-ordinates. This means they are measured in points from the bottom-left hand corner of the page, regardless of any calls to PDFPage.rotate(float, float, double) or PDFPage.setUnits(float, int) that have been made. This restriction is part of the PDF specification.

Overrides:
setRectangle in class PDFAnnotation
Parameters:
x1 - the X co-ordinate of the bottom-left corner of the rectangle
y1 - the Y co-ordinate of the bottom-left corner of the rectangle
x2 - the X co-ordinate of the top-right corner of the rectangle
y2 - the Y co-ordinate of the top-right corner of the rectangle

getRectangle

public float[] getRectangle()
Description copied from class: PDFAnnotation
Return the rectangle this annotation applies to on the page, or null if no rectangle applies for this type of annotation. See the setRectangle() method for a discussion on units.

Overrides:
getRectangle in class PDFAnnotation
Returns:
the rectangle for this annotation, in the form of an array (x1, y1, x2, y2)
See Also:
PDFAnnotation.setRectangle(float, float, float, float)

setAuthor

public void setAuthor(String label)
Set the author of the annotation. This is also sometimes referred to as the Label.


getAuthor

public String getAuthor()
Return the author (or "Label") of the annotation


setContents

public void setContents(String contents)
Set the contents pop-up window displayed when the annotation is open.

Parameters:
contents - the contents of the window - may contain newline and non-ASCII Unicode characters.

getContents

public String getContents()
Return the contents of the notes' pop-up window, as set by setContents(java.lang.String)


setOpen

public void setOpen(boolean open)
Set whether this Note is saved in it's opened or closed state. Default is false


isOpen

public boolean isOpen()
Return whether this Note is open by default



Copyright © 2001-2004 Big Faceless Organization