Foxit PDF SDK
com.foxit.sdk.pdf.FillSignObject Class Reference
Inheritance diagram for com.foxit.sdk.pdf.FillSignObject:
com.foxit.sdk.common.Base com.foxit.sdk.pdf.SignatureFillSignObject com.foxit.sdk.pdf.TextFillSignObject

Public Member Functions

 FillSignObject (FillSignObject other)
 Constructor, with another fill-sign object. More...
 
 FillSignObject ()
 Constructor.
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean generateContent () throws com.foxit.sdk.PDFException
 Generate content for current fill-sign object. More...
 
RectF getRect () throws com.foxit.sdk.PDFException
 Get rectangle, in PDF coordinate system. More...
 
int getType () throws com.foxit.sdk.PDFException
 Get fill-sign type. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
void move (PointF point, float width, float height, int rotation)
 Move current fill-sign object. More...
 
- Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void delete ()
 Clean up related resources immediately. More...
 

Detailed Description

Class FillSignObject is the base class for all kinds of fill-sign object. This class offers base functions to get type, to move a fill-sign object or to generate content for a fill-sign object.

Constructor & Destructor Documentation

◆ FillSignObject()

com.foxit.sdk.pdf.FillSignObject.FillSignObject ( FillSignObject  other)

Constructor, with another fill-sign object.

Parameters
[in]otherAnother fill-sign object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.FillSignObject.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ generateContent()

boolean com.foxit.sdk.pdf.FillSignObject.generateContent ( ) throws com.foxit.sdk.PDFException

Generate content for current fill-sign object.

For fill-sign object with type com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeSignature or com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeInitialsSignature , function SignatureFillSignObject.setBitmap should be called first.

Returns
true means success, while false means failure.

◆ getRect()

RectF com.foxit.sdk.pdf.FillSignObject.getRect ( ) throws com.foxit.sdk.PDFException

Get rectangle, in PDF coordinate system.

Returns
Fill-sign object rectangle. If there is no rectangle information, a RectF object with all 0 values would be returned.

◆ getType()

int com.foxit.sdk.pdf.FillSignObject.getType ( ) throws com.foxit.sdk.PDFException

Get fill-sign type.

Returns
Fill-sign type. Please refer to values starting from com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeText and this would be one of these values.

◆ isEmpty()

boolean com.foxit.sdk.pdf.FillSignObject.isEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ move()

void com.foxit.sdk.pdf.FillSignObject.move ( PointF  point,
float  width,
float  height,
int  rotation 
)

Move current fill-sign object.

Parameters
[in]pointNew left-bottom point for current fill-sign object, in PDF coordinate system.
[in]widthNew width for current fill-sign object.
[in]heightNew height for current fill-sign object.
[in]rotationRotation status information. This rotation value includes the view rotation and page ratation property information. Please refer to values starting from com.foxit.sdk.common.Constants.e_Rotation0 and this should be one of these values except com.foxit.sdk.common.Constants.e_RotationUnknown .
Returns
None.