| java.lang.Object | ||
| ↳ | com.pdftron.pdf.OptionsBase | |
| ↳ | com.pdftron.pdf.HandwritingICROptions | |
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
HandwritingICROptions()
Constructor.
| |||||||||||
|
HandwritingICROptions(String json_string)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| HandwritingICROptions |
addIgnoreZonesForPage(RectCollection value, int page_num)
Adds an Ignore Zone to the IgnoreZonesForPage array.
| ||||||||||
| HandwritingICROptions |
addInclusionZonesForPage(RectCollection value, int page_num)
Adds an Inclusion Zone to the InclusionZonesForPage array.
| ||||||||||
| String |
getPages()
Gets the value Pages from the options object.
| ||||||||||
| HandwritingICROptions |
setPages(String value)
Sets the value for Pages in the options object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
Public Methods
public HandwritingICROptions addIgnoreZonesForPage (RectCollection value, int page_num)
Adds an Ignore Zone to the IgnoreZonesForPage array. Optional list of page areas to be excluded from analysis. Zones should be provided as a collection of Rects paired with a page number. The Rects are then applied to the corresponding page. Rects are specified in User Space coordinates. If this is set, the specified areas will not be analyzed. If neither this nor InclusionZonesForPage is set, the entire page will be analyzed.
Parameters
| value | List of page areas to be excluded from analysis. |
|---|---|
| page_num | The page number (1-indexed) to which the regions are applied. |
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public HandwritingICROptions addInclusionZonesForPage (RectCollection value, int page_num)
Adds an Inclusion Zone to the InclusionZonesForPage array. Optional list of page areas to be included in analysis (to the exclusion of all other areas). Zones should be provided as a collection of Rects paired with a page number. The Rects are then applied to the corresponding page. Rects are specified in User Space coordinates. If this is set, only the areas specified will be analyzed. If neither this nor IgnoreZonesForPage is set, the entire page will be analyzed.
Parameters
| value | List of page areas to be included in analysis. |
|---|---|
| page_num | The page number (1-indexed) to which the inclusion zones apply. |
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public String getPages ()
Gets the value Pages from the options object. Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are processed. The first page is page number 1.
Returns
- Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.
Throws
| PDFNetException |
|---|
public HandwritingICROptions setPages (String value)
Sets the value for Pages in the options object. Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are processed. The first page is page number 1.
Parameters
| value | Specifies a range of pages on which to perform handwriting extraction, such as "1-5". Open-ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|