pdftron.PDF.Annots

Class FileAttachment

java.lang.Object

pdftron.PDF.Annot

pdftron.PDF.Annots.Markup

pdftron.PDF.Annots.FileAttachment

public class FileAttachment
extends Markup

A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file.

Nested Class Summary

Nested classes/interfaces inherited from class pdftron.PDF.Annot

Annot.BorderStyle

Field Summary

Fields

Modifier and Type	Field and Description
static int	e_Graph For each FileAttachment annotation, one can specify the icon used to display the annotation by choosing one of the entries the following integer list.
static int	e_Paperclip The Constant e_Paperclip.
static int	e_PushPin The Constant e_PushPin.
static int	e_Tag The Constant e_Tag.
static int	e_Unknown The Constant e_Unknown.

Fields inherited from class pdftron.PDF.Annots.Markup

e_Cloudy, e_None

Fields inherited from class pdftron.PDF.Annot

e_3D, e_Caret, e_Circle, e_down, e_FileAttachment, e_FreeText, e_hidden, e_Highlight, e_Ink, e_invisible, e_Line, e_Link, e_locked, e_locked_contents, e_Movie, e_no_rotate, e_no_view, e_no_zoom, e_normal, e_Polygon, e_Polyline, e_Popup, e_print, e_PrinterMark, e_Projection, e_read_only, e_Redact, e_RichMedia, e_rollover, e_Screen, e_Sound, e_Square, e_Squiggly, e_Stamp, e_StrikeOut, e_Text, e_toggle_no_view, e_TrapNet, e_Underline, e_Watermark, e_Widget

Constructor Summary

Constructors

Constructor and Description
FileAttachment() Creates an empty FileAttachment annotation.
FileAttachment(Annot annot) Creates an FileAttachment annotation and initialize it using given annotation object.
FileAttachment(Obj d) Creates an FileAttachment annotation and initialize it using given Cos/SDF object.

Method Summary

Methods

Modifier and Type	Method and Description
static FileAttachment	create(Doc doc, Rect pos, java.lang.String path) Creates a file attachment annotation.
static FileAttachment	create(Doc doc, Rect pos, java.lang.String path, java.lang.String icon_name) Creates FileAttachment
void	export() The function saves the data referenced by this File Attachment to an external file.
void	export(java.lang.String save_as) The function saves the data referenced by this File Attachment to an external file.
FileSpec	getFileSpec() Get the file specification.
int	getIcon() Get the icon type as an entry of the enum "Icon".
java.lang.String	getIconName() Get the icon type as a string.
void	SetFileSpec(FileSpec file) Set the file specification.
void	setIcon(int type) Set the icon type using an entry of the enum "Icon".
void	SetIconName(java.lang.String icon) Set the icon type using a string.

Methods inherited from class pdftron.PDF.Annots.Markup

getBorderEffect, getBorderEffectIntensity, getContentRect, getCreationDates, getInteriorColor, getInteriorColorCompNum, getOpacity, getPadding, getPopup, getSubject, getTitle, setBorderEffect, SetBorderEffectIntensity, setContentRect, setCreationDates, setInteriorColor, setOpacity, SetPadding, setPopup, setSubject, setTitle

Methods inherited from class pdftron.PDF.Annot

__Create, __GetHandle, __GetRefHandle, create, equals, flatten, getActiveAppearanceState, getAppearance, getAppearance, getAppearance, getBorderStyle, getColorAsCMYK, getColorAsGray, getColorAsRGB, getColorCompNum, getContents, getDate, getFlag, getOptionalContent, getPage, getRect, getSDFObj, GetStructParent, getType, getUniqueID, isMarkup, isValid, refreshAppearance, removeAppearance, resize, setActiveAppearanceState, setAppearance, setAppearance, setAppearance, setBorderStyle, setColor, setContents, setDate, setFlag, setOptionalContent, setPage, setRect, setStructParent, setUniqueID

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

e_Graph

public static final int e_Graph

For each FileAttachment annotation, one can specify the icon used to display the annotation by choosing one of the entries the following integer list. e_GraphPushPin - The icon has a graph push pin appearance. e_PaperclipTag - The icon has a paper clip tag appearance. e_Unknow - Undefined.

See Also:

Constant Field Values

e_PushPin

public static final int e_PushPin

The Constant e_PushPin.

See Also:

Constant Field Values

e_Paperclip

public static final int e_Paperclip

The Constant e_Paperclip.

See Also:

Constant Field Values

e_Tag

public static final int e_Tag

The Constant e_Tag.

See Also:

Constant Field Values

e_Unknown

public static final int e_Unknown

