public class

FileAttachment

extends Markup

java.lang.Object
↳	com.pdftron.pdf.Annot
	↳	com.pdftron.pdf.annots.Markup
		↳	com.pdftron.pdf.annots.FileAttachment

Class Overview

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

Summary

Constants
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.
int	e_Paperclip	The Constant e_Paperclip.
int	e_PushPin	The Constant e_PushPin.
int	e_Tag	The Constant e_Tag.
int	e_Unknown	The Constant e_Unknown.

[Expand]

Inherited Constants

From class com.pdftron.pdf.annots.Markup

From class com.pdftron.pdf.Annot

int	e_3D	The Constant e_3D.
int	e_Caret	The Constant e_Caret.
int	e_Circle	The Constant e_Circle.
int	e_FileAttachment	The Constant e_FileAttachment.
int	e_FreeText	The Constant e_FreeText.
int	e_Highlight	The Constant e_Highlight.
int	e_Ink	The Constant e_Ink.
int	e_Line	The Constant e_Line.
int	e_Link	The Constant e_Link.
int	e_Movie	The Constant e_Movie.
int	e_Polygon	The Constant e_Polygon.
int	e_Polyline	The Constant e_Polyline.
int	e_Popup	The Constant e_Popup.
int	e_PrinterMark	The Constant e_PrinterMark.
int	e_Projection	The Constant e_Projection.
int	e_Redact	The Constant e_Redact.
int	e_RichMedia	The Constant e_RichMedia.
int	e_Screen	The Constant e_Screen.
int	e_Sound	The Constant e_Sound.
int	e_Square	The Constant e_Square.
int	e_Squiggly	The Constant e_Squiggly.
int	e_Stamp	The Constant e_Stamp.
int	e_StrikeOut	The Constant e_StrikeOut.
int	e_Text	PDF supports the standard annotation types listed in the following enumeration (plug-in extensions may add new annotation types):.
int	e_TrapNet	The Constant e_TrapNet.
int	e_Underline	The Constant e_Underline.
int	e_Unknown	The Constant e_Unknown.
int	e_Watermark	The Constant e_Watermark.
int	e_Widget	The Constant e_Widget.
int	e_action_trigger_activate	Triggered when the annotation is activated.
int	e_action_trigger_annot_blur	Triggered when the annotation loses the input focus
int	e_action_trigger_annot_down	Triggered when the mouse button is pressed inside the annotation's active area
int	e_action_trigger_annot_enter	Triggered when the cursor enters the annotation's active area
int	e_action_trigger_annot_exit	Triggered when the cursor exits the annotation's active area
int	e_action_trigger_annot_focus	Triggered when the annotation receives the input focus
int	e_action_trigger_annot_page_close	Triggered when the page containing the annotation is closed
int	e_action_trigger_annot_page_invisible	Triggered when the page containing the annotation is no longer visible in the interactive PDF processor's user interface
int	e_action_trigger_annot_page_open	Triggered when the page containing the annotation is opened
int	e_action_trigger_annot_page_visible	Triggered when the page containing the annotation becomes visible
int	e_action_trigger_annot_up	Triggered when the mouse button is released inside the annotation's active area
int	e_down	The Constant e_down.
int	e_hidden	The Constant e_hidden.
int	e_invisible	Flags specifying various characteristics of the annotation.
int	e_locked	The Constant e_locked.
int	e_locked_contents	The Constant e_locked_contents.
int	e_no_rotate	The Constant e_no_rotate.
int	e_no_view	The Constant e_no_view.
int	e_no_zoom	The Constant e_no_zoom.
int	e_normal	An annotation can define as many as three separate appearances: The normal appearance is used when the annotation is not interacting with the user.
int	e_print	The Constant e_print.
int	e_read_only	The Constant e_read_only.
int	e_rollover	The Constant e_rollover.
int	e_toggle_no_view	The Constant e_toggle_no_view.

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

