Foxit PDF SDK  9.1
FSFillSignObject Class Reference
Inheritance diagram for FSFillSignObject:
FSBase FSSignatureFillSignObject FSTextFillSignObject

Instance Methods

(void) - dealloc
 
(BOOL) - generateContent
 Generate content for current fill-sign object.
More...
 
(void *) - getCptr
 
(FSFormXObject *) - getFormXObject
 
(FSRectF *) - getRect
 Get rectangle, in PDF coordinate system.
More...
 
(FSFillSignFillSignObjectType- getType
 Get fill-sign type.
More...
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithOther:
 Constructor, with another fill-sign object.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 
(void) - move:width:height:
 Move current fill-sign object.
More...
 
(void) - move:width:height:rotation:
 Move current fill-sign object.
More...
 

Additional Inherited Members

- Protected Attributes inherited from FSBase
BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

Class FSFillSignObject 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.

Method Documentation

◆ dealloc

- (void) dealloc

Reimplemented from FSBase.

Reimplemented in FSTextFillSignObject, and FSSignatureFillSignObject.

◆ generateContent

- (BOOL) generateContent

Generate content for current fill-sign object.

For fill-sign object with type FSFillSignFillSignObjectTypeSignature or FSFillSignFillSignObjectTypeInitialsSignature, function FSSignatureFillSignObject::setBitmap: should be called first.

Returns
YES means success, while NO means failure.

◆ getCptr

- (void*) getCptr

Reimplemented from FSBase.

Reimplemented in FSTextFillSignObject, and FSSignatureFillSignObject.

◆ getFormXObject

- (FSFormXObject*) getFormXObject

◆ getRect

- (FSRectF *) getRect

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

Get fill-sign type.

Returns
Fill-sign type. Please refer to values starting from FSFillSignFillSignObjectTypeText and this would be one of these values.

◆ init

- (id) init

Constructor.

Reimplemented in FSTextFillSignObject, and FSSignatureFillSignObject.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Reimplemented from FSBase.

Reimplemented in FSTextFillSignObject, and FSSignatureFillSignObject.

◆ initWithOther:

- (id) initWithOther: (FSFillSignObject*)  other

Constructor, with another fill-sign object.

Parameters
[in]otherAnother fill-sign object.

◆ isEmpty

- (BOOL) isEmpty

Check whether current object is empty or not.

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

Returns
YES means current object is empty, while NO means not.

◆ move:width:height:

- (void) move: (FSPointF*)  point
width: (float)  width
height: (float)  height 

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.
Returns
None.

◆ move:width:height:rotation:

- (void) move: (FSPointF*)  point
width: (float)  width
height: (float)  height
rotation: (FSRotation 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 rotation property information. Please refer to values starting from FSRotation0 and this should be one of these values except FSRotationUnknown.
Returns
None.