public class

FileAnnotation

extends Annotation

java.lang.Object
↳	com.pspdfkit.annotations.Annotation
	↳	com.pspdfkit.annotations.FileAnnotation

Class Overview

Represents an annotation associated with EmbeddedFile.

Summary

Nested Classes
@interface	FileAnnotation.IconName	Denotes that a parameter must belong to on of these strings defined in `FileAnnotation`: `PUSH_PIN`, `PAPERCLIP`, `GRAPH`, `TAG`.

Constants
String	GRAPH
String	PAPERCLIP
String	PUSH_PIN
String	TAG

[Expand]

Inherited Constants

From class com.pspdfkit.annotations.Annotation

[Expand]

Inherited Fields

From class com.pspdfkit.annotations.Annotation

Public Constructors
	FileAnnotation(int pageIndex, RectF boundingBox, EmbeddedFileSource embeddedFileSource) Creates a new file annotation.

Public Methods
EmbeddedFile	getFile() Returns a file set for this annotation.
String	getIconName() Returns the name of the icon that should be displayed for this annotation.
AnnotationType	getType() Gets the annotation type of the annotation.
boolean	isLocked() Check if the annotation is locked - i.e.
boolean	isResizable() Check if the annotation is resizable, or if this is a non-resizable annotation.
void	setFileSource(EmbeddedFileSource fileSource) Replaces an embedded file associated with this annotation.
void	setIconName(String iconName) Sets the name of the icon that should be displayed for this annotation.
void	updateTransformationProperties(RectF newBoundingBox, RectF oldBoundingBox) Annotations may override this method to transform their properties (i.e.

[Expand]

Inherited Methods

From class com.pspdfkit.annotations.Annotation

void	attachBinaryInstantJsonAttachment(DataProvider dataProvider, String mimeType) Attaches a binary instant JSON attachment to the annotation.
boolean	equals(Object o)
String	fetchBinaryInstantJsonAttachment(OutputStream outputStream) If this annotation has a binary instant JSON attachment, this will write it into the provided OutputStream.
void	generateAppearanceStream() Regenerates the annotation's appearance stream if necessary.
Completable	generateAppearanceStreamAsync() Regenerates the annotation's appearance stream if necessary.
float	getAlpha() Returns the annotation's alpha.
AppearanceStreamGenerator	getAppearanceStreamGenerator() Returns custom appearance stream generator that overrides appearance stream generation of this annotation.
BlendMode	getBlendMode() Returns currently set blend mode.
int	getBorderColor() Returns the border color of this annotation or `Color#TRANSPARENT` if no color is set.
List<Integer>	getBorderDashArray() Returns currently set dash array or `null` if no pattern is set.
BorderEffect	getBorderEffect() Returns the current border effect on the annotation or `NO_EFFECT` if none is set.
float	getBorderEffectIntensity() Returns the current border effect intensity.
BorderStyle	getBorderStyle() Returns the current border style on the annotation or `NONE` if none is set.
float	getBorderWidth() Returns the border line width / thickness.
RectF	getBoundingBox(RectF rect) Position of this annotation on the page.
RectF	getBoundingBox() Position of this annotation on the page.
int	getColor() Returns a color associated with this annotation or `Color#TRANSPARENT` if no color is set.
String	getContents() Returns text contents of the annotation.
Annotation	getCopy(int pageIndex) Creates a copy of this annotation that isn't attached to the document with the page index set to given index.
Date	getCreatedDate() Returns the creation date of the annotation.
String	getCreator() Returns the name of the creator of this annotation.
JSONObject	getCustomData() Retrieves custom data for the annotation.
int	getFillColor() Returns a fill color associated with this object or `Color#TRANSPARENT` if no color is set.
EnumSet<AnnotationFlags>	getFlags() Annotation flags set.
Annotation	getInReplyTo() Retrieves the annotation this annotation replies to, or `null` it this annotation is not a reply or the license doesn't support replies feature.
Maybe<Annotation>	getInReplyToAsync() Retrieves the annotation this annotation replies to asynchronously.
String	getInstantRecordGroup() Gets instant record group of the annotation, or `null` if this annotation is detached.
MeasurementInfo	getMeasurementInfo() Returns `MeasurementInfo` when the annotation is a measurement annotation (see `isMeasurement()`, `null` if not.
MeasurementLabelValue	getMeasurementLabelValue(MeasurementProperties measurementProperties) Return the measurement label and value for this annotation if it is a measurement.
Size	getMinimumSize() Returns the minimum size of the annotation.
Date	getModifiedDate() Returns the date when this annotation was last modified.
String	getName() Returns the content of Title/Name field of this annotation.
int	getObjectNumber() The object number of this annotation inside the PDF document file.
int	getPageIndex() The page number to which this annotation belongs.
String	getRichText() Returns rich text contents of the annotation.
String	getSubject() Returns the subject of this annotation.
abstract AnnotationType	getType() Gets the annotation type of the annotation.
String	getUuid() A unique in-memory identifier for each annotation.
boolean	hasBinaryInstantJsonAttachment() Checks if this annotation has a binary instant JSON attachment.
boolean	hasFlag(AnnotationFlags flag) Test annotation flag.
boolean	hasLockedContents() Check if the annotation has locked contents - i.e.
int	hashCode()
boolean	isAttached() Tells whether this annotation is attached to a document.
boolean	isLocked() Check if the annotation is locked - i.e.
boolean	isMeasurement() Returns `true` when the annotation is a measurement annotation.
boolean	isModified() Returns whether the annotation is modified or not.
boolean	isReply() Whether the annotations is a reply to another annotation.
boolean	isResizable() Check if the annotation is resizable, or if this is a non-resizable annotation.
boolean	isSignature() Returns `true` when the annotation is a signature annotation.
void	renderToBitmap(Bitmap bitmap) Renders the appearance of this annotation into the passed bitmap.
void	renderToBitmap(Bitmap bitmap, AnnotationRenderConfiguration configuration) Renders the appearance of this annotation into the passed bitmap.
Single<Bitmap>	renderToBitmapAsync(Bitmap bitmap) Asynchronously renders the appearance of this annotation into the passed bitmap.
Single<Bitmap>	renderToBitmapAsync(Bitmap bitmap, AnnotationRenderConfiguration configuration) Asynchronously renders the appearance of this annotation into the passed bitmap.
void	setAlpha(float alpha) Sets the annotations' alpha value.
void	setAppearanceStreamGenerator(AppearanceStreamGenerator appearanceStreamGenerator) Sets custom appearance stream generator that overrides appearance stream generation of this annotation.
void	setBlendMode(BlendMode blendMode) Sets the blend mode used when generating annotation's appearance stream.
void	setBorderColor(int color) Sets the border color for this annotation.
void	setBorderDashArray(List<Integer> dashes) Sets a dash style for the border.
void	setBorderEffect(BorderEffect borderEffect) Sets a border effect for current annotation.
void	setBorderEffectIntensity(float borderEffectIntensity) Sets border effect intensity.
void	setBorderStyle(BorderStyle borderStyle) Sets a border style for current annotation.
void	setBorderWidth(float borderWidth) Sets border line width / thickness.
void	setBoundingBox(RectF newBoundingBox) Sets the position and size of this annotation on the page.
void	setColor(int color) Sets the color for this annotation.
void	setContents(String contents) Sets text contents of the annotation.
void	setCreatedDate(Date createdDate) Sets created date for this annotation.
void	setCreator(String creator) Sets the creator of this annotation.
void	setCustomData(JSONObject customData) Sets custom data to the annotation.
void	setFillColor(int color) Sets the fill color for this annotation.
void	setFlags(EnumSet<AnnotationFlags> flags) Sets annotation flags.
void	setInReplyTo(Annotation annotation) Sets the annotation that this annotation replies to.
void	setModifiedDate(Date modifiedDate) Sets last modified date for this annotation.
void	setName(String name) Sets Title / Name field for this annotation
void	setRichText(String richText) Sets rich text contents of the annotation.
void	setSubject(String subject) Sets the subject of this annotation.
String	toInstantJson() Produces Instant JSON representation of this annotation.
String	toString()
abstract void	updateTransformationProperties(RectF newBoundingBox, RectF oldBoundingBox) Annotations may override this method to transform their properties (i.e.

From class java.lang.Object

Constants

public static final String GRAPH

Constant Value: "Graph"

public static final String PAPERCLIP

Constant Value: "Paperclip"

public static final String PUSH_PIN

Constant Value: "PushPin"

public static final String TAG

Constant Value: "Tag"

Public Constructors

public FileAnnotation (int pageIndex, RectF boundingBox, EmbeddedFileSource embeddedFileSource)

Creates a new file annotation.

Parameters

pageIndex	Page to which this annotation will be attached to.
boundingBox	Annotation's bounding box on the page in PDF coordinates.
embeddedFileSource	Source of the file data that should be attached to the annotation.

Public Methods

public EmbeddedFile getFile ()

Returns a file set for this annotation.

Returns

Embedded file associated with this annotation or null if no embedded file is currently set.

public String getIconName ()

Returns the name of the icon that should be displayed for this annotation.

Returns

Icon name, {@value PUSH_PIN} by default.

public AnnotationType getType ()

Gets the annotation type of the annotation.

Returns

The type of the annotation. Makes down casting easier.

public boolean isLocked ()

Check if the annotation is locked - i.e. annotation can't be deleted or modified (except contents).

Returns

true if the annotation is locked or false if it can be freely modified.

public boolean isResizable ()

Check if the annotation is resizable, or if this is a non-resizable annotation.

Returns

true if the annotation can be resized (e.g. ink annotation) or false if it is a non-resizable one (e.g. note annotation).

public void setFileSource (EmbeddedFileSource fileSource)

Replaces an embedded file associated with this annotation.

Parameters

fileSource	Source for the embedded file data.

public void setIconName (String iconName)

Sets the name of the icon that should be displayed for this annotation.

Parameters

iconName	Icon name to be set.

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Annotations may override this method to transform their properties (i.e. points, rects, sizes) whenever the bounding box of the annotation changed.

Parameters

newBoundingBox	New bounding box of the annotation (in PDF points).
oldBoundingBox	Old bounding box of the annotation (in PDF points).

Interfaces

Classes

Annotations

Enums

FileAnnotation

Class Overview

Summary

Constants

public static final String GRAPH

public static final String PAPERCLIP

public static final String PUSH_PIN

public static final String TAG

Public Constructors

public FileAnnotation (int pageIndex, RectF boundingBox, EmbeddedFileSource embeddedFileSource)

Parameters

Public Methods

public EmbeddedFile getFile ()

Returns

public String getIconName ()

Returns

public AnnotationType getType ()

Returns

public boolean isLocked ()

Returns

public boolean isResizable ()

Returns

public void setFileSource (EmbeddedFileSource fileSource)

Parameters

public void setIconName (String iconName)

Parameters

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Parameters