Foxit PDF SDK
|
Public Member Functions | |
Control (Control other) | |
Constructor, with another form control object. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
int | getAlignment () throws com.foxit.sdk.PDFException |
Get the alignment value. More... | |
DefaultAppearance | getDefaultAppearance () throws com.foxit.sdk.PDFException |
Get the default appearance data. More... | |
String | getExportValue () throws com.foxit.sdk.PDFException |
Get export mapping name when related form field is check box or radio button. More... | |
Field | getField () throws com.foxit.sdk.PDFException |
Get the related form field. More... | |
int | getIndex () throws com.foxit.sdk.PDFException |
Get the index of current form control among all the controls of related form field. More... | |
Widget | getWidget () throws com.foxit.sdk.PDFException |
Get the related widget annotation. More... | |
PDFDictionary | getWidgetDict () throws com.foxit.sdk.PDFException |
Get the dictionary of related widget annotation. More... | |
boolean | isChecked () throws com.foxit.sdk.PDFException |
Check if the current form control is checked when related form field is check box or radio button. More... | |
boolean | isDefaultChecked () throws com.foxit.sdk.PDFException |
Check if the current form control is checked by default when related form field is check box or radio button. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
void | setAlignment (int alignment) throws com.foxit.sdk.PDFException |
Set alignment property of current form control. More... | |
void | setChecked (boolean checked_status) throws com.foxit.sdk.PDFException |
Set the check state of current form control when related form field is check box or radio button. More... | |
void | setDefaultAppearance (DefaultAppearance default_ap) throws com.foxit.sdk.PDFException |
Set default appearance data. More... | |
void | setDefaultChecked (boolean checked_status) throws com.foxit.sdk.PDFException |
Set the default check state of current form control when related form field is check box or radio button. More... | |
void | setExportValue (String value) throws com.foxit.sdk.PDFException |
Set export mapping name when related form field is check box or radio button. More... | |
Foxit PDF SDK defines "form control" to associate form field with its related widget annotations. A form field may have one or more form controls, and each form control is associated with a widget annotation. A form control object can be retrieved by following functions:
Form control also offers functions to get related form field object and widget annotation object.
Function Form.addControl can be used to add a new form control to a form field, and function Form.removeControl can be used to remove a form control.
com.foxit.sdk.pdf.interform.Control.Control | ( | Control | other | ) |
Constructor, with another form control object.
[in] | other | Another form control object. |
synchronized void com.foxit.sdk.pdf.interform.Control.delete | ( | ) |
Clean up related resources immediately.
Reimplemented from com.foxit.sdk.common.Base.
int com.foxit.sdk.pdf.interform.Control.getAlignment | ( | ) | throws com.foxit.sdk.PDFException |
Get the alignment value.
Alignment is a property for variable text and it is only useful for text field, list box and combo box as related form field, which may contain variable text as their content.
If related form field is a text field or list box and it has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used in this case.
DefaultAppearance com.foxit.sdk.pdf.interform.Control.getDefaultAppearance | ( | ) | throws com.foxit.sdk.PDFException |
Get the default appearance data.
String com.foxit.sdk.pdf.interform.Control.getExportValue | ( | ) | throws com.foxit.sdk.PDFException |
Get export mapping name when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return an empty string.
Field com.foxit.sdk.pdf.interform.Control.getField | ( | ) | throws com.foxit.sdk.PDFException |
Get the related form field.
int com.foxit.sdk.pdf.interform.Control.getIndex | ( | ) | throws com.foxit.sdk.PDFException |
Get the index of current form control among all the controls of related form field.
Widget com.foxit.sdk.pdf.interform.Control.getWidget | ( | ) | throws com.foxit.sdk.PDFException |
Get the related widget annotation.
PDFDictionary com.foxit.sdk.pdf.interform.Control.getWidgetDict | ( | ) | throws com.foxit.sdk.PDFException |
Get the dictionary of related widget annotation.
boolean com.foxit.sdk.pdf.interform.Control.isChecked | ( | ) | throws com.foxit.sdk.PDFException |
Check if the current form control is checked when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return false.
boolean com.foxit.sdk.pdf.interform.Control.isDefaultChecked | ( | ) | throws com.foxit.sdk.PDFException |
Check if the current form control is checked by default when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return false.
boolean com.foxit.sdk.pdf.interform.Control.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void com.foxit.sdk.pdf.interform.Control.setAlignment | ( | int | alignment | ) | throws com.foxit.sdk.PDFException |
Set alignment property of current form control.
Alignment is a property for variable text and it is only useful for text field, list box and combo box as related form field, which may contain variable text as their content.
If related form field is a text field or list box and it has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used in this case.
[in] | alignment | New default alignment type of variable text. Please refer to values starting from com.foxit.sdk.common.Constants.e_AlignmentLeft and this should be one of these values. If other values is used to set, com.foxit.sdk.common.Constants.e_AlignmentLeft will be used by default. |
void com.foxit.sdk.pdf.interform.Control.setChecked | ( | boolean | checked_status | ) | throws com.foxit.sdk.PDFException |
Set the check state of current form control when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | checked_status | true means checked, and false means not checked. |
void com.foxit.sdk.pdf.interform.Control.setDefaultAppearance | ( | DefaultAppearance | default_ap | ) | throws com.foxit.sdk.PDFException |
Set default appearance data.
[in] | default_ap | The new default appearance. flags of input data can be used to decide which information is/are to be updated with the new data; for those no updated data, they will keep to use old data. If text_size of input default appearance data is 0, that means the text size should be calculated automatically. |
void com.foxit.sdk.pdf.interform.Control.setDefaultChecked | ( | boolean | checked_status | ) | throws com.foxit.sdk.PDFException |
Set the default check state of current form control when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | checked_status | true means checked by default, and false means not checked by default. |
void com.foxit.sdk.pdf.interform.Control.setExportValue | ( | String | value | ) | throws com.foxit.sdk.PDFException |
Set export mapping name when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | value | The new export mapping name. It should not be an empty string. |