public class

CircleAnnotation

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

Class Overview

Represents a circle on the page.

Summary

[Expand]
Inherited Constants
From class com.pspdfkit.annotations.Annotation
[Expand]
Inherited Fields
From class com.pspdfkit.annotations.Annotation
Public Constructors
CircleAnnotation(int pageIndex, RectF rect)
Creates a new circle annotation.
CircleAnnotation(int pageIndex, RectF rect, Scale scale, MeasurementPrecision precision)
Creates a measurement elliptical area annotation.
Public Methods
AnnotationType getType()
Gets the annotation type of the annotation.
Protected Methods
MeasurementLabelValue getMeasurementLabelValue(MeasurementProperties measurementProperties)
Return the measurement label and value for this annotation if it is a measurement.
[Expand]
Inherited Methods
From class com.pspdfkit.annotations.ShapeAnnotation
From class com.pspdfkit.annotations.Annotation
From class java.lang.Object

Public Constructors

public CircleAnnotation (int pageIndex, RectF rect)

Creates a new circle annotation.

Parameters
pageIndex Page to which this annotation will be attached to.
rect Bounding rectangle for this circle.

public CircleAnnotation (int pageIndex, RectF rect, Scale scale, MeasurementPrecision precision)

Creates a measurement elliptical area annotation. Will throw an exception if Measurement Tools are not licensed.

Parameters
pageIndex Page to which this annotation will be attached to.
rect Bounding rectangle for this circle.
scale Measurement Scale for the annotation.
precision Measurement MeasurementPrecision for the annotation.

Public Methods

public AnnotationType getType ()

Gets the annotation type of the annotation.

Returns
  • The type of the annotation. Makes down casting easier.

Protected Methods

protected MeasurementLabelValue getMeasurementLabelValue (MeasurementProperties measurementProperties)

Return the measurement label and value for this annotation if it is a measurement. Returns null if it's not a measurement. Overridden in child shape annotations who can be measurements. Calculates the measurement value based on the passed `measurementProperties` and shape size.

Parameters
measurementProperties the properties for this measurement. Including Scale and MeasurementPrecision.
Returns
  • The calculated measurement value and label, or null if it's not a measurement.