public class

WidgetAnnotation

java.lang.Object
↳	com.pspdfkit.annotations.Annotation
	↳	com.pspdfkit.annotations.LinkAnnotation
		↳	com.pspdfkit.annotations.WidgetAnnotation

Class Overview

Represents the appearance of a field in interactive forms. For form elements with text, the text color comes from the color property of Annotation. Use getFormElement() to access associated FormElement.

Summary

Constants
float	FONT_SIZE_AUTO	The font size value used by `setFontSize(float)` and `getFontSize()` to represent automatic font sizing of text form elements.

[Expand]

Inherited Constants

From class com.pspdfkit.annotations.Annotation

[Expand]

Inherited Fields

From class com.pspdfkit.annotations.Annotation

Public Methods
Action	getAdditionalAction(AnnotationTriggerEvent triggerEvent) Returns the action that should be executed on annotation trigger event.
Map<AnnotationTriggerEvent, Action>	getAdditionalActions() Returns a map of additional actions keyed by their trigger events.
int	getBorderColor() Returns the border color of this annotation or `Color#TRANSPARENT` if no color is set.
float	getFontSize() Returns the font size of this widget annotation in PDF points.
FormElement	getFormElement() Returns a form element for widget annotation.
Maybe<FormElement>	getFormElementAsync() Returns a form element for widget annotation, asynchronously.
AnnotationType	getType() Gets the annotation type of the annotation.
VerticalTextAlignment	getVerticalTextAlignment() Returns the vertical text alignment used by this widget annotation.
void	setAdditionalAction(AnnotationTriggerEvent triggerEvent, Action action) Sets the action that should be executed for the given annotation trigger event.
void	setBorderColor(int color) Sets the border color for this annotation.
void	setFontSize(float fontSize) Sets the font size for this widget annotation in PDF points.
void	setVerticalTextAlignment(VerticalTextAlignment verticalAlignment) Sets the vertical text alignment to use in this widget annotation.

[Expand]

Inherited Methods

From class com.pspdfkit.annotations.LinkAnnotation

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 float FONT_SIZE_AUTO

The font size value used by setFontSize(float) and getFontSize() to represent automatic font sizing of text form elements. If set, PSPDFKit will automatically grow and shrink the content of the form element to fit the annotation's bounding box.

Public Methods

public Action getAdditionalAction (AnnotationTriggerEvent triggerEvent)

Returns the action that should be executed on annotation trigger event.

Returns

Action to be performed once the trigger event occurs.

public Map<AnnotationTriggerEvent, Action> getAdditionalActions ()

Returns a map of additional actions keyed by their trigger events.

Returns

Additional actions dictionary or null if no additional actions are set.

public int getBorderColor ()

Returns the border color of this annotation or Color#TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications.

Returns

Color of annotations border or Color#TRANSPARENT if no color is set.

public float getFontSize ()

Returns the font size of this widget annotation in PDF points. If set to FONT_SIZE_AUTO, PSPDFKit will automatically adjust the font size of the annotation, so that the content fills the bounding box.

Returns

The font size of this widget annotation, or FONT_SIZE_AUTO if auto-sizing of the annotation's content is enabled.

public FormElement getFormElement ()

Returns a form element for widget annotation.

Note: this call may block for a while and should not be invoked on the main thread.

Note: This call requires forms feature in your license.

Returns

A form element value or null if it doesn't exist.

public Maybe<FormElement> getFormElementAsync ()

Returns a form element for widget annotation, asynchronously.

Note: This call requires forms feature in your license.

Returns

Maybe emitting the FormElement or just completing in case the form element is null.

public AnnotationType getType ()

Gets the annotation type of the annotation.

Returns

The type of the annotation. Makes down casting easier.

public VerticalTextAlignment getVerticalTextAlignment ()

Returns the vertical text alignment used by this widget annotation.

Returns

One of VerticalTextAlignment.

public void setAdditionalAction (AnnotationTriggerEvent triggerEvent, Action action)

Sets the action that should be executed for the given annotation trigger event.

Parameters

triggerEvent	Event for which to set the action.
action	Action to be executed when `triggerEvent` occurs, `null` to remove existing action.

public void setBorderColor (int color)

Sets the border color for this annotation. Border color usually redirects to color, unless overridden to have a real backing store (this is the case for WidgetAnnotation).

Note: The annotation will only store the RGB part and discard the alpha channel set here. Annotation opacity is set via the setAlpha(float) property.

Parameters

color	The border color or `Color#TRANSPARENT` to clear the field.

public void setFontSize (float fontSize)

Sets the font size for this widget annotation in PDF points. If set to FONT_SIZE_AUTO, PSPDFKit will automatically adjust the font size of the widget annotation so that its content fills the annotation's bounding box.

// Set a font size of 14 points to a widget annotation.
 widgetAnnotation.setFontSize(14.0f);

 // Enable auto-sizing of the annotation's content.
 widgetAnnotation.setFontSize(WidgetAnnotation.FONT_SIZE_AUTO);

Parameters

fontSize	The font size to set for this annotation. If set to `FONT_SIZE_AUTO`, PSPDFKit will enable automatic sizing of the content, to fill the bounding box of this annotation.

public void setVerticalTextAlignment (VerticalTextAlignment verticalAlignment)

Sets the vertical text alignment to use in this widget annotation. One of VerticalTextAlignment.

Parameters

verticalAlignment	The vertical alignment to use for the text of this widget annotation.

Interfaces

Classes

Annotations

Enums

WidgetAnnotation

Class Overview

See Also

Summary

Constants

public static final float FONT_SIZE_AUTO

See Also

Public Methods

public Action getAdditionalAction (AnnotationTriggerEvent triggerEvent)

Returns

public Map<AnnotationTriggerEvent, Action> getAdditionalActions ()

Returns

public int getBorderColor ()

Returns

public float getFontSize ()

Returns

See Also

public FormElement getFormElement ()

Returns

public Maybe<FormElement> getFormElementAsync ()

Returns

public AnnotationType getType ()

Returns

public VerticalTextAlignment getVerticalTextAlignment ()

Returns

public void setAdditionalAction (AnnotationTriggerEvent triggerEvent, Action action)

Parameters

public void setBorderColor (int color)

Parameters

public void setFontSize (float fontSize)

Parameters

See Also

public void setVerticalTextAlignment (VerticalTextAlignment verticalAlignment)

Parameters