Foxit PDF SDK
|
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. | |
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.
- (int) getIndex |
Get the index of XFA Widget in related XFA page.
- (NSString *) getName: | (FSXFAWidgetWidgetNameType) | type |
Get Widget name.
[in] | type | Name type. Please refer to values starting from FSXFAWidgetWidgetNameTypeField and this should be one of these values. |
- (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.
- (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.
- (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.
- (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.
- (FSXFAWidgetWidgetType) getType |
Get type of XFA widget.
- (FSXFAPage *) getXFAPage |
Get the related XFA page, to which current XFA widget belongs.
- (id) initWithOther: | (FSXFAWidget*) | other |
Constructor, with another XFA widget object.
[in] | other | Another XFA widget object. |
- (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.
- (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- (BOOL) onChar: | (int) | input_char | |
flags: | (unsigned int) | flags | |
Call this function when a character code is being input.
[in] | input_char | A character code, in UTF16-LE encoding. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (FSXFAWidgetHitTestArea) onHitTest: | (FSPointF*) | point |
Call this function to do hit test for a specified point.
[in] | point | A point to be tested. |
- (BOOL) onKeyDown: | (unsigned int) | key_code | |
flags: | (unsigned int) | flags | |
Call this function when key on the keyboard is down.
[in] | key_code | The key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onKeyUp: | (unsigned int) | key_code | |
flags: | (unsigned int) | flags | |
Call this function when key on the keyboard is up.
[in] | key_code | The key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onLButtonDoubleClick: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when left mouse button is double-clicked .
[in] | point | A point where left mouse button is double-clicked in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onLButtonDown: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when left mouse button is down.
[in] | point | A point where left mouse button is down in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onLButtonUp: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when left mouse button is up.
[in] | point | A point where left mouse button is up in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onMouseEnter |
Call this function when mouse enters current XFA widget.
- (BOOL) onMouseExit |
Call this function when mouse exits.
- (BOOL) onMouseMove: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when mouse moves.
[in] | point | A point where left mouse button moves in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onRButtonDown: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when right mouse is down.
[in] | point | A point where right mouse button is down in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onRButtonUp: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when right button is up.
[in] | point | A point where right mouse button is up in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (void) resetData |
Reset XFA Widget Data.