SignDoc SDK (Java)  5.0.0
SignDocFindTextOccurrence Class Reference

Information about text found by SignDocDocument.findText(). More...

Inheritance diagram for SignDocFindTextOccurrence:

Public Member Functions

 SignDocFindTextOccurrence ()
 
synchronized int getNumberOfClusters () throws SignDocException
 Get the number of clusters making up the found text. More...
 
synchronized SignDocTextCluster getCluster (int aIndex) throws SignDocException
 Get a cluster. More...
 
synchronized int getPage () throws SignDocException
 Get the page on which the glyphs of this object appear. More...
 
synchronized int[] getPages () throws SignDocException
 Get the pages on which the glyphs of this object appear. More...
 
synchronized int getUnicodeDirection () throws SignDocException
 Get the direction implied by the Unicode code points. More...
 
synchronized Rect[] getBoundingBoxes (int aPage, int aFlags) throws SignDocException
 Get bounding boxes for the glyphs of this object. More...
 
synchronized void close ()
 Destroy the underlying native object (for java.lang.AutoCloseable). More...
 

Static Public Attributes

static final int gbbf_single = 0x01
 Flag for getBoundingBoxes(): Compute a single bounding box, viz, the smallest rectangle containing all the glyph bounding boxes. More...
 
static final int gbbf_individual = 0x02
 Flag for getBoundingBoxes(): Return one bounding box per glyph. More...
 
static final int gbbf_logical = 0x04
 Flag for SIGNDOC_FindTextOccurrence_getBoundingBoxes(): Compute logical bounding boxes. More...
 

Protected Member Functions

void finalize () throws Throwable
 Finalize this object. More...
 

Detailed Description

Information about text found by SignDocDocument.findText().

There is no clone() function as SignDocFindTextOccurrence objects cannot be modified.

Constructor & Destructor Documentation

Member Function Documentation

synchronized void close ( )

Destroy the underlying native object (for java.lang.AutoCloseable).

After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.

void finalize ( ) throws Throwable
protected

Finalize this object.

Do not call this method unless you know what you are doing.

synchronized Rect [] getBoundingBoxes ( int  aPage,
int  aFlags 
) throws SignDocException

Get bounding boxes for the glyphs of this object.

Parameters
[in]aPageThe 1-based page number.
[in]aFlagsFlags controlling the behavior of this function, see gbbf_single, gbbf_individual, and gbbf_logical. Exactly one of these flags must be set.
Returns
The bounding boxes.
See also
getPages(), getUnicodeDirection(), SignDocTextCluster.getGlyphBoundingBox()
synchronized SignDocTextCluster getCluster ( int  aIndex) throws SignDocException

Get a cluster.

Parameters
[in]aIndexThe 0-based index of the cluster (logical order).

This function throws an exception if aIndex is out of range.

Returns
The cluster.
See also
getNumberOfClusters()
synchronized int getNumberOfClusters ( ) throws SignDocException

Get the number of clusters making up the found text.

Returns
The number of clusters.
synchronized int getPage ( ) throws SignDocException

Get the page on which the glyphs of this object appear.

The glyphs of a SignDocFindTextOccurrence object can appear on different pages, even on pages outside the range of pages passed to SignDocDocument.findText().

Returns
The 1-based page number of the page on which the glyphs appear or 0 if the glyphs appear on two or more different pages.
See also
getPages(), SignDocTextCluster.getGlyphPage(), SignDocTextCluster.getPage()
synchronized int [] getPages ( ) throws SignDocException

Get the pages on which the glyphs of this object appear.

The glyphs of a SignDocFindTextOccurrence object can appear on different pages, even on pages outside the range of pages passed to SignDocDocument.findText().

Returns
The 1-based page numbers of the pages on which the glyphs appear.
See also
getPage(), SignDocTextCluster.getGlyphPage(), SignDocTextCluster.getPages()
synchronized int getUnicodeDirection ( ) throws SignDocException

Get the direction implied by the Unicode code points.

A lot of characters (such as punctuation characters) do not imply a direction. Unless there is at least one character that defines a direction, 0 will be returned. 0 is also returned if there are conflicting directions.

Returns
-1 for RTL, 1 for LTR, 0 if the direction cannot be determined unambiguously.

Member Data Documentation

final int gbbf_individual = 0x02
static

Flag for getBoundingBoxes(): Return one bounding box per glyph.

final int gbbf_logical = 0x04
static

Flag for SIGNDOC_FindTextOccurrence_getBoundingBoxes(): Compute logical bounding boxes.

If this flag is set, a heuristic will be used for computing bounding boxes that reflect the logical flow of the text. For instance, line breaks will start a new bounding box.

RTL text is not yet supported.

final int gbbf_single = 0x01
static

Flag for getBoundingBoxes(): Compute a single bounding box, viz, the smallest rectangle containing all the glyph bounding boxes.


The documentation for this class was generated from the following file: