Summary: Inherited Constants | Inherited Fields | Methods | Inherited Methods | [Expand All]

public class

WidgetAnnotation

extends LinkAnnotation

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

[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.
FormElement	getFormElement() Returns a form element for widget annotation.
Maybe<FormElement>	getFormElementAsync() Returns a form element for widget annotation, asynchronously.
float	getTextSize() Returns the text size set to this annotation.
AnnotationType	getType() Gets the annotation type of the annotation.
void	setAdditionalAction(AnnotationTriggerEvent triggerEvent, Action action) Sets the action that should be executed for the given annotation trigger event.

[Expand]

Inherited Methods

From class com.pspdfkit.annotations.LinkAnnotation

From class com.pspdfkit.annotations.Annotation

boolean	equals(Object o)
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 `TRANSPARENT` if no color is set.
List<Integer>	getBorderDashArray() Returns currently set dash array or `null` if no pattern is set.
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 object or `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.
int	getFillColor() Returns a fill color associated with this object or `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.
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.
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.
boolean	hasFlag(AnnotationFlags flag) Test annotation flag.
boolean	hasLockedContents() Check if the annotation has locked contents - i.e.
int	hashCode()
boolean	isAttached() Whether the annotation is attached to the document and it has a valid object number.
boolean	isLocked() Check if the annotation is locked - i.e.
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.
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	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	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 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 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 float getTextSize ()

Returns the text size set to this annotation.

Returns

Text size for this annotation (in PDF points).

public AnnotationType getType ()

Gets the annotation type of the annotation.

Returns

The type of the annotation. Makes down casting easier.

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.

Interfaces

Classes

Annotations

Enums

WidgetAnnotation

Class Overview

See Also

Summary

Public Methods

public Action getAdditionalAction (AnnotationTriggerEvent triggerEvent)

Returns

public Map<AnnotationTriggerEvent, Action> getAdditionalActions ()

Returns

public FormElement getFormElement ()

Returns

public Maybe<FormElement> getFormElementAsync ()

Returns

public float getTextSize ()

Returns

public AnnotationType getType ()

Returns

public void setAdditionalAction (AnnotationTriggerEvent triggerEvent, Action action)

Parameters