Foxit PDF SDK
|
Public Member Functions | |
HitData () | |
Constructor. | |
HitData (HitData other) | |
Constructor, with another hit data object. More... | |
String | getComment () |
Get hit rule comment to explain more details about the rule. More... | |
String | getName () |
Get hit rule name. More... | |
int | getPage_index () |
Get page index, starting from 0. More... | |
int | getSeverity () |
Get the check severity of current hit data. More... | |
WStringArray | getTrigger_values () |
Get array of trigger values. More... | |
int | getTriggered_count () |
Get represents how many times the hit operation for current data has been triggered during verifying or converting process. More... | |
void | setComment (String value) |
Set hit rule comment to explain more details about the rule. More... | |
void | setName (String value) |
Set hit rule name. More... | |
void | setPage_index (int value) |
Set page index, starting from 0. More... | |
void | setSeverity (int value) |
Set the check severity of current hit data. More... | |
void | setTrigger_values (WStringArray value) |
Set array of trigger values. More... | |
void | setTriggered_count (int value) |
Set represents how many times the hit operation for current data has been triggered during verifying or converting process. More... | |
Static Public Attributes | |
static final int | e_CheckSeverityError = 3 |
Error severity. | |
static final int | e_CheckSeverityInfo = 1 |
Info severity. | |
static final int | e_CheckSeverityWarning = 2 |
Warning severity. | |
This class represents a hit data. Hit data represents the data for a hit operation triggered during verifying or converting process.
com.foxit.sdk.addon.compliance.HitData.HitData | ( | HitData | other | ) |
Constructor, with another hit data object.
[in] | other | Another hit data object. |
com.foxit.sdk.addon.compliance.HitData.getComment | ( | ) |
Get hit rule comment to explain more details about the rule.
com.foxit.sdk.addon.compliance.HitData.getName | ( | ) |
Get hit rule name.
com.foxit.sdk.addon.compliance.HitData.getPage_index | ( | ) |
Get page index, starting from 0.
com.foxit.sdk.addon.compliance.HitData.getSeverity | ( | ) |
Get the check severity of current hit data.
com.foxit.sdk.addon.compliance.HitData.getTrigger_values | ( | ) |
Get array of trigger values.
com.foxit.sdk.addon.compliance.HitData.getTriggered_count | ( | ) |
Get represents how many times the hit operation for current data has been triggered during verifying or converting process.
com.foxit.sdk.addon.compliance.HitData.setComment | ( | String | value | ) |
Set hit rule comment to explain more details about the rule.
[in] | value | Hit rule comment to explain more details about the rule. |
com.foxit.sdk.addon.compliance.HitData.setName | ( | String | value | ) |
Set hit rule name.
[in] | value | Hit rule name. |
com.foxit.sdk.addon.compliance.HitData.setPage_index | ( | int | value | ) |
Set page index, starting from 0.
[in] | value | Page index, starting from 0. -1 means current hit data was hit in document level. |
com.foxit.sdk.addon.compliance.HitData.setSeverity | ( | int | value | ) |
Set the check severity of current hit data.
[in] | value | The check severity of current hit data. Please refer to values starting from com.foxit.sdk.addon.compliance.HitData.e_CheckSeverityInfo and this should be one of these values. |
com.foxit.sdk.addon.compliance.HitData.setTrigger_values | ( | WStringArray | value | ) |
Set array of trigger values.
[in] | value | Array of trigger values. The count of triggered values is no more then triggered_count. |
com.foxit.sdk.addon.compliance.HitData.setTriggered_count | ( | int | value | ) |
Set represents how many times the hit operation for current data has been triggered during verifying or converting process.
[in] | value | Represents how many times the hit operation for current data has been triggered during verifying or converting process. |