public class

RedactionAnnotation

java.lang.Object
↳	com.pspdfkit.annotations.Annotation
	↳	com.pspdfkit.annotations.BaseRectsAnnotation
		↳	com.pspdfkit.annotations.RedactionAnnotation

Class Overview

Represents a redaction annotation on the document. The text marked by this annotation will be completely removed once the redaction is applied. To mark text for redaction just place the RedactionAnnotation above the text, you can use getPageTextRects(int, int, int) to find the correct bounds for the text. Any glyphs that intersect the redaction bounding box will be redacted, they don't need to be covered completely. Call applyRedactions() to apply the redactions persistently.

NOTE: This requires the Redaction component license to use.

Summary

[Expand]

Inherited Constants

From class com.pspdfkit.annotations.Annotation

[Expand]

Inherited Fields

From class com.pspdfkit.annotations.Annotation

Public Constructors
	RedactionAnnotation(int pageIndex, List<RectF> rects) Creates a new redaction annotation.

Public Methods
int	getFillColor() Returns a fill color associated with this redaction or `Color#BLACK` if no color is set.
int	getOutlineColor() Returns the color used for the redaction's border in its preview state.
String	getOverlayText() Returns the text that should be displayed at the specified `rects` when a redaction has been applied.
final AnnotationType	getType() Gets the annotation type of the annotation.
void	setOutlineColor(int outlineColor) Sets the color used for the redaction's border in its preview state, this color can't be transparent and any alpha information will be removed before applying it.
void	setOverlayText(String overlayText) Sets the text that should be displayed at the specified `rects` when a redaction has been applied.
void	setRepeatOverlayText(boolean repeatOverlayText) Defines whether the overlay text should be drawn only once, or repeated to fill the whole bounding box.
boolean	shouldRepeatOverlayText() Returns `false` if the overlay text should be drawn only once, or `true` if it is repeated to fill the whole bounding box.
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.BaseRectsAnnotation

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 RedactionAnnotation (int pageIndex, List<RectF> rects)

Creates a new redaction annotation.

NOTE: This requires the Redaction component license to use, and will throw an InvalidPSPDFKitLicenseException if used without it.

Parameters

pageIndex	Page to which this annotation will be attached to.
rects	Rectangles that represent redactions for this annotation.

Throws

InvalidPSPDFKitLicenseException	When used without Redaction component.

Public Methods

public int getFillColor ()

Returns a fill color associated with this redaction or Color#BLACK if no color is set. Note that alpha channel is not taken into account the exception being Color#TRANSPARENT which allows you remove the fill color all together as long as an overlay text is specified.

Returns

Color of redaction or Color#BLACK if no color is set.

public int getOutlineColor ()

Returns the color used for the redaction's border in its preview state. Defaults to a red outline if nothing is specified.

Returns

Color of redaction's border or Color#RED if none is set.

public String getOverlayText ()

Returns the text that should be displayed at the specified rects when a redaction has been applied. Defaults to null, which means no text will be displayed.

Returns

The text that should be displayed at the specified rects when a redaction has been applied.

public final AnnotationType getType ()

Gets the annotation type of the annotation.

Returns

The type of the annotation. Makes down casting easier.

public void setOutlineColor (int outlineColor)

Sets the color used for the redaction's border in its preview state, this color can't be transparent and any alpha information will be removed before applying it.

Parameters

outlineColor	Color to use for redaction border.

public void setOverlayText (String overlayText)

Sets the text that should be displayed at the specified rects when a redaction has been applied.

Parameters

overlayText	The text that should be displayed when a redaction has been applied, or `null` so no text is displayed.

public void setRepeatOverlayText (boolean repeatOverlayText)

Defines whether the overlay text should be drawn only once, or repeated to fill the whole bounding box.

Parameters

repeatOverlayText	`true` to repeat the text across the bounding box, `false` so the overlay text is only drawn once.

public boolean shouldRepeatOverlayText ()

Returns false if the overlay text should be drawn only once, or true if it is repeated to fill the whole bounding box. Defaults to false, which means the text won't be repeated.

Returns

false if the overlay text is only drawn once, true if it is repeated to fill the whole bounding box.

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

RedactionAnnotation

Class Overview

Summary

Public Constructors

public RedactionAnnotation (int pageIndex, List<RectF> rects)

Parameters

Throws

Public Methods

public int getFillColor ()

Returns

public int getOutlineColor ()

Returns

public String getOverlayText ()

Returns

public final AnnotationType getType ()

Returns

public void setOutlineColor (int outlineColor)

Parameters

public void setOverlayText (String overlayText)

Parameters

public void setRepeatOverlayText (boolean repeatOverlayText)

Parameters

public boolean shouldRepeatOverlayText ()

Returns

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Parameters