public abstract class

ShapeAnnotation

extends Annotation
implements ResizableAnnotation

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

Known Direct Subclasses

BaseLineAnnotation, CircleAnnotation, SquareAnnotation

Known Indirect Subclasses

LineAnnotation, PolygonAnnotation, PolylineAnnotation

Class Overview

Abstract base-class of all shape annotations: LineAnnotation, SquareAnnotation, CircleAnnotation, PolygonAnnotation, PolylineAnnotation. Shape annotations can also be measurement annotations if created using the measurement tools included with the Measurement Tools license component.

Summary

[Expand]

Inherited Constants

From class com.pspdfkit.annotations.Annotation

[Expand]

Inherited Fields

From class com.pspdfkit.annotations.Annotation

Public Methods
FloatPrecision	getMeasurementPrecision() Returns the `FloatPrecision` of this shape annotation if this is a measurement, `null` if not.
Scale	getMeasurementScale() Returns the `Scale` of this shape annotation if this is a measurement, `null` if not.
Size	getMinimumSize() Returns the minimum size of the annotation.
boolean	isMeasurement() Returns `true` when the annotation is a measurement annotation.
void	setMeasurementPrecision(FloatPrecision precision) Sets the `FloatPrecision` of this shape annotation.
void	setMeasurementScale(Scale scale) Sets the `Scale` of this shape annotation.
void	updateTransformationProperties(RectF newBoundingBox, RectF oldBoundingBox) Annotations may override this method to transform their properties (i.e.

Protected Methods
void	setMeasurementProperties(Scale scale, FloatPrecision precision) Once these are set, the shape becomes a measurement annotation.

[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 Methods

public FloatPrecision getMeasurementPrecision ()

Returns the FloatPrecision of this shape annotation if this is a measurement, null if not. This information can also be taken from getMeasurementInfo().

Returns

If this is a measurement, returns FloatPrecision for this annotation. If not a measurement, returns null.

public Scale getMeasurementScale ()

Returns the Scale of this shape annotation if this is a measurement, null if not. This information can also be taken from getMeasurementInfo().

Returns

If this is a measurement, returns Scale for this annotation. If not a measurement, returns null.

public Size getMinimumSize ()

Returns the minimum size of the annotation.

Returns

The minimum annotation size in PDF points.

public boolean isMeasurement ()

Returns true when the annotation is a measurement annotation. Measurement annotations can be: - LineAnnotation: Distance measurement - PolylineAnnotation: Perimeter measurement - PolygonAnnotation: Polygonal area measurement - CircleAnnotation: Elliptical area measurement - SquareAnnotation: Rectangular area measurement

Returns

true when the annotation is a measurement annotation.

public void setMeasurementPrecision (FloatPrecision precision)

Sets the FloatPrecision of this shape annotation. Throws an InvalidPSPDFKitLicenseException if measurement tools are not licensed.

Parameters

precision	`FloatPrecision` for this measurement annotation.

public void setMeasurementScale (Scale scale)

Sets the Scale of this shape annotation. Throws an InvalidPSPDFKitLicenseException if measurement tools are not licensed.

Parameters

scale	`Scale` for this measurement 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).

Protected Methods

protected void setMeasurementProperties (Scale scale, FloatPrecision precision)

Once these are set, the shape becomes a measurement annotation. Throws if measurements are not licensed.

Interfaces

Classes

Annotations

Enums

ShapeAnnotation

Class Overview

Summary

Public Methods

public FloatPrecision getMeasurementPrecision ()

Returns

public Scale getMeasurementScale ()

Returns

public Size getMinimumSize ()

Returns

public boolean isMeasurement ()

Returns

public void setMeasurementPrecision (FloatPrecision precision)

Parameters

public void setMeasurementScale (Scale scale)

Parameters

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Parameters

Protected Methods

protected void setMeasurementProperties (Scale scale, FloatPrecision precision)