com.compdfkit.core.annotation.form

Class CPDFSignatureWidget

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.form.CPDFWidget

com.compdfkit.core.annotation.form.CPDFSignatureWidget

public class CPDFSignatureWidget
extends CPDFWidget

Represents a signature field in a form. This is usually used to place a signature onto a page using an TPDFInkAnnotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFSignatureWidget.TPDFSignatureWidgetAttr

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

CPDFWidget.BorderStyle, CPDFWidget.CheckStyle, CPDFWidget.WidgetType

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

CPDFAnnotation.AppearanceType, CPDFAnnotation.BorderEffectIntensity, CPDFAnnotation.CPDFBorderEffectType, 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	checkSignatureToWidget(CPDFSignature signature) Whether the widget corresponds to the signature.
CPDFAnnotationUndoAttr	getAnnotationAttr()
CPDFSignature	getSignature(CPDFDocument document) Get the signature of the signature widget.
boolean	isSigned() Whether signature form is signed.
boolean	resetForm() Resets forms.
boolean	signWithName() Sets Signature form as signed.
boolean	updateApWithBitmap(android.graphics.Bitmap bitmap) Updates form appearance by Bitmap.
boolean	updateApWithBitmap(android.graphics.Bitmap bitmap, CPDFImageScaleType imageScaleType) Updates form appearance by Bitmap.
boolean	updateApWithDigitalSigConfig(CPDFDigitalSigConfig config) Update AP of the signature Widget.
boolean	updateApWithImage(java.lang.String imagePath, java.lang.String smaskPath, CPDFImageScaleType imageScaleType) Updates form appearance by image.
boolean	updateApWithInk(android.graphics.PointF[][] path, float width, int color) Updates form appearance by Ink.
boolean	updateApWithText(java.lang.String text, java.lang.String fontName, int color) Updates form appearance by text.

Methods inherited from class com.compdfkit.core.annotation.form.CPDFWidget

clearBorderColor, clearFillColor, getBorderColor, getBorderStyles, getBorderWidth, getCheckStyle, getFieldFlag, getFieldName, getFieldType, getFillAlpha, getFillColor, getRect, getWidgetType, isReadOnly, setBorderColor, setBorderStyles, setBorderWidth, setCheckStyle, setFieldFlag, setFieldName, setFieldType, setFillAlpha, setFillColor, setReadOnly, setRect, updateAp, updateAp

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

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

Methods inherited from class java.lang.Object

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

Method Detail

isSigned

public boolean isSigned()

Whether signature form is signed.

Returns:

Signature Returns whether signature form is signed.

updateApWithText

public boolean updateApWithText(java.lang.String text,
                                java.lang.String fontName,
                                int color)

Updates form appearance by text.

Parameters:

text - Text content of signature

fontName - Font name of signature text, get font name byCPDFTextAttribute.FontNameHelper

color - Text color.

Returns:

Returns whether to successfully update form appearance by text.

See Also:

CPDFTextAttribute.FontNameHelper

updateApWithImage

public boolean updateApWithImage(java.lang.String imagePath,
                                 java.lang.String smaskPath,
                                 CPDFImageScaleType imageScaleType)

Updates form appearance by image.

Parameters:

imagePath - Original image path, image format must bejpeg, jpg

smaskPath - Mask path, image format must bejpeg, jpg

imageScaleType - The zoom rule for filling the image into the form, more: CPDFImageScaleType

Returns:

Returns whether to successfully update form appearance by image.

updateApWithBitmap

public boolean updateApWithBitmap(android.graphics.Bitmap bitmap,
                                  CPDFImageScaleType imageScaleType)

Updates form appearance by Bitmap.

Parameters:

bitmap - Image.

imageScaleType - The zoom rule for filling the image into the form, more: CPDFImageScaleType

Returns:

Returns whether to successfully update form appearance by Bitmap.

updateApWithInk

public boolean updateApWithInk(android.graphics.PointF[][] path,
                               float width,
                               int color)

Updates form appearance by Ink.

Parameters:

path - Points collection on the path, PointF[] means one line, PointF[][] means multiple lines.

width - Line width.

color - Line color.

Returns:

Returns whether to successfully update form appearance by notes.

getAnnotationAttr

public CPDFAnnotationUndoAttr getAnnotationAttr()

Specified by:

getAnnotationAttr in class CPDFAnnotation

applyAnnotationAttr

public void applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)

Specified by:

applyAnnotationAttr in class CPDFAnnotation

updateApWithBitmap

public boolean updateApWithBitmap(android.graphics.Bitmap bitmap)

Updates form appearance by Bitmap.

Overrides:

updateApWithBitmap in class CPDFAnnotation

Parameters:

bitmap - Image.

Returns:

Returns whether to successfully update form appearance by Bitmap.

signWithName

public boolean signWithName()

Sets Signature form as signed.

Returns:

Returns whether to successfully set Signature form as signed.

resetForm

public boolean resetForm()

Resets forms.

Overrides:

resetForm in class CPDFWidget

Returns:

Returns whether to successfully reset forms.

updateApWithDigitalSigConfig

public boolean updateApWithDigitalSigConfig(CPDFDigitalSigConfig config)

Update AP of the signature Widget.

Parameters:

config - Config data of the new AP.

Returns:

Returns true:update succeed, false:fail.

getSignature

public CPDFSignature getSignature(CPDFDocument document)

Get the signature of the signature widget.

Parameters:

document - CPDFDocument

Returns:

Returns the signature of the signature widget.

checkSignatureToWidget

public boolean checkSignatureToWidget(CPDFSignature signature)

Whether the widget corresponds to the signature.

Parameters:

signature - Signature

Returns:

Returns true:correspond, false:not correspond.