com.compdfkit.core.annotation

Class CPDFRedactAnnotation

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.CPDFRedactAnnotation

public class CPDFRedactAnnotation
extends CPDFAnnotation

Redaction Annotation used to remove content from a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFRedactAnnotation.CPDFRedactAnnotationAttr

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.CPDFAnnotation

CPDFAnnotation.AppearanceType, CPDFAnnotation.BorderEffectIntensity, CPDFAnnotation.CPDFBorderEffectType, CPDFAnnotation.Flags, CPDFAnnotation.MarkState, CPDFAnnotation.MediaSourceType, CPDFAnnotation.ReviewState, CPDFAnnotation.Type

Field Summary

Fields inherited from class com.compdfkit.core.annotation.CPDFAnnotation

index

Method Summary

Modifier and Type	Method and Description
void	applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)
boolean	applyRedaction() Applies redaction annotation.
boolean	clearFillColorBeforeApply() Removes the fill color displayed in the specified area before applying the redaction.
boolean	clearOutlineColor() Removes the color used for the redaction’s border in its marked state.
CPDFAnnotationUndoAttr	getAnnotationAttr()
int	getFillColor() Returns a fill color associated with this redaction or Color#BLACK if no color is set.
int	getFillColorBeforeApply() Gets the fill color displayed in the specified area before applying the redaction.
int	getOutlineColor() Gets the color used for the redaction’s border in its marked state.
java.lang.String	getOverLayText() Gets the text displayed in the specified area after applying the redaction.
android.graphics.RectF[]	getQuadRects() Gets the areas that should be covered by the redaction annotation.
CPDFFreetextAnnotation.Alignment	getTextAlignment() Gets the text alignment displayed in the specified area after applying the redaction.
CPDFTextAttribute	getTextDa() Gets the text attribute displayed in the specified area after applying the redaction.
boolean	setFillColor(int color) Sets the fill color for this annotation.
boolean	setFillColorBeforeApply(int color) Sets the fill color displayed in the specified area before applying the redaction.
boolean	setOutlineColor(int outlineColor) Sets the color used for the redaction’s border in its marked state.
boolean	setOverLayText(java.lang.String text) Sets the text displayed in the specified area after applying the redaction.
boolean	setQuadRects(android.graphics.RectF[] quadRects) Uses the rects property to set the areas that should be covered by the redaction annotation.
boolean	setTextAlignment(CPDFFreetextAnnotation.Alignment alignment) Sets the text alignment displayed in the specified area after applying the redaction.
boolean	setTextDa(CPDFTextAttribute textDa) Sets the text attribute displayed in the specified area after applying the redaction.

Methods inherited from class com.compdfkit.core.annotation.CPDFAnnotation

addToPage, close, createReplyAnnotation, disableListenAttrChanged, enableListenAttrChanged, equal, equal, getAllReplyAnnotations, getAnnotIndexFromNative, getAnnotPtr, getAppearance, getAppearanceByPixel, getApRotation, getBordEffectIntensity, getBordEffectType, getBorderWidth, getContent, getCreationDate, getFlags, getMarkedAnnotState, getName, getRecentlyModifyDate, getRect, getReviewAnnotState, getRotateRectPoint, getRotation, getSourceRect, getTitle, getType, getVertices, hasAp, isAllowCorrectAnnotationAp, isHidden, isLocked, isReadOnly, isValid, moveAnnotIndex, removeAp, removeFromPage, removeFromPageIncludeReplyAnnot, setAllowCorrectAnnotationAp, setAnnotTop, setBordEffectIntensity, setBordEffectType, setBorderWidth, setContent, setCreationDate, setFlags, setHidden, setLocked, setMarkedAnnotState, setName, setOnAnnotationChangedListener, setReadOnly, setRecentlyModifyDate, setRect, setReviewAnnotState, setRotation, setSourceRect, setTitle, setVertices, updateAp, updateApWithBitmap, updateApWithImage

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOverLayText

public java.lang.String getOverLayText()

