|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.PdfAnnotation
A PdfAnnotation
is a note that is associated with a page.
PdfDictionary
Fields inherited from class com.lowagie.text.pdf.PdfDictionary |
CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES |
Fields inherited from class com.lowagie.text.pdf.PdfObject |
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type |
Constructor Summary | |
|
PdfAnnotation(PdfWriter writer,
float llx,
float lly,
float urx,
float ury,
PdfAction action)
Constructs a new PdfAnnotation of subtype link (Action). |
(package private) |
PdfAnnotation(PdfWriter writer,
float llx,
float lly,
float urx,
float ury,
PdfString title,
PdfString content)
Constructs a new PdfAnnotation of subtype text. |
protected |
PdfAnnotation(PdfWriter writer,
Rectangle rect)
|
Method Summary | |
static PdfAnnotation |
createFileAttachment(PdfWriter writer,
Rectangle rect,
String contents,
byte[] fileStore,
String file,
String fileDisplay)
Creates a file attachment annotation. |
static PdfAnnotation |
createFileAttachment(PdfWriter writer,
Rectangle rect,
String contents,
PdfFileSpecification fs)
|
static PdfAnnotation |
createFreeText(PdfWriter writer,
Rectangle rect,
String contents,
PdfContentByte defaultAppearance)
|
static PdfAnnotation |
createInk(PdfWriter writer,
Rectangle rect,
String contents,
float[][] inkList)
|
static PdfAnnotation |
createLine(PdfWriter writer,
Rectangle rect,
String contents,
float x1,
float y1,
float x2,
float y2)
|
protected static PdfAnnotation |
createLink(PdfWriter writer,
Rectangle rect,
PdfName highlight)
|
static PdfAnnotation |
createLink(PdfWriter writer,
Rectangle rect,
PdfName highlight,
int page,
PdfDestination dest)
|
static PdfAnnotation |
createLink(PdfWriter writer,
Rectangle rect,
PdfName highlight,
PdfAction action)
|
static PdfAnnotation |
createLink(PdfWriter writer,
Rectangle rect,
PdfName highlight,
String namedDestination)
|
static PdfAnnotation |
createMarkup(PdfWriter writer,
Rectangle rect,
String contents,
int type,
float[] quadPoints)
|
static PdfAnnotation |
createPopup(PdfWriter writer,
Rectangle rect,
String contents,
boolean open)
|
static PdfAnnotation |
createScreen(PdfWriter writer,
Rectangle rect,
String clipTitle,
PdfFileSpecification fs,
String mimeType,
boolean playOnDisplay)
Creates a screen PdfAnnotation |
static PdfAnnotation |
createSquareCirlcle(PdfWriter writer,
Rectangle rect,
String contents,
boolean square)
|
static PdfAnnotation |
createStamp(PdfWriter writer,
Rectangle rect,
String contents,
String name)
|
static PdfAnnotation |
createText(PdfWriter writer,
Rectangle rect,
String title,
String contents,
boolean open,
String icon)
|
(package private) PdfIndirectReference |
getIndirectReference()
|
int |
getPlaceInPage()
Getter for property placeInPage. |
(package private) HashMap |
getTemplates()
|
boolean |
isAnnotation()
Getter for property annotation. |
boolean |
isForm()
Getter for property form. |
boolean |
isUsed()
Getter for property used. |
void |
setAction(PdfAction action)
|
void |
setAdditionalActions(PdfName key,
PdfAction action)
|
void |
setAppearance(PdfName ap,
PdfAppearance template)
|
void |
setAppearance(PdfName ap,
String state,
PdfAppearance template)
|
void |
setAppearanceState(String state)
|
void |
setBorder(PdfBorderArray border)
|
void |
setBorderStyle(PdfBorderDictionary border)
|
void |
setColor(Color color)
|
void |
setDefaultAppearanceString(PdfContentByte cb)
|
void |
setFlags(int flags)
|
void |
setPage()
|
void |
setPage(int page)
|
void |
setPlaceInPage(int placeInPage)
Places the annotation in a specified page that must be greater or equal to the current one. |
void |
setPopup(PdfAnnotation popup)
|
void |
setTitle(String title)
|
(package private) void |
setUsed()
Setter for property used. |
Methods inherited from class com.lowagie.text.pdf.PdfDictionary |
contains, get, getKeys, isCatalog, isDictionaryType, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putDel, putEx, remove, size, toPdf |
Methods inherited from class com.lowagie.text.pdf.PdfObject |
getBytes, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, toString, type |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final PdfName HIGHLIGHT_NONE
public static final PdfName HIGHLIGHT_INVERT
public static final PdfName HIGHLIGHT_OUTLINE
public static final PdfName HIGHLIGHT_PUSH
public static final PdfName HIGHLIGHT_TOGGLE
public static final int FLAGS_INVISIBLE
public static final int FLAGS_HIDDEN
public static final int FLAGS_PRINT
public static final int FLAGS_NOZOOM
public static final int FLAGS_NOROTATE
public static final int FLAGS_NOVIEW
public static final int FLAGS_READONLY
public static final PdfName APPEARANCE_NORMAL
public static final PdfName APPEARANCE_ROLLOVER
public static final PdfName APPEARANCE_DOWN
public static final PdfName AA_ENTER
public static final PdfName AA_EXIT
public static final PdfName AA_DOWN
public static final PdfName AA_UP
public static final PdfName AA_FOCUS
public static final PdfName AA_BLUR
public static final PdfName AA_JS_KEY
public static final PdfName AA_JS_FORMAT
public static final PdfName AA_JS_CHANGE
public static final PdfName AA_JS_OTHER_CHANGE
public static final int MARKUP_HIGHLIGHT
public static final int MARKUP_UNDERLINE
public static final int MARKUP_STRIKEOUT
protected PdfWriter writer
protected PdfIndirectReference reference
protected HashMap templates
protected boolean form
protected boolean annotation
protected boolean used
private int placeInPage
Constructor Detail |
protected PdfAnnotation(PdfWriter writer, Rectangle rect)
PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content)
PdfAnnotation
of subtype text.
public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)
PdfAnnotation
of subtype link (Action).
Method Detail |
public static PdfAnnotation createScreen(PdfWriter writer, Rectangle rect, String clipTitle, PdfFileSpecification fs, String mimeType, boolean playOnDisplay) throws IOException
writer
- mimeType
- playOnDisplay
-
IOException
PdfIndirectReference getIndirectReference()
public static PdfAnnotation createText(PdfWriter writer, Rectangle rect, String title, String contents, boolean open, String icon)
protected static PdfAnnotation createLink(PdfWriter writer, Rectangle rect, PdfName highlight)
public static PdfAnnotation createLink(PdfWriter writer, Rectangle rect, PdfName highlight, PdfAction action)
public static PdfAnnotation createLink(PdfWriter writer, Rectangle rect, PdfName highlight, String namedDestination)
public static PdfAnnotation createLink(PdfWriter writer, Rectangle rect, PdfName highlight, int page, PdfDestination dest)
public static PdfAnnotation createFreeText(PdfWriter writer, Rectangle rect, String contents, PdfContentByte defaultAppearance)
public static PdfAnnotation createLine(PdfWriter writer, Rectangle rect, String contents, float x1, float y1, float x2, float y2)
public static PdfAnnotation createSquareCirlcle(PdfWriter writer, Rectangle rect, String contents, boolean square)
public static PdfAnnotation createMarkup(PdfWriter writer, Rectangle rect, String contents, int type, float[] quadPoints)
public static PdfAnnotation createStamp(PdfWriter writer, Rectangle rect, String contents, String name)
public static PdfAnnotation createInk(PdfWriter writer, Rectangle rect, String contents, float[][] inkList)
public static PdfAnnotation createFileAttachment(PdfWriter writer, Rectangle rect, String contents, byte[] fileStore, String file, String fileDisplay) throws IOException
writer
- the PdfWriter
rect
- the dimensions in the page of the annotationcontents
- the file descriptionfileStore
- an array with the file. If it's null
the file will be read from the diskfile
- the path to the file. It will only be used if
fileStore
in not null
fileDisplay
- the actual file name stored in the pdf
IOException
- on errorpublic static PdfAnnotation createFileAttachment(PdfWriter writer, Rectangle rect, String contents, PdfFileSpecification fs) throws IOException
IOException
public static PdfAnnotation createPopup(PdfWriter writer, Rectangle rect, String contents, boolean open)
public void setDefaultAppearanceString(PdfContentByte cb)
public void setFlags(int flags)
public void setBorder(PdfBorderArray border)
public void setBorderStyle(PdfBorderDictionary border)
public void setAppearance(PdfName ap, PdfAppearance template)
public void setAppearance(PdfName ap, String state, PdfAppearance template)
public void setAppearanceState(String state)
public void setColor(Color color)
public void setTitle(String title)
public void setPopup(PdfAnnotation popup)
public void setAction(PdfAction action)
public void setAdditionalActions(PdfName key, PdfAction action)
public boolean isUsed()
void setUsed()
HashMap getTemplates()
public boolean isForm()
public boolean isAnnotation()
public void setPage(int page)
public void setPage()
public int getPlaceInPage()
public void setPlaceInPage(int placeInPage)
placeInPage
- New value of property placeInPage.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |