com.gnostice.pdfone

Class PdfFileAttachmentAnnot

java.lang.Object

com.gnostice.pdfone.PdfAnnot

com.gnostice.pdfone.PdfFileAttachmentAnnot

All Implemented Interfaces:

Usable, Cloneable

public class PdfFileAttachmentAnnot
extends PdfAnnot

This class represents a file attachment annotation. A file attachment annotation is used to embed attachments attach external files to the PDF document. Users can identify and extract the attachments from the document on the viewer application. The attachment can be a file or a URI. If the contents referred by the URI is volatile, that is, frequently changes with time, then viewer applications can be made not to cache the file and look for the latest copy of the contents.

// Create a PDF page
PdfPage page = new PdfPage();

// Create a PDF font
PdfFont fontHelvetica = PdfFont.create("Helvetica", 15, PdfEncodings.WINANSI);
fontHelvetica.setColor(Color.BLUE);

p.writeText("FileAttachment Annotation", font_Helvetica, 220, 400);

// Create a file attachment annotation and set its properties
PdfFileAttachmentAnnot fileAttachAnnot = 
    new PdfFileAttachmentAnnot(
           2, 4, 
           PdfFileAttachmentAnnot.ANNOT_TYPE_FILE_ATTACHMENT,
           Color.CYAN);
fileAttachAnnot.setFilePath("somefile.ext");
fileAttachAnnot.setBorderStyle(PdfAnnot.ANNOT_TYPE_CIRCLE);
fileAttachAnnot.setBorderWidth(2);
fileAttachAnnot.setTitle("FileText Annotation Title 1");
fileAttachAnnot.setSubject("FileText Annotation Subject 1");
        
// Add the annotation to the page
page.addAnnotation(fileAttachAnnot);

Field Summary

Fields

Modifier and Type	Field and Description
static int	ICON_GRAPH Constant specifying an image of a bar graph for the annotation icon.
static int	ICON_PAPERCLIP Constant specifying an image of a paper clip for the annotation icon.
static int	ICON_PUSHPIN Constant specifying an image of a push pin for the annotation icon.
static int	ICON_TAG Constant specifying an image of a price tag for the annotation icon.

Fields inherited from class com.gnostice.pdfone.PdfAnnot

ANNOT_TYPE_CARET, ANNOT_TYPE_CIRCLE, ANNOT_TYPE_FILE_ATTACHMENT, ANNOT_TYPE_FREE_TEXT, ANNOT_TYPE_INK, ANNOT_TYPE_LINE, ANNOT_TYPE_LINK, ANNOT_TYPE_MARKUP, ANNOT_TYPE_POLYGON, ANNOT_TYPE_POLYLINE, ANNOT_TYPE_POPUP, ANNOT_TYPE_SQUARE, ANNOT_TYPE_STAMP, ANNOT_TYPE_TEXT, ANNOT_TYPE_WATERMARK, BORDERSTYLE_BEVELED, BORDERSTYLE_DASHED, BORDERSTYLE_INSET, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINT, FLAG_READONLY, FLAG_TOGGLE_NO_VIEW

Fields inherited from interface com.gnostice.pdfone.Usable

INCHES_TO_POINTS, MM_TO_INCHES, MM_TO_POINTS, PDF_A, PDF_AA, PDF_AC, PDF_ACROFORM, PDF_ACTION, PDF_ALTERNATEPRESENTATIONS, PDF_ANNOT, PDF_ANNOT_DEFAULT_TITLE, PDF_ANNOT_NAME, PDF_ANNOT_SUBJECT, PDF_ANNOTS, PDF_AP, PDF_ARRAYEND, PDF_ARRAYSTART, PDF_ARTBOX, PDF_AS, PDF_ASCENT, PDF_ASCII85, PDF_ASCII85_NEW, PDF_ASCIIHEX, PDF_ASCIIHEX_NEW, PDF_AuthEvent, PDF_AUTHOR, PDF_AVGWIDTH, PDF_B, PDF_BASEFONT, PDF_BBOX, PDF_BC, PDF_BE, PDF_BEFOREFORMAT, PDF_BEGINTEXT, PDF_BG, PDF_BINARYDATA, PDF_BITS_PER_COMPONENT, PDF_BL, PDF_BLEEDBOX, PDF_BLINDS, PDF_BMC, PDF_BORDER, PDF_BOX, PDF_BS, PDF_BTN, PDF_BYTERANGE, PDF_C, PDF_CA, PDF_CA_SMALL, PDF_CAPHEIGHT, PDF_CARETANNOT, PDF_CARRIAGE, PDF_CATALOG, PDF_CENTER_WINDOW, PDF_CF, PDF_CFM, PDF_CH, PDF_CID_TO_GID_MAP, PDF_CIDFONT_TYPE0, PDF_CIDFONT_TYPE1, PDF_CIDFONT_TYPE2, PDF_CIDSYSTEM_INFO, PDF_CIRCLEANNOT, PDF_CL, PDF_CM, PDF_COLOMNS, PDF_COLOR, PDF_COLORSPACE, PDF_COLORSPACE_CALGRAY, PDF_COLORSPACE_CALRGB, PDF_COLORSPACE_DEVICEN, PDF_COLORSPACE_ICCBASED, PDF_COLORSPACE_LAB, PDF_COLORSPACE_SEPARATION, PDF_CONTACTINFO, PDF_CONTENTS, PDF_COUNT, PDF_COVER, PDF_CREATIONDATE, PDF_CREATOR, PDF_CROPBOX, PDF_CS, PDF_CSP, PDF_D, PDF_DA, PDF_DATE, PDF_DATE_FORMAT, PDF_DCTDECODE, PDF_DCTDECODE_NEW, PDF_DECODEPARMS, PDF_DESC, PDF_DESCENDANT, PDF_DESCENDANT_FONTS, PDF_DESCENDENTFONTS, PDF_DESCENT, PDF_DESTINATION, PDF_DESTS, PDF_DEVICE_CMYK, PDF_DEVICE_GRAY, PDF_DEVICE_RGB, PDF_DI, PDF_DICTEND, PDF_DICTSTART, PDF_DIFFERENCES, PDF_DIRECTION, PDF_DISPLAY_DOCTITLE, PDF_DISPLAY_DURATION, PDF_DISSOLVE, PDF_DM, PDF_DOC_SUBJECT, PDF_DOCMDP, PDF_DOS, PDF_DP, PDF_DR, PDF_DS, PDF_DV, PDF_DW, PDF_E, PDF_EF, PDF_EMBEDDEDFILE, PDF_EMBEDDEDFILES, PDF_EMC, PDF_ENCODING, PDF_ENCRYPT, PDF_ENCRYPTMETADATA, PDF_ENDOBJ, PDF_ENDPATH, PDF_ENDSTREAM, PDF_ENDTEXT, PDF_EOCLIP, PDF_EOF, PDF_EXTGSTATE, PDF_F, PDF_FADE, PDF_FALSE, PDF_FDESCRIPTOR, PDF_FIELD_FLAG, PDF_FIELDS, PDF_FILEATTACHMENTANNOT, PDF_FILESPEC, PDF_FILTER, PDF_FIRST, PDF_FIRST_PAGE, PDF_FIRSTCHAR, PDF_FIT, PDF_FIT_WINDOW, PDF_FITB, PDF_FITBH, PDF_FITBV, PDF_FITH, PDF_FITR, PDF_FITV, PDF_FIXEDPRINT, PDF_FLAGS, PDF_FLATE, PDF_FLATE_NEW, PDF_FLY, PDF_FO, PDF_FONT, PDF_FONTBBOX, PDF_FONTDESCRIPTOR, PDF_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTFILE2, PDF_FONTNAME, PDF_FONTNAMEPREFIX, PDF_FORM, PDF_FORMFEED, PDF_FORMFONTPREFIX, PDF_FREE_TEXT_CALLOUT, PDF_FREE_TEXT_TYPEWRITER, PDF_FREETEXTANNOT, PDF_FS, PDF_FT, PDF_FULLSCREEN, PDF_GLITTER, PDF_GOTO_ACTION, PDF_GROUP, PDF_GS, PDF_H, PDF_HEADER, PDF_HEIGHT, PDF_HEXSTRINGEND, PDF_HEXSTRINGSTART, PDF_HIDE_MENUBAR, PDF_HIDE_TOOLBAR, PDF_HIDE_WINDOWUI, PDF_HIGHLIGHT, PDF_HORIZ_STEM, PDF_HORIZONTAL, PDF_I, PDF_IC, PDF_ID, PDF_IDS, PDF_IF, PDF_IMAGE, PDF_IMAGEB, PDF_IMAGEC, PDF_IMAGEI, PDF_IMPORTDATA, PDF_INDEX, PDF_INDEXED, PDF_INFO, PDF_INK, PDF_INKLIST, PDF_INWARD, PDF_IT, PDF_ITALANGLE, PDF_IX, PDF_JAVASCRIPT, PDF_JAVASCRIPT_ACTION, PDF_JS, PDF_KEYSTROKE, PDF_KEYWORDS, PDF_KIDS, PDF_L, PDF_L2R, PDF_LANG, PDF_LAST, PDF_LAST_PAGE, PDF_LASTCHAR, PDF_LAUNCH_ACTION, PDF_LE, PDF_LEGAL, PDF_LENGTH, PDF_LENGTH_1, PDF_LENGTH_2, PDF_LENGTH_3, PDF_LF, PDF_LINEANNOT, PDF_LINKANNOT, PDF_LITERALSTRINGEND, PDF_LITERALSTRINGSTART, PDF_LOCATION, PDF_LZWDECODE, PDF_M, PDF_MAC, PDF_MARKINFO, PDF_MATRIX, PDF_MAXLEN, PDF_MAXWIDTH, PDF_MEDIABOX, PDF_METADATA, PDF_MISSINGWIDTH, PDF_MK, PDF_MODDATE, PDF_N, PDF_NAME, PDF_NAMED, PDF_NAMED_ACT_FIND, PDF_NAMED_ACT_OPEN, PDF_NAMED_ACT_PRINT, PDF_NAMED_ACT_SEARCH, PDF_NAMES, PDF_NAMESTART, PDF_NEEDAPPEARANCES, PDF_NEWLINE, PDF_NEWWINDOW, PDF_NEXT, PDF_NEXT_PAGE, PDF_NO_COMP_OBJ, PDF_NONFULLSCREEN_PAGEMODE, PDF_NULL, PDF_O, PDF_OBJ, PDF_OBJSTREAM, PDF_OCPROPERTIES, PDF_OFF, PDF_ONECOLUMN, PDF_OPEN, PDF_OPEN_ACTION, PDF_OPT, PDF_OUTLINES, PDF_OUTPUTINTENTS, PDF_OUTWARD, PDF_P, PDF_PAGE, PDF_PAGECLOSE, PDF_PAGEINVISIBLE, PDF_PAGELABELS, PDF_PAGELAYOUT, PDF_PAGEMODE, PDF_PAGEOPEN, PDF_PAGES, PDF_PAGEVISIBLE, PDF_PAINT_TYPE, PDF_PARAMS, PDF_PARENT, PDF_PATTERN, PDF_PATTERN_TYPE, PDF_PBD, PDF_PC, PDF_PDC, PDF_PDF, PDF_PERMS, PDF_PFD, PDF_PH, PDF_PIECEINFO, PDF_POLYGONANNOT, PDF_POLYLINEANNOT, PDF_POPUP, PDF_PREDICTOR, PDF_PREV, PDF_PREV_PAGE, PDF_PROCSET, PDF_PRODUCER, PDF_PROPERTIES, PDF_PUSH, PDF_PV, PDF_Q, PDF_QUADPOINTS, PDF_R, PDF_R2L, PDF_RC, PDF_RD, PDF_RE, PDF_REASON, PDF_RECALCULATE, PDF_RECT, PDF_REMOTEGOTO_ACTION, PDF_RENDITIONS, PDF_REPLACE, PDF_RESET_FORM, PDF_RESOURCES, PDF_RESTORE_GS, PDF_RI, PDF_ROOT, PDF_ROTATE, PDF_RUNLENGTH, PDF_RUNLENGTH_NEW, PDF_S, PDF_SCN, PDF_SHADING, PDF_SHOWIMG, PDF_SHOWTEXT, PDF_SHOWTEXT_TJ, PDF_SIG, PDF_SIG_FILTER_ADOBE_PPKLITE, PDF_SIG_FILTER_ADOBE_PPKMS, PDF_SIG_SUBFILTER_ADBE_PKCS7_DETACHED, PDF_SIG_SUBFILTER_ADBE_PKCS7_SHA1, PDF_SINGLE_QUOTES, PDF_SINGLEPAGE, PDF_SIZE, PDF_SP, PDF_SPIDERINFO, PDF_SPLIT, PDF_SQUAREANNOT, PDF_SQUIGGLY, PDF_SS, PDF_STAMPANNOT, PDF_STARTXREF, PDF_StmF, PDF_STORE_GS, PDF_STREAM, PDF_StrF, PDF_STRIKEOUT, PDF_STRUCT_TREE, PDF_SUBFILTER, PDF_SUBMIT_FORM, PDF_SUBTYPE, PDF_T, PDF_TAB, PDF_TEMPLATES, PDF_TEXT, PDF_TEXTANNOT, PDF_TEXTCHARSPACE, PDF_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTHORIZONTALSCALE, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWORDSPACE, PDF_THREADS, PDF_THUMB, PDF_TILING_TYPE, PDF_TITLE, PDF_TJ_OPERAND_END, PDF_TJ_OPERAND_START, PDF_TM, PDF_TOUNICODE, PDF_TP, PDF_TRAILER, PDF_TRANSITION, PDF_TRIMBOX, PDF_TRUE, PDF_TRUETYPE, PDF_TU, PDF_TWOCOLUMN_LEFT, PDF_TWOCOLUMN_RIGHT, PDF_TWOPAGE_LEFT, PDF_TWOPAGE_RIGHT, PDF_TX, PDF_TYPE, PDF_TYPE0, PDF_TYPE1, PDF_U, PDF_UNCOVER, PDF_UNDERLINE, PDF_UNIX, PDF_URI_ACTION, PDF_URL, PDF_URLS, PDF_USEATTACHMENTS, PDF_USENONE, PDF_USEOC, PDF_USEOUTLINES, PDF_USETHUMBS, PDF_V, PDF_VALUECHANGE, PDF_VERSION, PDF_VERT_STEM, PDF_VERTICAL, PDF_VERTICES, PDF_VIEWER_PREFERENCES, PDF_W, PDF_WATERMARKANNOT, PDF_WIDGET, PDF_WIDTH, PDF_WIDTHS, PDF_WINANSIENCODING, PDF_WIPE, PDF_X, PDF_XML, PDF_XOBJECT, PDF_XREF, PDF_XREFSTMOFFSET, PDF_XREFSTREAM, PDF_XSTEP, PDF_XYZ, PDF_YES, PDF_YSTEP, PIXEL_PER_INCH, RUBICON_EMBEDDED, SITE, TEXT, TWIPS_TO_POINTS

Constructor Summary

Constructors

Constructor and Description
PdfFileAttachmentAnnot() Zero-argument default constructor.
PdfFileAttachmentAnnot(double x, double y, Color c) Constructs a file attachment annotation at (x, y) with specified icon color.
PdfFileAttachmentAnnot(double x, double y, int flags) Constructs a file attachment annotation at (x, y) with specified flags.
PdfFileAttachmentAnnot(double x, double y, int flags, Color c) Constructs a file attachment annotation at (x, y) with specified flags and icon color.
PdfFileAttachmentAnnot(double x, double y, String subject, String contents, String title) Constructs a file attachment annotation at (x, y) with specified popup subject, contents, and title.
PdfFileAttachmentAnnot(double x, double y, String subject, String contents, String title, Color c) Constructs a file attachment annotation at (x, y) with specified icon color, and popup subject, contents and title.
PdfFileAttachmentAnnot(double x, double y, String subject, String contents, String title, int flags) Constructs a file attachment annotation at (x, y) with specified popup subject, contents and title, and flags.
PdfFileAttachmentAnnot(double x, double y, String subject, String contents, String title, int flags, Color c) Constructs a file attachment annotation at (x, y) with specified popup subject, contents and title, flags, and icon color.
PdfFileAttachmentAnnot(double x, double y, String subject, String contents, String title, int flags, Color c, String filePath, boolean isUrl, boolean isVolatile, int icon) Constructs a file attachment annotation at (x, y) with specified icon color, popup subject, contents and title, flags, color, location of attachment, attachment nature, attachment volatality, and icon.
PdfFileAttachmentAnnot(String filePath, boolean isUrl, boolean isVolatile, int icon) Constructs a file attachment annotation at (x, y) with specified location of attachment, attachment nature, attachment volatality, and icon.

Method Summary

Modifier and Type	Method and Description
Object	clone()
PdfFileAttachment	getAttachment()
PdfAppearanceStream	getDownAppearance() Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
String	getFilePath() Returns pathname of the file that has specified for the annotation.
int	getIcon() Returns constant specifying the annotation icon.
PdfAppearanceStream	getNormalAppearance() Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
PdfPopUpAnnot	getPopup() Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
PdfAppearanceStream	getRolloverAppearance() Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).
float	getTransparency()
void	setAttachment(PdfFileAttachment fileAttachment)
void	setDownAppearance(PdfAppearanceStream downAppearance) Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.
void	setFilePath(String filePath) Specifies file that needs to be used by the annotation.
void	setIcon(int icon) Specifies annotation icon.
void	setNormalAppearance(PdfAppearanceStream normalAppearance) Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).
void	setPopup(PdfPopUpAnnot popup, boolean overridePopUpProperties) Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.
void	setRolloverAppearance(PdfAppearanceStream rolloverAppearance) Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).
void	setTransparency(float transparecyLevel)

Methods inherited from class com.gnostice.pdfone.PdfAnnot

delete, getAnnotName, getBorderStyle, getBorderWidth, getBottom, getColor, getContents, getDashPattern, getFlags, getLeft, getRect, getRight, getSubject, getTitle, getTop, getType, hashCode, isDeleted, isShowRect, setAnnotName, setBorderStyle, setBorderWidth, setColor, setContents, setDashPattern, setFlags, setRect, setRect, setRect, setRect, setRect, setShowRect, setSubject, setTitle

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ICON_GRAPH

public static final int ICON_GRAPH

Constant specifying an image of a bar graph for the annotation icon.

See Also:

Constant Field Values

ICON_PAPERCLIP

public static final int ICON_PAPERCLIP

Constant specifying an image of a paper clip for the annotation icon.

See Also:

Constant Field Values

ICON_PUSHPIN

public static final int ICON_PUSHPIN

Constant specifying an image of a push pin for the annotation icon.

See Also:

Constant Field Values

ICON_TAG

public static final int ICON_TAG

Constant specifying an image of a price tag for the annotation icon.

See Also:

Constant Field Values

Constructor Detail

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot()

Zero-argument default constructor.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              String subject,
                              String contents,
                              String title,
                              int flags,
                              Color c,
                              String filePath,
                              boolean isUrl,
                              boolean isVolatile,
                              int icon)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified icon color, popup subject, contents and title, flags, color, location of attachment, attachment nature, attachment volatality, and icon.

Parameters:

x - x-coordinate of the location of the icon

y - y-coordinate of the location of the icon

subject - text displayed in the subject line of the annotation's popup window

contents - text displayed as the contents of the annotation's popup window

title - text displayed in the title in the annotation's popup window

flags - annotation attributes

c - color of the icon

filePath - location of the attachment

isUrl - whether the attachment is specified by its pathname or as a uniform resource identifier (URI)

isVolatile - whether contents of the attachment are volatile

icon - constant specifying the attachment icon

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              String subject,
                              String contents,
                              String title)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified popup subject, contents, and title.

Parameters:

x - x-coordinate of the location of the icon

y - y-coordinate of the location of the icon

subject - text displayed in the subject line of the annotation's popup window

contents - text displayed as the contents of the annotation's popup window

title - text displayed in the title in the annotation's popup window

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              String subject,
                              String contents,
                              String title,
                              Color c)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified icon color, and popup subject, contents and title.

Parameters:

x - x-coordinate of the location of the icon

y - y-coordinate of the location of the icon

subject - text displayed in the subject line of the annotation's popup window

contents - text displayed as the contents of the annotation's popup window

title - text displayed in the title in the annotation's popup window

c - color of the icon

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              String subject,
                              String contents,
                              String title,
                              int flags)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified popup subject, contents and title, and flags.

Parameters:

x - x-coordinate of the location of the icon

y - y-coordinate of the location of the icon

subject - text displayed in the subject line of the annotation's popup window

contents - text displayed as the contents of the annotation's popup window

title - text displayed in the title in the annotation's popup window

flags - annotation attributes

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              String subject,
                              String contents,
                              String title,
                              int flags,
                              Color c)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified popup subject, contents and title, flags, and icon color.

Parameters:

x - x-coordinate of the location of the icon

y - y-coordinate of the location of the icon

subject - text displayed in the subject line of the annotation's popup window

contents - text displayed as the contents of the annotation's popup window

title - text displayed in the title in the annotation's popup window

flags - annotation attributes

c - color of the icon

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              int flags)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified flags.

Parameters:

x - x-coordinate of the location of the icon

y - y-coordinate of the location of the icon

flags - annotation attributes

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              int flags,
                              Color c)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified flags and icon color.

Parameters:

x - x-coordinate of the location of the icon