The Constant e_Unknown.

See Also:

Constant Field Values

Constructor Detail

FileAttachment

public FileAttachment(Obj d)

Creates an FileAttachment annotation and initialize it using given Cos/SDF object.

Parameters:

d - the input Cos/SDF object

Note:

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

FileAttachment

public FileAttachment()

Creates an empty FileAttachment annotation.

FileAttachment

public FileAttachment(Annot annot)
               throws PDFNetException

Creates an FileAttachment annotation and initialize it using given annotation object.

Parameters:

annot - input annotation object

Throws:

PDFNetException

Note:

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Method Detail

create

public static FileAttachment create(Doc doc,
                    Rect pos,
                    java.lang.String path,
                    java.lang.String icon_name)
                             throws PDFNetException

Creates FileAttachment

Parameters:

doc - A document to which the annotation is added.

pos - A rectangle specifying the annotation's bounds, in user space coordinates.

path - path to the referenced file

icon_name - the The name of an icon to be used in displaying the annotation, default is PushPin.

Returns:

file attachment

Throws:

PDFNetException

create

public static FileAttachment create(Doc doc,
                    Rect pos,
                    java.lang.String path)
                             throws PDFNetException

Creates a file attachment annotation. A file attachment annotation contains a reference to a file, which typically is embedded in the PDF file.

Parameters:

doc - A document to which the annotation is added.

pos - A rectangle specifying the annotation's bounds, specified in user space coordinates.

path - the path

Returns:

A new file attachment annotation.

Throws:

PDFNetException

Note:

PDF Viewer applications should provide predefined icon appearances for at least the following standard names: Graph PushPin Paperclip Tag. Additional names may be supported as well. Default value: PushPin.

export

public void export(java.lang.String save_as)
            throws PDFNetException

The function saves the data referenced by this File Attachment to an external file. If the file is embedded, the function saves the embedded file. If the file is not embedded, the function will copy the external file. If the file is not embedded and the external file can't be found, the function returns false.

Parameters:

save_as - An optional parameter indicating the filepath and filename where the data should be saved. If this parameter is not specified the function will attempt to save the file using FileSpec.GetFilePath().

Throws:

PDFNetException

export

public void export()
            throws PDFNetException

The function saves the data referenced by this File Attachment to an external file. If the file is embedded, the function saves the embedded file. If the file is not embedded, the function will copy the external file. If the file is not embedded and the external file can't be found, the function returns false.

Throws:

PDFNetException

getFileSpec

public FileSpec getFileSpec()
                     throws PDFNetException

Get the file specification.

Returns:

The file associated with this annotation.

Throws:

PDFNetException

SetFileSpec

public void SetFileSpec(FileSpec file)
                 throws PDFNetException

Set the file specification.

Parameters:

file - The file associated with this annotation.

Throws:

PDFNetException

getIcon

public int getIcon()
            throws PDFNetException

Get the icon type as an entry of the enum "Icon".

Returns:

The enum "Icon" entry associated with this FileAttachment annotation.

Throws:

PDFNetException

Note:

The entry specifies the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard names: GraphPushPin PaperclipTag Additional names may be supported as well. Default value: PushPin. The annotation dictionary’s Appearance(AP) entry, if present, shall take precedence over the this entry

setIcon

public void setIcon(int type)
             throws PDFNetException

Set the icon type using an entry of the enum "Icon". (Optional)

Parameters:

type - The enum "Icon" entry associated with this FileAttachment annotation.

Throws:

PDFNetException

Note:

The entry specifies the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard names: GraphPushPin PaperclipTag Additional names may be supported as well. Default value: PushPin. The annotation dictionary’s Appearance(AP) entry, if present, shall take precedence over the this entry

getIconName

public java.lang.String getIconName()
                             throws PDFNetException

Get the icon type as a string.

Returns:

The string specifying the icon type associated with this FileAttachment annotation.

Throws:

PDFNetException

Note:

the string spedifies the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard names: GraphPushPin PaperclipTag Additional names may be supported as well. Default value: PushPin. The annotation dictionary’s Appearance(AP) entry, if present, shall take precedence over the this entry

SetIconName

public void SetIconName(java.lang.String icon)
                 throws PDFNetException

Set the icon type using a string. (Optional)

Parameters:

icon - The string specifying the icon type associated with this FileAttachment annotation.

Throws:

PDFNetException

Note:

the string spedifies the name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the following standard names: GraphPushPin PaperclipTag Additional names may be supported as well. Default value: PushPin. The annotation dictionary’s Appearance(AP) entry, if present, shall take precedence over the this entry