Public Member Functions | |
XFAWidget (XFAWidget other) | |
Constructor, with another XFA widget object. More... | |
int | getIndex () throws com.foxit.sdk.PDFException |
Get the index of XFA Widget in related XFA page. More... | |
int | getPresence () throws com.foxit.sdk.PDFException |
Get the presence property of the XFA widget. More... | |
RectF | getRect () throws com.foxit.sdk.PDFException |
Get rectangle of XFA widget. More... | |
int | getType () throws com.foxit.sdk.PDFException |
Get type of XFA widget. More... | |
String | getValue () throws com.foxit.sdk.PDFException |
Get the value string. More... | |
XFAPage | getXFAPage () throws com.foxit.sdk.PDFException |
Get the related XFA page, to which current XFA widget belongs. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
boolean | onChar (int input_char, int flags) throws com.foxit.sdk.PDFException |
Call this function when a character code is being input. More... | |
int | onHitTest (PointF point) throws com.foxit.sdk.PDFException |
Call this function to do hit test for a specified point. More... | |
boolean | onKeyDown (int key_code, int flags) throws com.foxit.sdk.PDFException |
Call this function when key on the keyboard is down. More... | |
boolean | onKeyUp (int key_code, int flags) throws com.foxit.sdk.PDFException |
Call this function when key on the keyboard is up. More... | |
boolean | onLButtonDoubleClick (PointF point, int flags) throws com.foxit.sdk.PDFException |
Call this function when left mouse button is double-clicked . More... | |
boolean | onLButtonDown (PointF point, int flags) throws com.foxit.sdk.PDFException |
Call this function when left mouse button is down. More... | |
boolean | onLButtonUp (PointF point, int flags) throws com.foxit.sdk.PDFException |
Call this function when left mouse button is up. More... | |
boolean | onMouseEnter () throws com.foxit.sdk.PDFException |
Call this function when mouse enters current XFA widget. More... | |
boolean | onMouseExit () throws com.foxit.sdk.PDFException |
Call this function when mouse exits. More... | |
boolean | onMouseMove (PointF point, int flags) throws com.foxit.sdk.PDFException |
Call this function when mouse moves. More... | |
boolean | onRButtonDown (PointF point, int flags) throws com.foxit.sdk.PDFException |
Call this function when right mouse is down. More... | |
boolean | onRButtonUp (PointF point, int flags) throws com.foxit.sdk.PDFException |
Call this function when right button is up. More... | |
void | resetData () throws com.foxit.sdk.PDFException |
Reset XFA Widget Data. More... | |
void | setValue (String value) throws com.foxit.sdk.PDFException |
Set the value string. More... | |
Static Public Attributes | |
static final int | e_HitTestAreaClient = 1 |
Hit test area: Client. | |
static final int | e_HitTestAreaHyperLink = 3 |
Hit test area: HyperLink. | |
static final int | e_HitTestAreaTitleBar = 2 |
Hit test area: Title Bar. | |
static final int | e_HitTestAreaUnknown = 0 |
Hit test area: Unknown. | |
static final int | e_PresenceHidden = 2 |
Presence property: Hidden. Participate in interaction but not layout or rendering. | |
static final int | e_PresenceInactive = 3 |
Presence property: Inactive. Do not participate in interaction, layout, or rendering. | |
static final int | e_PresenceInvisible = 4 |
Presence property: Invisible. Participate in interaction and layout but not rendering. | |
static final int | e_PresenceUnknown = 0 |
Presence property: Unknown. | |
static final int | e_PresenceVisible = 1 |
Presence property: Visible. Participate in interaction, layout, and rendering. | |
static final int | e_WidgetTypeArc = 3 |
XFA widget type: arc. | |
static final int | e_WidgetTypeBarcode = 0 |
XFA widget type: barcode. | |
static final int | e_WidgetTypeCheckButton = 2 |
XFA widget type: check button. | |
static final int | e_WidgetTypeChoiceList = 7 |
XFA widget type: choice list. | |
static final int | e_WidgetTypeDateTimeEdit = 4 |
XFA widget type: date time edit. | |
static final int | e_WidgetTypeImageEdit = 8 |
XFA widget type: image edit. | |
static final int | e_WidgetTypeLine = 9 |
XFA widget type: line. | |
static final int | e_WidgetTypeNumericEdit = 5 |
XFA widget type: numeric edit. | |
static final int | e_WidgetTypePasswordEdit = 10 |
XFA widget type: password edit. | |
static final int | e_WidgetTypePushButton = 1 |
XFA widget type: push button. | |
static final int | e_WidgetTypeRadioButton = 11 |
XFA widget type: radio button. | |
static final int | e_WidgetTypeRectangle = 12 |
XFA widget type: rectangle. | |
static final int | e_WidgetTypeSignature = 6 |
XFA widget type: signature. | |
static final int | e_WidgetTypeTextEdit = 13 |
XFA widget type: text edit. | |
static final int | e_WidgetTypeUnknown = 14 |
XFA widget type: unknown. | |
Class addon::xfa::XFAWidget represents the XFA widget which is retrieved from XFA page object.
To access the menu of XFA widget, please construct a addon::xfa::WidgetMenu object with addon::xfa::XFAWidget object.
com.foxit.sdk.addon.xfa.XFAWidget.XFAWidget | ( | XFAWidget | other | ) |
Constructor, with another XFA widget object.
other | Another XFAWidget object. |
int com.foxit.sdk.addon.xfa.XFAWidget.getIndex | ( | ) | throws com.foxit.sdk.PDFException |
Get the index of XFA Widget in related XFA page.
int com.foxit.sdk.addon.xfa.XFAWidget.getPresence | ( | ) | throws com.foxit.sdk.PDFException |
Get the presence property of the XFA widget.
The presence property controls the participation of the associated object in different phases of processing.
RectF com.foxit.sdk.addon.xfa.XFAWidget.getRect | ( | ) | throws com.foxit.sdk.PDFException |
Get rectangle of XFA widget.
int com.foxit.sdk.addon.xfa.XFAWidget.getType | ( | ) | throws com.foxit.sdk.PDFException |
Get type of XFA widget.
String com.foxit.sdk.addon.xfa.XFAWidget.getValue | ( | ) | throws com.foxit.sdk.PDFException |
Get the value string.
XFAPage com.foxit.sdk.addon.xfa.XFAWidget.getXFAPage | ( | ) | throws com.foxit.sdk.PDFException |
Get the related XFA page, to which current XFA widget belongs.
boolean com.foxit.sdk.addon.xfa.XFAWidget.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
boolean com.foxit.sdk.addon.xfa.XFAWidget.onChar | ( | int | input_char, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when a character code is being input.
input_char | A character code, in UTF16-LE encoding. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
int com.foxit.sdk.addon.xfa.XFAWidget.onHitTest | ( | PointF | point | ) | throws com.foxit.sdk.PDFException |
Call this function to do hit test for a specified point.
point | A point to be tested. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onKeyDown | ( | int | key_code, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when key on the keyboard is down.
key_code | The key code. Please refer to values starting from pdf::interform::e_VkeyUnknown and this should be one of these values. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onKeyUp | ( | int | key_code, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when key on the keyboard is up.
key_code | The key code. Please refer to values starting from pdf::interform::e_VkeyUnknown and this should be one of these values. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onLButtonDoubleClick | ( | PointF | point, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when left mouse button is double-clicked .
point | A point where left mouse button is double-clicked in XFA page, in PDF coordinate system. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onLButtonDown | ( | PointF | point, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when left mouse button is down.
point | A point where left mouse button is down in XFA page, in PDF coordinate system. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onLButtonUp | ( | PointF | point, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when left mouse button is up.
point | A point where left mouse button is up in XFA page, in PDF coordinate system. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onMouseEnter | ( | ) | throws com.foxit.sdk.PDFException |
Call this function when mouse enters current XFA widget.
boolean com.foxit.sdk.addon.xfa.XFAWidget.onMouseExit | ( | ) | throws com.foxit.sdk.PDFException |
Call this function when mouse exits.
boolean com.foxit.sdk.addon.xfa.XFAWidget.onMouseMove | ( | PointF | point, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when mouse moves.
point | A point where left mouse button moves in XFA page, in PDF coordinate system. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onRButtonDown | ( | PointF | point, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when right mouse is down.
point | A point where right mouse button is down in XFA page, in PDF coordinate system. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
boolean com.foxit.sdk.addon.xfa.XFAWidget.onRButtonUp | ( | PointF | point, |
int | flags | ||
) | throws com.foxit.sdk.PDFException |
Call this function when right button is up.
point | A point where right mouse button is up in XFA page, in PDF coordinate system. |
flags | Event flags. Please refer to values starting from pdf::interform::e_EventFlagShiftKey and this should be one or a combination of these values. |
void com.foxit.sdk.addon.xfa.XFAWidget.resetData | ( | ) | throws com.foxit.sdk.PDFException |
Reset XFA Widget Data.
void com.foxit.sdk.addon.xfa.XFAWidget.setValue | ( | String | value | ) | throws com.foxit.sdk.PDFException |
Set the value string.
value | A string as value to be set. It should not be an empty string. |