y - x-coordinate of the location of the icon

flags - annotation attributes

c - icon color

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(double x,
                              double y,
                              Color c)
                       throws IOException,
                              PdfException

Constructs a file attachment annotation at (x, y) with specified icon color.

Parameters:

x - x-coordinate of the location of the icon

y - x-coordinate of the location of the icon

c - color of the icon

Throws:

IOException - if an I/O error occurs.

PdfException - if an illegal argument is supplied.

PdfFileAttachmentAnnot

public PdfFileAttachmentAnnot(String filePath,
                              boolean isUrl,
                              boolean isVolatile,
                              int icon)

Constructs a file attachment annotation at (x, y) with specified location of attachment, attachment nature, attachment volatality, and icon.

Parameters:

filePath - location of the attachment

isUrl - whether the attachment is specified by its pathname or as a uniform resource identifier (URI)

isVolatile - whether contents of the attachment are volatile

icon - constant specifying the attachment icon

Method Detail

clone

public Object clone()

getFilePath

public String getFilePath()

Returns pathname of the file that has specified for the annotation. This method is useful only in writing mode. In reading mode, this method will return null.

Returns:

pathname of the file used as by the annotation

See Also:

setFilePath(String)

setFilePath

public void setFilePath(String filePath)
                 throws IOException,
                        PdfException

Specifies file that needs to be used by the annotation.

Parameters:

filePath - pathname of the file

Throws:

PdfException

IOException

See Also:

getFilePath()

getIcon

public int getIcon()

Returns constant specifying the annotation icon.

Returns:

constant specifying the annotation icon

See Also:

setIcon(int)

setIcon

public void setIcon(int icon)

Specifies annotation icon.

Parameters:

icon - constant specifying the annotation icon

See Also:

getIcon()

getAttachment

public PdfFileAttachment getAttachment()

setAttachment

public void setAttachment(PdfFileAttachment fileAttachment)
                   throws PdfException

Throws:

PdfException

setTransparency

public void setTransparency(float transparecyLevel)

getTransparency

public float getTransparency()

getPopup

public PdfPopUpAnnot getPopup()

Returns a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.

Returns:

popup annotation that needs to be used as the popup window

setPopup

public void setPopup(PdfPopUpAnnot popup,
                     boolean overridePopUpProperties)

Specifies a popup annotation that needs to be used by a viewer application to display the popup window for this annotation.

Parameters:

popup - popup annotation that needs to be used as the popup window

overridePopUpProperties - whether a viewer application should override the properties of the popup annotation with those of this annotation

See Also:

getPopup()

getDownAppearance

public PdfAppearanceStream getDownAppearance()

Returns the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.

Returns:

appearance that needs to be displayed

See Also:

getNormalAppearance(), getDownAppearance(), setNormalAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream)

setDownAppearance

public void setDownAppearance(PdfAppearanceStream downAppearance)

Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field and holds down the mouse button.

See Also:

getNormalAppearance(), getDownAppearance(), getRolloverAppearance(), setNormalAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)

getNormalAppearance

public PdfAppearanceStream getNormalAppearance()

Returns the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).

See Also:

getDownAppearance(), getRolloverAppearance(), setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)

setNormalAppearance

public void setNormalAppearance(PdfAppearanceStream normalAppearance)

Specifies the default appearance stream that needs to be used by a viewer application to display the annotation/form field (that is, when the user is not interacting with the annotation/form field).

Parameters:

normalAppearance - the specified appearance stream

See Also:

setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream), getNormalAppearance(), getDownAppearance(), getRolloverAppearance()

getRolloverAppearance

public PdfAppearanceStream getRolloverAppearance()

Returns the appearance stream that needs to be used by a viewer application to display the annotation when the user places the mouse pointer over the annotation (and does not hold down the mouse button).

See Also:

getNormalAppearance(), getDownAppearance(), setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), setRolloverAppearance(PdfAppearanceStream)

setRolloverAppearance

public void setRolloverAppearance(PdfAppearanceStream rolloverAppearance)

Specifies the appearance stream that needs to be used by a viewer application to display the annotation/form field when the user places the mouse pointer over the annotation/form field (and does not hold down the mouse button).

Parameters:

rolloverAppearance - the specified appearance stream

See Also:

setNormalAppearance(PdfAppearanceStream), setDownAppearance(PdfAppearanceStream), getNormalAppearance(), getDownAppearance(), getRolloverAppearance()