Gets the text displayed in the specified area after applying the redaction.

Returns:

The text displayed in the specified area.

setOverLayText

public boolean setOverLayText(java.lang.String text)

Sets the text displayed in the specified area after applying the redaction.

Parameters:

text - The text displayed in the specified area.

Returns:

Returns whether to successfully set annotations of Redaction.

setTextDa

public boolean setTextDa(CPDFTextAttribute textDa)

Sets the text attribute displayed in the specified area after applying the redaction.

Parameters:

textDa - Font style.

Returns:

Returns whether to successfully set Redaction font style.

getTextDa

public CPDFTextAttribute getTextDa()

Gets the text attribute displayed in the specified area after applying the redaction.

Returns:

Returns text attribute.

setTextAlignment

public boolean setTextAlignment(CPDFFreetextAnnotation.Alignment alignment)

Sets the text alignment displayed in the specified area after applying the redaction.

Parameters:

alignment - Text alignment.

Returns:

Returns whether to successfully set text alignment of Redaction.

getTextAlignment

public CPDFFreetextAnnotation.Alignment getTextAlignment()

Gets the text alignment displayed in the specified area after applying the redaction.

Returns:

Returns text alignment of Redaction.

setFillColor

public boolean setFillColor(int color)

Sets the fill color for this annotation.

Parameters:

color - Color value (0x00000000~0xFFFFFFFF)

Returns:

Returns whether to successfully set color.

getFillColor

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 @link{Color#BLACK} Color#BLACK if no color is set. (0x00000000~0xFFFFFFFF)

setOutlineColor

public boolean setOutlineColor(int outlineColor)

Sets the color used for the redaction’s border in its marked state. Defaults to red.

Parameters:

outlineColor - color Color value (0x00000000~0xFFFFFFFF)

Returns:

Returns whether to successfully set color.

getOutlineColor

public int getOutlineColor()

Gets the color used for the redaction’s border in its marked state. Defaults to red.

Returns:

Returns color value (0x00000000~0xFFFFFFFF)

clearOutlineColor

public boolean clearOutlineColor()

Removes the color used for the redaction’s border in its marked state. Defaults to red.

Returns:

Returns whether to successfully clear outline color.

setQuadRects

public boolean setQuadRects(android.graphics.RectF[] quadRects)

Uses the rects property to set the areas that should be covered by the redaction annotation. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window. Convert function: CPDFPage.convertRectToPage(boolean, float, float, RectF).

Parameters:

quadRects - Array of quadrilateral points defining the bounds of the Redaction.

Returns:

Returns whether to successfully set the array of quadrilateral points defining the bounds of the redaction.

getQuadRects

public android.graphics.RectF[] getQuadRects()

Gets the areas that should be covered by the redaction annotation. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window. Convert function: CPDFPage.convertRectFromPage(boolean, float, float, RectF).

Returns:

Returns the array of quadrilateral points defining the bounds of the redaction.

getFillColorBeforeApply

public int getFillColorBeforeApply()

Gets the fill color displayed in the specified area before applying the redaction.

Returns:

Returns color value (0x00000000~0xFFFFFFFF)

setFillColorBeforeApply

public boolean setFillColorBeforeApply(int color)

Sets the fill color displayed in the specified area before applying the redaction.

Parameters:

color - Color value (0x00000000~0xFFFFFFFF)

Returns:

Returns whether to successfully set color.

clearFillColorBeforeApply

public boolean clearFillColorBeforeApply()

Removes the fill color displayed in the specified area before applying the redaction.

Returns:

Returns whether to successfully clear outline color.

applyRedaction

public boolean applyRedaction()

Applies redaction annotation.

Returns:

Returns whether to successfully apply redaction

getAnnotationAttr

public CPDFAnnotationUndoAttr getAnnotationAttr()

Specified by:

getAnnotationAttr in class CPDFAnnotation

applyAnnotationAttr

public void applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)

Specified by:

applyAnnotationAttr in class CPDFAnnotation