public class

StampAnnotation

extends Annotation
implements ResizableAnnotation

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

Class Overview

Represents a stamp or annotationBitmap annotation on the page.

Summary

[Expand]

Inherited Constants

From class com.pspdfkit.annotations.Annotation

[Expand]

Inherited Fields

From class com.pspdfkit.annotations.Annotation

Public Constructors
	StampAnnotation(int pageIndex, RectF rect, byte[] compressedBitmap) Creates a new stamp annotation with the passed bitmap as contents.
	StampAnnotation(int pageIndex, RectF rect, Bitmap bitmap) Creates a new stamp annotation with the passed bitmap as contents.
	StampAnnotation(int pageIndex, RectF rect, StampType stampType) Creates a new standard stamp annotation.
	StampAnnotation(int pageIndex, RectF rect, String title) Creates a new stamp with custom title.

Public Methods
void	adjustBoundsForRotation() This adjusts the annotations bounding box to the smallest possible size that will encompass the rotated annotations at it's default size.
synchronized Bitmap	getBitmap() Returns a bitmap from this stamp annotation if there is any.
Size	getMinimumSize() Returns the minimum size of the annotation.
int	getRotation() Returns the clockwise rotation of this stamp in degrees.
StampType	getStampType() Returns type of this stamp if it's one of the standard types listed in `StampType`.
String	getSubtitle() Returns text in second line of the stamp if any is available.
String	getTitle() Returns text in first line of the stamp if any is available.
AnnotationType	getType() Gets the annotation type of the annotation.
synchronized boolean	hasBitmap() Checks whether annotation is an annotationBitmap annotation.
synchronized void	setBitmap(Bitmap bitmap) Sets a custom bitmap for this stamp annotation.
synchronized void	setBitmap(byte[] compressedBitmap) Sets a custom bitmap for this stamp annotation.
void	setIsSignature(boolean isSignature) Sets whether this annotation is an electronic signature annotation.
void	setRotation(int rotation, boolean adjustBounds) Sets the rotation of this stamp.
void	setRotation(int rotation, Size contentSize) Sets the rotation of this stamp.
void	setRotation(int rotation, Size contentSize, boolean adjustBounds) Sets the rotation of this stamp.
void	setRotation(int rotation) Sets the rotation of this stamp.
synchronized void	setStampType(StampType stampType) Sets the type of stamp this is.
void	setSubtitle(String subtitle) Sets text displayed in a second smaller line of the stamp.
void	setTitle(String title) Sets text displayed in the first line of the stamp.
String	toInstantJson() Produces Instant JSON representation of 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

Public Constructors

public StampAnnotation (int pageIndex, RectF rect, byte[] compressedBitmap)

Creates a new stamp annotation with the passed bitmap as contents.

Parameters

pageIndex	Page to which this annotation will be attached to.
rect	Bounding rectangle for this annotations image.
compressedBitmap	JPEG compressed bitmap data to be stored into the annotation.

public StampAnnotation (int pageIndex, RectF rect, Bitmap bitmap)

Creates a new stamp annotation with the passed bitmap as contents.

Parameters

pageIndex	Page to which this annotation will be attached to.
rect	Bounding rectangle for this annotations image.
bitmap	Bitmap to be stored into the annotation.

public StampAnnotation (int pageIndex, RectF rect, StampType stampType)

Creates a new standard stamp annotation.

Parameters

pageIndex	Page to which this annotation will be attached to.
rect	Bounding rectangle for this annotations image.
stampType	Stamp type to display.

public StampAnnotation (int pageIndex, RectF rect, String title)

Creates a new stamp with custom title.

Note: Starting with PSPDFKit 5.0 the subject will no longer influence the appearance of the stamp annotation. The title is used instead. To create a standard stamp use StampAnnotation(int, RectF, StampType).

Parameters

pageIndex	Page to which this annotation will be attached to.
rect	Bounding rectangle for this annotations image.
title	Title to display on the stamp.

Public Methods

public void adjustBoundsForRotation ()

This adjusts the annotations bounding box to the smallest possible size that will encompass the rotated annotations at it's default size.

public synchronized Bitmap getBitmap ()

Returns a bitmap from this stamp annotation if there is any.

public Size getMinimumSize ()

Returns the minimum size of the annotation.

Returns

The minimum annotation size in PDF points.

public int getRotation ()

Returns the clockwise rotation of this stamp in degrees.

Returns

The clockwise rotation of this stamp in degrees.

public StampType getStampType ()

Returns type of this stamp if it's one of the standard types listed in StampType. Returns null if the stamp uses a non-standard title.

Returns

stamp type or null if the type isn't standard.

public String getSubtitle ()

Returns text in second line of the stamp if any is available.

Returns

subtitle of the annotation or null if none is set.

public String getTitle ()

Returns text in first line of the stamp if any is available.

Returns

title of the annotation or null if none is set.

public AnnotationType getType ()

Gets the annotation type of the annotation.

Returns

The type of the annotation. Makes down casting easier.

public synchronized boolean hasBitmap ()

Checks whether annotation is an annotationBitmap annotation.

public synchronized void setBitmap (Bitmap bitmap)

Sets a custom bitmap for this stamp annotation.

Note: This clears existing stamp type, title and subtitle.

Parameters

bitmap	Bitmap to be stored into the annotation.

public synchronized void setBitmap (byte[] compressedBitmap)

Sets a custom bitmap for this stamp annotation.

Note: This clears existing stamp type, title and subtitle.

Parameters

compressedBitmap	JPEG compressed bitmap data to be stored into the annotation.

public void setIsSignature (boolean isSignature)

Sets whether this annotation is an electronic signature annotation.

Parameters

isSignature	Whether or not this annotation is classed as an electronic signature. By default this is false.

public void setRotation (int rotation, boolean adjustBounds)

Sets the rotation of this stamp.

Parameters

rotation	The clockwise rotation in degrees.
adjustBounds	If `true` will also adjust the bounding box to match the new rotation.

public void setRotation (int rotation, Size contentSize)

Sets the rotation of this stamp. This will adjust the bounding box so rotating the annotation will cause the bounds to change.

Hint: If you are using a custom AP stream make sure that the bounding box aspect ratio matches the source aspect ratio exactly, otherwise the stamp will appear distorted when rotated.

See also setRotation(int). See also setRotation(int, Size, boolean).

Parameters

rotation	The clockwise rotation in degrees.
contentSize	The size of the annotation content, it will be rotated and scaled to fit inside the actual bounding box.

public void setRotation (int rotation, Size contentSize, boolean adjustBounds)

Sets the rotation of this stamp.

Hint: If you are using a custom AP stream make sure that the bounding box aspect ratio matches the source aspect ratio exactly, otherwise the stamp will appear distorted when rotated.

Parameters

rotation	The clockwise rotation in degrees.
contentSize	The size of the annotation content, it will be rotated and scaled to fit inside the actual bounding box.
adjustBounds	If `true` will also adjust the bounding box to match the new rotation.

public void setRotation (int rotation)

Sets the rotation of this stamp. This will adjust the bounding box so rotating the annotation will cause the bounds to change.

Hint: If you are using a custom AP stream make sure that the bounding box aspect ratio matches the source aspect ratio exactly, otherwise the stamp will appear distorted when rotated.

See also setRotation(int, Size). See also setRotation(int, boolean).

Parameters

rotation	The clockwise rotation in degrees.

public synchronized void setStampType (StampType stampType)

Sets the type of stamp this is.

Parameters

stampType	Stamp type to set.

public void setSubtitle (String subtitle)

Sets text displayed in a second smaller line of the stamp.

Parameters

subtitle	text to be displayed or `null` if none should be shown.

public void setTitle (String title)

Sets text displayed in the first line of the stamp.

Parameters

title	text to be displayed or `null` if the default should be shown.

public String toInstantJson ()

Produces Instant JSON representation of this annotation.

Note: Make sure the annotation is attached to the document before exporting it to Instant JSON.

Returns

Instant JSON representation for this annotation.

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

StampAnnotation

Class Overview

Summary

Public Constructors

public StampAnnotation (int pageIndex, RectF rect, byte[] compressedBitmap)

Parameters

public StampAnnotation (int pageIndex, RectF rect, Bitmap bitmap)

Parameters

public StampAnnotation (int pageIndex, RectF rect, StampType stampType)

Parameters

public StampAnnotation (int pageIndex, RectF rect, String title)

Parameters

Public Methods

public void adjustBoundsForRotation ()

public synchronized Bitmap getBitmap ()

public Size getMinimumSize ()

Returns

public int getRotation ()

Returns

public StampType getStampType ()

Returns

public String getSubtitle ()

Returns

public String getTitle ()

Returns

public AnnotationType getType ()

Returns

public synchronized boolean hasBitmap ()

public synchronized void setBitmap (Bitmap bitmap)

Parameters

public synchronized void setBitmap (byte[] compressedBitmap)

Parameters

public void setIsSignature (boolean isSignature)

Parameters

public void setRotation (int rotation, boolean adjustBounds)

Parameters

public void setRotation (int rotation, Size contentSize)

Parameters

public void setRotation (int rotation, Size contentSize, boolean adjustBounds)

Parameters

public void setRotation (int rotation)

Parameters

public synchronized void setStampType (StampType stampType)

Parameters

public void setSubtitle (String subtitle)

Parameters

public void setTitle (String title)

Parameters

public String toInstantJson ()

Returns

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Parameters