| java.lang.Object
 com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.PdfAnnotation
All known Subclasses: com.lowagie.text.pdf.PdfFormField,
| Inner Class :public static class PdfImportedLink | |
| Constructor Summary | |
| public | PdfAnnotation(PdfWriter writer, Rectangle rect)
| | public | PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content)
Constructs a new PdfAnnotation of subtype text. | | public | PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)
Constructs a new PdfAnnotation of subtype link (Action). |
| Method Summary | |
| public static PdfAnnotation | createFileAttachment(PdfWriter writer, Rectangle rect, String contents, byte fileStore, String file, String fileDisplay)
Creates a file attachment annotation.
Parameters:
writer - the PdfWriter
Parameters:
rect - the dimensions in the page of the annotation
Parameters:
contents - the file description
Parameters:
fileStore - an array with the file. | | public static PdfAnnotation | createFileAttachment(PdfWriter writer, Rectangle rect, String contents, PdfFileSpecification fs)
| | public static PdfAnnotation | createFreeText(PdfWriter writer, Rectangle rect, String contents, PdfContentByte defaultAppearance)
Add some free text to the document. | | public static PdfAnnotation | createInk(PdfWriter writer, Rectangle rect, String contents, float inkList)
| | public static PdfAnnotation | createLine(PdfWriter writer, Rectangle rect, String contents, float x1, float y1, float x2, float y2)
Adds a line to the document. | | protected static PdfAnnotation | createLink(PdfWriter writer, Rectangle rect, PdfName highlight)
Creates a link. | | public static PdfAnnotation | createLink(PdfWriter writer, Rectangle rect, PdfName highlight, PdfAction action)
Creates an Annotation with an Action. | | public static PdfAnnotation | createLink(PdfWriter writer, Rectangle rect, PdfName highlight, String namedDestination)
Creates an Annotation with an local destination. | | public static PdfAnnotation | createLink(PdfWriter writer, Rectangle rect, PdfName highlight, int page, PdfDestination dest)
Creates an Annotation with a PdfDestination. | | public static PdfAnnotation | createMarkup(PdfWriter writer, Rectangle rect, String contents, int type, float quadPoints)
| | public static PdfAnnotation | createPopup(PdfWriter writer, Rectangle rect, String contents, boolean open)
Adds a popup to your document. | | public static PdfAnnotation | createScreen(PdfWriter writer, Rectangle rect, String clipTitle, PdfFileSpecification fs, String mimeType, boolean playOnDisplay)
| | public static PdfAnnotation | createSquareCircle(PdfWriter writer, Rectangle rect, String contents, boolean square)
Adds a circle or a square that shows a tooltip when you pass over it. | | public static PdfAnnotation | createStamp(PdfWriter writer, Rectangle rect, String contents, String name)
Adds a Stamp to your document. | | public static PdfAnnotation | createText(PdfWriter writer, Rectangle rect, String title, String contents, boolean open, String icon)
| | public PdfIndirectReference | getIndirectReference()
| | PdfDictionary | getMK()
| | public static PdfArray | getMKColor(Color color)
| | public int | getPlaceInPage()
Getter for property placeInPage. | | public HashMap | getTemplates()
| | public boolean | isAnnotation()
Getter for property annotation. | | public boolean | isForm()
Getter for property form. | | public boolean | isUsed()
Getter for property used. | | public void | setAction(PdfAction action)
| | public void | setAdditionalActions(PdfName key, PdfAction action)
| | public void | setAppearance(PdfName ap, PdfTemplate template)
| | public void | setAppearance(PdfName ap, String state, PdfTemplate template)
| | public void | setAppearanceState(String state)
| | public void | setBorder(PdfBorderArray border)
| | public void | setBorderStyle(PdfBorderDictionary border)
| | public void | setColor(Color color)
| | public void | setDefaultAppearanceString(PdfContentByte cb)
| | public void | setFlags(int flags)
| | public void | setHighlighting(PdfName highlight)
Sets the annotation's highlighting mode. | | public void | setLayer(PdfOCG layer)
Sets the layer this annotation belongs to. | | public void | setMKAlternateCaption(String caption)
| | public void | setMKAlternateIcon(PdfTemplate template)
| | public void | setMKBackgroundColor(Color color)
| | public void | setMKBorderColor(Color color)
| | public void | setMKIconFit(PdfName scale, PdfName scalingType, float leftoverLeft, float leftoverBottom, boolean fitInBounds)
| | public void | setMKNormalCaption(String caption)
| | public void | setMKNormalIcon(PdfTemplate template)
| | public void | setMKRolloverCaption(String caption)
| | public void | setMKRolloverIcon(PdfTemplate template)
| | public void | setMKRotation(int rotation)
| | public void | setMKTextPosition(int tp)
| | public void | setName(String name)
Sets the name of the annotation. | | public void | setPage(int page)
| | public void | setPage()
| | public void | setPlaceInPage(int placeInPage)
Places the annotation in a specified page that must be greater
or equal to the current one. | | public void | setPopup(PdfAnnotation popup)
| | public void | setRotate(int v)
| | public void | setTitle(String title)
| | public void | setUsed()
Setter for property used. |
| AA_ENTER | | final public static PdfName AA_ENTER(Code) | | attributevalue
|
| AA_FOCUS | | final public static PdfName AA_FOCUS(Code) | | attributevalue
|
| AA_JS_CHANGE | | final public static PdfName AA_JS_CHANGE(Code) | | attributevalue
|
| AA_JS_FORMAT | | final public static PdfName AA_JS_FORMAT(Code) | | attributevalue
|
| AA_JS_KEY | | final public static PdfName AA_JS_KEY(Code) | | attributevalue
|
| AA_JS_OTHER_CHANGE | | final public static PdfName AA_JS_OTHER_CHANGE(Code) | | attributevalue
|
| APPEARANCE_DOWN | | final public static PdfName APPEARANCE_DOWN(Code) | | appearance attributename
|
| APPEARANCE_NORMAL | | final public static PdfName APPEARANCE_NORMAL(Code) | | appearance attributename
|
| APPEARANCE_ROLLOVER | | final public static PdfName APPEARANCE_ROLLOVER(Code) | | appearance attributename
|
| FLAGS_HIDDEN | | final public static int FLAGS_HIDDEN(Code) | | flagvalue
|
| FLAGS_INVISIBLE | | final public static int FLAGS_INVISIBLE(Code) | | flagvalue
|
| FLAGS_LOCKED | | final public static int FLAGS_LOCKED(Code) | | flagvalue
|
| FLAGS_NOROTATE | | final public static int FLAGS_NOROTATE(Code) | | flagvalue
|
| FLAGS_NOVIEW | | final public static int FLAGS_NOVIEW(Code) | | flagvalue
|
| FLAGS_NOZOOM | | final public static int FLAGS_NOZOOM(Code) | | flagvalue
|
| FLAGS_PRINT | | final public static int FLAGS_PRINT(Code) | | flagvalue
|
| FLAGS_READONLY | | final public static int FLAGS_READONLY(Code) | | flagvalue
|
| FLAGS_TOGGLENOVIEW | | final public static int FLAGS_TOGGLENOVIEW(Code) | | flagvalue
|
| HIGHLIGHT_INVERT | | final public static PdfName HIGHLIGHT_INVERT(Code) | | highlight attributename
|
| HIGHLIGHT_NONE | | final public static PdfName HIGHLIGHT_NONE(Code) | | highlight attributename
|
| HIGHLIGHT_OUTLINE | | final public static PdfName HIGHLIGHT_OUTLINE(Code) | | highlight attributename
|
| HIGHLIGHT_PUSH | | final public static PdfName HIGHLIGHT_PUSH(Code) | | highlight attributename
|
| HIGHLIGHT_TOGGLE | | final public static PdfName HIGHLIGHT_TOGGLE(Code) | | highlight attributename
|
| MARKUP_HIGHLIGHT | | final public static int MARKUP_HIGHLIGHT(Code) | | attributevalue
|
| MARKUP_STRIKEOUT | | final public static int MARKUP_STRIKEOUT(Code) | | attributevalue
|
| MARKUP_UNDERLINE | | final public static int MARKUP_UNDERLINE(Code) | | attributevalue
|
| annotation | | protected boolean annotation(Code) | | |
| form | | protected boolean form(Code) | | |
| used | | protected boolean used(Code) | | Holds value of property used.
|
| PdfAnnotation | | public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content)(Code) | | Constructs a new PdfAnnotation of subtype text.
Parameters:
writer -
Parameters:
llx -
Parameters:
lly -
Parameters:
urx -
Parameters:
ury -
Parameters:
title -
Parameters:
content - |
| PdfAnnotation | | public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)(Code) | | Constructs a new PdfAnnotation of subtype link (Action).
Parameters:
writer -
Parameters:
llx -
Parameters:
lly -
Parameters:
urx -
Parameters:
ury -
Parameters:
action - |
| createFileAttachment | | public static PdfAnnotation createFileAttachment(PdfWriter writer, Rectangle rect, String contents, byte fileStore, String file, String fileDisplay) throws IOException(Code) | | Creates a file attachment annotation.
Parameters:
writer - the PdfWriter
Parameters:
rect - the dimensions in the page of the annotation
Parameters:
contents - the file description
Parameters:
fileStore - an array with the file. If it's nullthe file will be read from the disk
Parameters:
file - the path to the file. It will only be used iffileStore is not null
Parameters:
fileDisplay - the actual file name stored in the pdf
throws:
IOException - on error the annotation |
| createFreeText | | public static PdfAnnotation createFreeText(PdfWriter writer, Rectangle rect, String contents, PdfContentByte defaultAppearance)(Code) | | Add some free text to the document.
Parameters:
writer -
Parameters:
rect -
Parameters:
contents -
Parameters:
defaultAppearance - A PdfAnnotation |
| createLine | | public static PdfAnnotation createLine(PdfWriter writer, Rectangle rect, String contents, float x1, float y1, float x2, float y2)(Code) | | Adds a line to the document. Move over the line and a tooltip is shown.
Parameters:
writer -
Parameters:
rect -
Parameters:
contents -
Parameters:
x1 -
Parameters:
y1 -
Parameters:
x2 -
Parameters:
y2 - A PdfAnnotation |
| createLink | | public static PdfAnnotation createLink(PdfWriter writer, Rectangle rect, PdfName highlight, String namedDestination)(Code) | | Creates an Annotation with an local destination.
Parameters:
writer -
Parameters:
rect -
Parameters:
highlight -
Parameters:
namedDestination - A PdfAnnotation |
| createLink | | public static PdfAnnotation createLink(PdfWriter writer, Rectangle rect, PdfName highlight, int page, PdfDestination dest)(Code) | | Creates an Annotation with a PdfDestination.
Parameters:
writer -
Parameters:
rect -
Parameters:
highlight -
Parameters:
page -
Parameters:
dest - A PdfAnnotation |
| createPopup | | public static PdfAnnotation createPopup(PdfWriter writer, Rectangle rect, String contents, boolean open)(Code) | | Adds a popup to your document.
Parameters:
writer -
Parameters:
rect -
Parameters:
contents -
Parameters:
open - A PdfAnnotation |
| createSquareCircle | | public static PdfAnnotation createSquareCircle(PdfWriter writer, Rectangle rect, String contents, boolean square)(Code) | | Adds a circle or a square that shows a tooltip when you pass over it.
Parameters:
writer -
Parameters:
rect -
Parameters:
contents - The tooltip
Parameters:
square - true if you want a square, false if you want a circle A PdfAnnotation |
| createStamp | | public static PdfAnnotation createStamp(PdfWriter writer, Rectangle rect, String contents, String name)(Code) | | Adds a Stamp to your document. Move over the stamp and a tooltip is shown
Parameters:
writer -
Parameters:
rect -
Parameters:
contents -
Parameters:
name - A PdfAnnotation |
| createText | | public static PdfAnnotation createText(PdfWriter writer, Rectangle rect, String title, String contents, boolean open, String icon)(Code) | |
Parameters:
writer -
Parameters:
rect -
Parameters:
title -
Parameters:
contents -
Parameters:
open -
Parameters:
icon - a PdfAnnotation |
| getPlaceInPage | | public int getPlaceInPage()(Code) | | Getter for property placeInPage.
Value of property placeInPage. |
| isAnnotation | | public boolean isAnnotation()(Code) | | Getter for property annotation.
Value of property annotation. |
| isForm | | public boolean isForm()(Code) | | Getter for property form.
Value of property form. |
| isUsed | | public boolean isUsed()(Code) | | Getter for property used.
Value of property used. |
| setAppearanceState | | public void setAppearanceState(String state)(Code) | | |
| setFlags | | public void setFlags(int flags)(Code) | | |
| setHighlighting | | public void setHighlighting(PdfName highlight)(Code) | | Sets the annotation's highlighting mode. The values can be
HIGHLIGHT_NONE, HIGHLIGHT_INVERT,
HIGHLIGHT_OUTLINE and HIGHLIGHT_PUSH;
Parameters:
highlight - the annotation's highlighting mode |
| setLayer | | public void setLayer(PdfOCG layer)(Code) | | Sets the layer this annotation belongs to.
Parameters:
layer - the layer this annotation belongs to |
| setMKAlternateCaption | | public void setMKAlternateCaption(String caption)(Code) | | |
| setMKBackgroundColor | | public void setMKBackgroundColor(Color color)(Code) | | |
| setMKBorderColor | | public void setMKBorderColor(Color color)(Code) | | |
| setMKIconFit | | public void setMKIconFit(PdfName scale, PdfName scalingType, float leftoverLeft, float leftoverBottom, boolean fitInBounds)(Code) | | |
| setMKNormalCaption | | public void setMKNormalCaption(String caption)(Code) | | |
| setMKRolloverCaption | | public void setMKRolloverCaption(String caption)(Code) | | |
| setMKRotation | | public void setMKRotation(int rotation)(Code) | | |
| setMKTextPosition | | public void setMKTextPosition(int tp)(Code) | | |
| setName | | public void setName(String name)(Code) | | Sets the name of the annotation.
With this name the annotation can be identified among
all the annotations on a page (it has to be unique).
|
| setPage | | public void setPage(int page)(Code) | | |
| setPage | | public void setPage()(Code) | | |
| setPlaceInPage | | public void setPlaceInPage(int placeInPage)(Code) | | Places the annotation in a specified page that must be greater
or equal to the current one. With PdfStamper the page
can be any. The first page is 1.
Parameters:
placeInPage - New value of property placeInPage. |
| setRotate | | public void setRotate(int v)(Code) | | |
| setUsed | | public void setUsed()(Code) | | Setter for property used.
|
|
|