Foxit PDF SDK
FSXFAWidget Class Reference
Inheritance diagram for FSXFAWidget:
FSBase

Instance Methods

(int) - getIndex
 Get the index of XFA Widget in related XFA page.
More...
 
(NSString *) - getName:
 Get Widget name.
More...
 
(FSWidgetChoiceOptionArray *) - getOptions
 Get options of a choice list or an Exclusion Group (for radion button only).
More...
 
(FSXFAWidgetPresenceProperty- getPresence
 Get the presence property of the XFA widget.
More...
 
(FSRectF *) - getRect
 Get rectangle of XFA widget.
More...
 
(FSSignature *) - getSignature
 Get the signature object from current XFA widget.
More...
 
(FSXFAWidgetWidgetType- getType
 Get type of XFA widget.
More...
 
(FSXFAPage *) - getXFAPage
 Get the related XFA page, to which current XFA widget belongs.
More...
 
(id) - initWithOther:
 Constructor, with another XFA widget object.
More...
 
(BOOL) - isChecked
 Check if current XFA widget is checked when it is a check box or a radio button.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 
(BOOL) - onChar:flags:
 Call this function when a character code is being input.
More...
 
(FSXFAWidgetHitTestArea- onHitTest:
 Call this function to do hit test for a specified point.
More...
 
(BOOL) - onKeyDown:flags:
 Call this function when key on the keyboard is down.
More...
 
(BOOL) - onKeyUp:flags:
 Call this function when key on the keyboard is up.
More...
 
(BOOL) - onLButtonDoubleClick:flags:
 Call this function when left mouse button is double-clicked .
More...
 
(BOOL) - onLButtonDown:flags:
 Call this function when left mouse button is down.
More...
 
(BOOL) - onLButtonUp:flags:
 Call this function when left mouse button is up.
More...
 
(BOOL) - onMouseEnter
 Call this function when mouse enters current XFA widget.
More...
 
(BOOL) - onMouseExit
 Call this function when mouse exits.
More...
 
(BOOL) - onMouseMove:flags:
 Call this function when mouse moves.
More...
 
(BOOL) - onRButtonDown:flags:
 Call this function when right mouse is down.
More...
 
(BOOL) - onRButtonUp:flags:
 Call this function when right button is up.
More...
 
(void) - resetData
 Reset XFA Widget Data.
More...
 

Properties

NSString * value
 Get or Set the value string.

 

Detailed Description

Class FSXFAWidget represents the XFA widget which is retrieved from XFA page object.
To access the menu of XFA widget, please construct a FSWidgetMenu object with FSXFAWidget object.

See also
FSWidgetMenu

Method Documentation

◆ getIndex()

- (int) getIndex

Get the index of XFA Widget in related XFA page.

Returns
The index of XFA Widget in related XFA page.

◆ getName:()

- (NSString *) getName: (FSXFAWidgetWidgetNameType type

Get Widget name.

Parameters
[in]typeName type. Please refer to values starting from FSXFAWidgetWidgetNameTypeField and this should be one of these values.
Returns
Widget name string.

◆ getOptions()

- (FSWidgetChoiceOptionArray *) getOptions

Get options of a choice list or an Exclusion Group (for radion button only).

Applicable for choice list and Exclusion Group (for radion button only). For types that are not applicable, this function will return an empty array.

Returns
A choice option array.

◆ getPresence()

- (FSXFAWidgetPresenceProperty) getPresence

Get the presence property of the XFA widget.

The presence property controls the participation of the associated object in different phases of processing.

Returns
The presence property of the XFA widget.

◆ getRect()

- (FSRectF *) getRect

Get rectangle of XFA widget.

Widget rectangle is defined in XFA coordinate. XFA coordinate is defined as original point in left top, x-axis pointing to right and y-axis pointing down.

Returns
The rectangle of XFA widget.

◆ getSignature()

- (FSSignature *) getSignature

Get the signature object from current XFA widget.

Applicable only when current XFA widget represents a signature. For types that are not applicable, this function will throw exception FSErrUnsupported.

Returns
A signature object.

◆ getType()

- (FSXFAWidgetWidgetType) getType

Get type of XFA widget.

Returns
The hit test area. Please refer to values starting from FSXFAWidgetWidgetTypeBarcode and this would be one of these values.

◆ getXFAPage()

- (FSXFAPage *) getXFAPage

Get the related XFA page, to which current XFA widget belongs.

Returns
An XFA page object.

◆ initWithOther:()

- (id) initWithOther: (FSXFAWidget*)  other

Constructor, with another XFA widget object.

Parameters
[in]otherAnother XFA widget object.

◆ isChecked()

- (BOOL) isChecked

Check if current XFA widget is checked when it is a check box or a radio button.

Applicable for check box or radio button as related XFA widget. For types that are not applicable, this function will return NO.

Returns
YES means checked, while NO means unchecked or failure.

◆ 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.

◆ onChar:flags:()

- (BOOL) onChar: (int)  input_char
flags: (unsigned int)  flags 

Call this function when a character code is being input.

Parameters
[in]input_charA character code, in UTF16-LE encoding.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onHitTest:()

- (FSXFAWidgetHitTestArea) onHitTest: (FSPointF*)  point

Call this function to do hit test for a specified point.

Parameters
[in]pointA point to be tested.
Returns
The hit test area. Please refer to values starting from FSXFAWidgetHitTestAreaUnknown and this would be one of these values.

◆ onKeyDown:flags:()

- (BOOL) onKeyDown: (unsigned int)  key_code
flags: (unsigned int)  flags 

Call this function when key on the keyboard is down.

Parameters
[in]key_codeThe key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onKeyUp:flags:()

- (BOOL) onKeyUp: (unsigned int)  key_code
flags: (unsigned int)  flags 

Call this function when key on the keyboard is up.

Parameters
[in]key_codeThe key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onLButtonDoubleClick:flags:()

- (BOOL) onLButtonDoubleClick: (FSPointF*)  point
flags: (unsigned int)  flags 

Call this function when left mouse button is double-clicked .

Parameters
[in]pointA point where left mouse button is double-clicked in XFA page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onLButtonDown:flags:()

- (BOOL) onLButtonDown: (FSPointF*)  point
flags: (unsigned int)  flags 

Call this function when left mouse button is down.

Parameters
[in]pointA point where left mouse button is down in XFA page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onLButtonUp:flags:()

- (BOOL) onLButtonUp: (FSPointF*)  point
flags: (unsigned int)  flags 

Call this function when left mouse button is up.

Parameters
[in]pointA point where left mouse button is up in XFA page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onMouseEnter()

- (BOOL) onMouseEnter

Call this function when mouse enters current XFA widget.

Returns
YES means success, while NO means failure.

◆ onMouseExit()

- (BOOL) onMouseExit

Call this function when mouse exits.

Returns
YES means success, while NO means failure.

◆ onMouseMove:flags:()

- (BOOL) onMouseMove: (FSPointF*)  point
flags: (unsigned int)  flags 

Call this function when mouse moves.

Parameters
[in]pointA point where left mouse button moves in XFA page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onRButtonDown:flags:()

- (BOOL) onRButtonDown: (FSPointF*)  point
flags: (unsigned int)  flags 

Call this function when right mouse is down.

Parameters
[in]pointA point where right mouse button is down in XFA page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ onRButtonUp:flags:()

- (BOOL) onRButtonUp: (FSPointF*)  point
flags: (unsigned int)  flags 

Call this function when right button is up.

Parameters
[in]pointA point where right mouse button is up in XFA page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values.
Returns
YES means success, while NO means failure.

◆ resetData()

- (void) resetData

Reset XFA Widget Data.

Returns
None.