Public Methods
void	SetFileSpec(FileSpec file) Set the file specification.
void	SetIconName(String icon) Set the icon type using a string.
static FileAttachment	create(Doc doc, Rect pos, String path) Creates a file attachment annotation.
static FileAttachment	create(Doc doc, Rect pos, String path, String icon_name) Creates a file attachment annotation.
void	export() The function saves the data referenced by this File Attachment to an external file.
void	export(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".
String	getIconName() Get the icon type as a string.
void	setIcon(int type) Set the icon type using an entry of the enum "Icon".

[Expand]

Inherited Methods

From class com.pdftron.pdf.annots.Markup

int	getBorderEffect() Gets the Border Effect of the Markup Annotation.
double	getBorderEffectIntensity() Gets the Border Effect Intensity of the Markup Annotation.
Rect	getContentRect() Gets the inner bounding rectangle of the Square.
Date	getCreationDates() Gets the creation date of the Markup Annotation.
ColorPt	getInteriorColor() Gets the interior color of the Square.
int	getInteriorColorCompNum() Gets the number indicating interior color space of the Square.
double	getOpacity() Gets the contant opacity value corresponding to the annotation.
Rect	getPadding() Gets the rectangle difference of the Square.
Popup	getPopup() Gets the Popup object associated with this Markup annotation.
String	getSubject() Gets subject of the Markup Annotation.
String	getTitle() Gets the title of the Markup Annotation.
void	rotateAppearance(double angle) Rotates the appearance of the Markup Annotation.
void	setBorderEffect(int effect) Sets the Border Effect of the Markup Annotation.
void	setBorderEffectIntensity(double intensity) Sets the Border Effect Intensity of the Markup Annotation.
void	setContentRect(Rect cr) Sets the inner bounding rectangle of the Square.
void	setCreationDates(Date date) Sets the creation date of the Markup Annotation.
void	setInteriorColor(ColorPt cpt, int comp_num) Sets the interior color of the Square.
void	setOpacity(double opacity) Sets the contant opacity value corresponding to the annotation.
void	setPadding(double padding) Sets the rectangle difference of the Square.
void	setPadding(Rect rd) Sets the rectangle difference of the Square.
void	setPopup(Popup popup) Sets the Popup object associated with this Markup annotation.
void	setSubject(String title) Sets subject of the Markup Annotation.
void	setTitle(String title) Sets the title of the Markup Annotation.

From class com.pdftron.pdf.Annot

int	GetStructParent() Get the struct parent of an annotation.
static Annot	__Create(long impl, Object ref)
long	__GetHandle()
Object	__GetRefHandle()
static Annot	create(Doc doc, int type, Rect pos) Creates a new annotation of a given type, in the specified document.
void	deleteCustomData(String key) Deletes custom data associated with the given key.
boolean	equals(Object d) Compares two annotations for equality.
void	flatten(Page page) Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page.
String	getActiveAppearanceState() Get the annotation's active appearance state.
Obj	getAppearance(int annot_state, String app_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Obj	getAppearance() Get the annotation's appearance for the given combination of annotation and appearance states.
Obj	getAppearance(int annot_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Annot.BorderStyle	getBorderStyle() Get the border style for the annotation.
ColorPt	getColorAsCMYK() Get an annotation's color.
ColorPt	getColorAsGray() Get an annotation's color.
ColorPt	getColorAsRGB() Get an annotation's color.
int	getColorCompNum() Get the color space the annotation's color is represented in.
String	getContents() Get the annotation contents.
String	getCustomData(String key) Returns custom data associated with the given key.
Date	getDate() Gets an annotation's last modified date.
boolean	getFlag(int flag) Determine if the give flag is marked flagged
Obj	getOptionalContent() Get optional content of an annotation.
Page	getPage() Get the page the annotation is associated with.
Rect	getRect() Get annoation bound rectangle
int	getRotation() Get the rotation value of the annotation.
Obj	getSDFObj() Get the SDFObj.
Obj	getTriggerAction(int trigger) Get the Action associated with the selected Annot Trigger event.
int	getType() Get the annotation type.
Obj	getUniqueID() Get the annotiation unique ID.
Rect	getVisibleContentBox() It is possible during viewing that GetRect does not return the most accurate bounding box of what is actually rendered.
int	hashCode()
boolean	isMarkup() Checks if annoation is markup.
boolean	isValid() Checks if Annot is valid.
void	refreshAppearance() Regenerates the appearance stream for the annotation.
void	refreshAppearance(RefreshOptions opts) A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
void	removeAppearance() Removes the annotation's default appearance.
void	removeAppearance(int annot_state, String app_state) Removes the annotation's appearance for the given combination of annotation and appearance states.
void	resize(Rect pos) Resize annotation
void	setActiveAppearanceState(String astate) Set the annotation's active appearance state.
void	setAppearance(Obj app_stream, int annot_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void	setAppearance(Obj app_stream) Set the annotation's appearance for the given combination of annotation and appearance states.
void	setAppearance(Obj app_stream, int annot_state, String app_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void	setBorderStyle(Annot.BorderStyle bs) Set the border style for the annotation.
void	setColor(ColorPt cpt) Set an annotation's color.
void	setColor(ColorPt cpt, int comp_num) Set an annotation's color.
void	setContents(String ct) Set annotation contents.
void	setCustomData(String key, String value) Sets the custom data associated with the specified key.
void	setDate(Date date) Sets an annotation's last modified date.
void	setDateToNow() Sets an annotation's last modified date to the current time.
void	setFlag(int flag, boolean value) Set the value of given Flag.
void	setOptionalContent(Obj oc) Set optional content of an annotation.
void	setPage(Page page) Set the reference to a page the annotation is associated with.
void	setRect(Rect pos) Set the size and location of an annotation on its page.
void	setRotation(int rot) Set the rotation value of the annotation.
void	setStructParent(int keyval) Set the struct parent of an annotation.
void	setUniqueID(String icon_name) Set the unique identifier for this annotation.

From class java.lang.Object

Constants

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.

Constant Value: 0 (0x00000000)

public static final int e_Paperclip

The Constant e_Paperclip.

Constant Value: 2 (0x00000002)

public static final int e_PushPin

The Constant e_PushPin.

Constant Value: 1 (0x00000001)

public static final int e_Tag

The Constant e_Tag.

Constant Value: 3 (0x00000003)

public static final int e_Unknown

The Constant e_Unknown.

Constant Value: 4 (0x00000004)

Public Constructors

public FileAttachment (Obj d)

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

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

Parameters

d	the input Cos/SDF object

public FileAttachment ()

Creates an empty FileAttachment annotation.

public FileAttachment (Annot annot)

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

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

Parameters

annot	input annotation object

Throws

PDFNetException

Public Methods

public void SetFileSpec (FileSpec file)

Set the file specification.

Parameters

file	The file associated with this annotation.

Throws

PDFNetException

public void SetIconName (String icon)

Set the icon type using a string. (Optional)

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

Parameters

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

Throws

PDFNetException

public static FileAttachment create (Doc doc, Rect pos, String path)

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, in user space coordinates. Note that FileAttachment icons can differ in their appearance dimensions, so you may want to match these Rectangle dimensions or the aspect ratio to avoid a squished or stretched appearance: e_Graph: 40 x 40 e_PushPin: 28 x 40 e_Paperclip: 14 x 34 e_Tag: 40 x 32
path	The path to the file which should be attached

Returns

A new file attachment annotation.

Throws

PDFNetException

public static FileAttachment create (Doc doc, Rect pos, String path, String icon_name)

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, in user space coordinates. Note that FileAttachment icons can differ in their appearance dimensions, so you may want to match these Rectangle dimensions or the aspect ratio to avoid a squished or stretched appearance: e_Graph: 40 x 40 e_PushPin: 28 x 40 e_Paperclip: 14 x 34 e_Tag: 40 x 32
path	The path to the file which should be attached
icon_name	An icon to be used in displaying the annotation, default is PushPin.

Returns

A new file attachment annotation.

Throws

PDFNetException

public void export ()

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.

Throws

PDFNetException

public void export (String save_as)

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.

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

public FileSpec getFileSpec ()

Get the file specification.

Returns

The file associated with this annotation.

Throws

PDFNetException

public int getIcon ()

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

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

Returns

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

Throws

PDFNetException

public String getIconName ()

Get the icon type as a string.

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

Returns

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

Throws

PDFNetException

public void setIcon (int type)

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

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

Parameters

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

Throws

PDFNetException

Classes

Enums

FileAttachment

Class Overview

Summary

Constants

public static final int e_Graph

public static final int e_Paperclip

public static final int e_PushPin

public static final int e_Tag

public static final int e_Unknown

Public Constructors

public FileAttachment (Obj d)

Parameters

public FileAttachment ()

public FileAttachment (Annot annot)

Parameters

Throws

Public Methods

public void SetFileSpec (FileSpec file)

Parameters

Throws

public void SetIconName (String icon)

Parameters

Throws

public static FileAttachment create (Doc doc, Rect pos, String path)

Parameters

Returns

Throws

public static FileAttachment create (Doc doc, Rect pos, String path, String icon_name)

Parameters

Returns

Throws

public void export ()

Throws

public void export (String save_as)

Parameters

Throws

public FileSpec getFileSpec ()

Returns

Throws

public int getIcon ()

Returns

Throws

public String getIconName ()

Returns

Throws

public void setIcon (int type)

Parameters

Throws