SignDoc SDK (Java)
5.0.0
|
An annotation. More...
Public Member Functions | |
synchronized int | getType () throws SignDocException |
Get the type of the annotation. More... | |
synchronized String | getName () throws SignDocException |
Get the name of the annotation. More... | |
synchronized int | getPage () throws SignDocException |
Get the page number of the annotation. More... | |
synchronized Rect | getBoundingBox () throws SignDocException |
Get the bounding box of the annotation. More... | |
synchronized void | setName (String aName) throws SignDocException |
Set the name of the annotation. More... | |
synchronized void | setLineEnding (int aStart, int aEnd) throws SignDocException |
Set line ending styles. More... | |
synchronized void | setColor (SignDocColor aColor) throws SignDocException |
Set the color of the annotation. More... | |
synchronized void | setBackgroundColor (SignDocColor aColor) throws SignDocException |
Set the background color of the annotation. More... | |
synchronized void | setBorderColor (SignDocColor aColor) throws SignDocException |
Set the border color of the annotation. More... | |
synchronized void | setOpacity (double aOpacity) throws SignDocException |
Set the opacity of the annotation. More... | |
synchronized void | setLineWidthInPoints (double aWidth) throws SignDocException |
Set line width in points. More... | |
synchronized void | setBorderLineWidthInPoints (double aWidth) throws SignDocException |
Set border line width in points. More... | |
synchronized void | newStroke () throws SignDocException |
Start a new stroke in a scribble annotation. More... | |
synchronized void | addPoint (Point aPoint) throws SignDocException |
Add a point to the current stroke of a scribble annotation. More... | |
synchronized void | addPoint (double aX, double aY) throws SignDocException |
Add a point to the current stroke of a scribble annotation. More... | |
synchronized void | setPlainText (String aText, String aFont, double aFontSize, int aHAlignment) throws SignDocException |
Set the text of a text annotation. More... | |
synchronized String | getPlainText () throws SignDocException |
Get the plain text of a text annotation. More... | |
synchronized String | getFont () throws SignDocException |
Get the font of a text annotation. More... | |
synchronized Double | getFontSize () throws SignDocException |
Get the font size of a text annotation. More... | |
synchronized void | setFlags (int aFlags) throws SignDocException |
Set flags. More... | |
synchronized void | close () |
Destroy the underlying native object (for java.lang.AutoCloseable). More... | |
Static Public Attributes | |
static final int | t_unknown = 0 |
Annotation type: Unknown annotation type. More... | |
static final int | t_line = 1 |
Annotation type: Line annotation. More... | |
static final int | t_scribble = 2 |
Annotation type: Scribble annotation (freehand scribble). More... | |
static final int | t_freetext = 3 |
Annotation type: Text annotation. More... | |
static final int | le_unknown = 0 |
Line ending style: Unknown line ending style. More... | |
static final int | le_none = 1 |
Line ending style: No line ending. More... | |
static final int | le_arrow = 2 |
Line ending style: Two short lines forming an arrowhead. More... | |
static final int | ha_left = 0 |
Horizontal alignment: Align left. More... | |
static final int | ha_center = 1 |
Horizontal alignment: Center. More... | |
static final int | ha_right = 2 |
Horizontal alignment: Align right. More... | |
static final int | f_auto_alignment = 0x200 |
Flag for setFlags(): Align left if the text begins with an LTR run, align right if the text begins with an RTL run. More... | |
static final int | f_ltr = 0x1000 |
Flag for setFlags(): Paragraph direction: LTR. More... | |
static final int | f_rtl = 0x2000 |
Flag for setFlags(): Paragraph direction: RTL. More... | |
static final int | f_default_ltr = 0x4000 |
Flag for setFlags(): Choose direction automatically, default to LTR. More... | |
static final int | f_default_rtl = 0x8000 |
Flag for setFlags(): Choose direction automatically, default to RTL. More... | |
Protected Member Functions | |
void | finalize () throws Throwable |
Finalize this object. More... | |
An annotation.
synchronized void addPoint | ( | Point | aPoint | ) | throws SignDocException |
Add a point to the current stroke of a scribble annotation.
This function can be used for annotations of type t_scribble. Each stroke must contain at least two points.
This function uses document (page) coordinates, see Coordinate Systems.
This function throws SignDocInvalidArgument on error.
[in] | aPoint | The point to be added. |
synchronized void addPoint | ( | double | aX, |
double | aY | ||
) | throws SignDocException |
Add a point to the current stroke of a scribble annotation.
This function can be used for annotations of type t_scribble. Each stroke must contain at least two points.
This function uses document (page) coordinates, see Coordinate Systems.
This function throws SignDocInvalidArgument on error.
[in] | aX | The X coordinate of the point. |
[in] | aY | The Y coordinate of the point. |
synchronized void close | ( | ) |
Destroy the underlying native object (for java.lang.AutoCloseable).
After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.
|
protected |
Finalize this object.
Do not call this method unless you know what you are doing.
synchronized Rect getBoundingBox | ( | ) | throws SignDocException |
Get the bounding box of the annotation.
The bounding box is available for objects returned by getAnnotation() only.
synchronized String getFont | ( | ) | throws SignDocException |
Get the font of a text annotation.
synchronized Double getFontSize | ( | ) | throws SignDocException |
Get the font size of a text annotation.
synchronized String getName | ( | ) | throws SignDocException |
Get the name of the annotation.
synchronized int getPage | ( | ) | throws SignDocException |
Get the page number of the annotation.
The page number is available for objects returned by SignDocDocument.getAnnotation() only.
synchronized String getPlainText | ( | ) | throws SignDocException |
Get the plain text of a text annotation.
synchronized int getType | ( | ) | throws SignDocException |
Get the type of the annotation.
synchronized void newStroke | ( | ) | throws SignDocException |
Start a new stroke in a scribble annotation.
This function can be used for annotations of type t_scribble. Each stroke must contain at least two points. This function need not be called for the first stroke of a scribble annotation.
This function throws SignDocInvalidArgument on error.
synchronized void setBackgroundColor | ( | SignDocColor | aColor | ) | throws SignDocException |
Set the background color of the annotation.
This function can be used for annotations of type t_freetext.
The default background color is white.
This function throws SignDocInvalidArgument on error.
[in] | aColor | The background color of the annotation. |
synchronized void setBorderColor | ( | SignDocColor | aColor | ) | throws SignDocException |
Set the border color of the annotation.
This function can be used for annotations of type t_freetext. The default border color is black.
This function throws SignDocInvalidArgument on error.
[in] | aColor | The border color of the annotation. |
synchronized void setBorderLineWidthInPoints | ( | double | aWidth | ) | throws SignDocException |
Set border line width in points.
This function can be used for annotations of type t_freetext. The default line width for PDF documents is 1 point.
This function throws SignDocInvalidArgument on error.
[in] | aWidth | The border line width in points (1/72 inch). If this value is negative, no border lines will be drawn. |
synchronized void setColor | ( | SignDocColor | aColor | ) | throws SignDocException |
Set the color of the annotation.
This function can be used for annotations of types t_line and t_scribble. The default color is black.
This function throws SignDocInvalidArgument on error.
[in] | aColor | The color of the annotation. |
synchronized void setFlags | ( | int | aFlags | ) | throws SignDocException |
Set flags.
This function can be used for annotations of type t_freetext. Initially, no flag is set.
This function throws SignDocInvalidArgument on error.
[in] | aFlags | See f_auto_alignment, f_ltr, f_rtl, f_default_ltr, and f_default_rtl. |
synchronized void setLineEnding | ( | int | aStart, |
int | aEnd | ||
) | throws SignDocException |
Set line ending styles.
This function can be used for annotations of type t_line. The default line ending style is le_none.
This function throws SignDocInvalidArgument on error.
[in] | aStart | Line ending style for start point (le_none or le_arrow). |
[in] | aEnd | Line ending style for end point (le_none or le_arrow). |
synchronized void setLineWidthInPoints | ( | double | aWidth | ) | throws SignDocException |
Set line width in points.
This function can be used for annotations of types t_line and t_scribble. The default line width for PDF documents is 1 point.
This function throws SignDocInvalidArgument on error.
[in] | aWidth | The line width in points (1/72 inch). |
synchronized void setName | ( | String | aName | ) | throws SignDocException |
Set the name of the annotation.
In PDF documents, an annotation can have a name. The names of annotations must be unique within a page. By default, annotations are unnamed.
This function throws SignDocInvalidArgument on error.
[in] | aName | The name of the annotation. |
synchronized void setOpacity | ( | double | aOpacity | ) | throws SignDocException |
Set the opacity of the annotation.
This function can be used for annotations of types t_line and t_scribble.
The default opacity is 1.0. Documents conforming to PDF/A-1 must use an opacity of 1.0.
This function throws SignDocInvalidArgument on error.
[in] | aOpacity | The opacity, 0.0 (transparent) through 1.0 (opaque). |
synchronized void setPlainText | ( | String | aText, |
String | aFont, | ||
double | aFontSize, | ||
int | aHAlignment | ||
) | throws SignDocException |
Set the text of a text annotation.
This function can be used for annotations of type t_freetext.
Any sequence of CR and LF characters in the text starts a new paragraph (ie, text following such a sequence will be placed at the beginning of the next output line). In consequence, empty lines in the input do not produce empty lines in the output. To get an empty line in the output, you have to add a paragraph containing a non-breaking space (0xa0) only:
Complex scripts are supported, see Complex Scripts. By default, this function uses paragraph direction LTR. Use setFlags() if you need to set a different paragraph direction.
This function throws SignDocInvalidArgument on error.
[in] | aText | The text. Allowed control characters are CR and LF. Any sequence of CR and LF characters starts a new paragraph. Escape sequences must not be used. |
[in] | aFont | The name of the font to be used. The font substitition rules of the loaded font configuration files will be used. The resulting font must be a standard PDF font or a font for which a file is specified in the font configuration files. |
[in] | aFontSize | The font size in user space units. |
[in] | aHAlignment | Horizontal alignment of the text (ha_left, ha_center, ha_right). |
|
static |
Flag for setFlags(): Align left if the text begins with an LTR run, align right if the text begins with an RTL run.
This flag overrides for creating the appearance stream ha_left and ha_right passed to aHAlignment of setPlainText(). This flag is ignored for ha_center.
|
static |
Flag for setFlags(): Choose direction automatically, default to LTR.
The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph.
The paragraph level will be 0 (LTR) for paragraphs having no strong directional character.
If none of f_ltr, f_rtl, f_default_ltr, and f_default_rtl is set, f_ltr will be used.
At most one of f_ltr, f_rtl, f_default_ltr, and f_default_rtl can be set.
Usage of f_default_ltr is not recommended as the visual representation of the text of the annotation may not match the value of the annotation (as interpreted by software which does not know that the paragraph direction is supposed to be default-LTR). Use f_default_ltr only as last resort if you cannot modify the text received from a default-LTR input field appropriately for paragraph direction LTR used in PDF annotations.
|
static |
Flag for setFlags(): Choose direction automatically, default to RTL.
The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph.
The paragraph level will be 1 (RTL) for paragraphs having no strong directional character.
If none of f_ltr, f_rtl, f_default_ltr, and f_default_rtl is set, f_ltr will be used.
At most one of f_ltr, f_rtl, f_default_ltr, and f_default_rtl can be set.
Usage of f_default_rtl is not recommended as the visual representation of the text of the annotation may not match the value of the annotation (as interpreted by software which does not know that the paragraph direction is supposed to be default-RTL). Use f_default_rtl only as last resort if you cannot modify the text received from a default-RTL input field appropriately for paragraph direction LTR used in PDF annotations.
|
static |
Flag for setFlags(): Paragraph direction: LTR.
If none of f_ltr, f_rtl, f_default_ltr, and f_default_rtl is set, f_ltr will be used.
At most one of f_ltr, f_rtl, f_default_ltr, and f_default_rtl can be set.
|
static |
Flag for setFlags(): Paragraph direction: RTL.
If none of f_ltr, f_rtl, f_default_ltr, and f_default_rtl is set, f_ltr will be used.
At most one of f_ltr, f_rtl, f_default_ltr, and f_default_rtl can be set.
Usage of f_rtl is not recommended as the visual representation of the text of the annotation may not match the plain text of the annotation (as interpreted by software which does not know that the paragraph direction is supposed to be RTL). Use f_rtl only as last resort if you cannot modify the text received from an RTL input field appropriately for paragraph direction LTR used in PDF annotations.
|
static |
Horizontal alignment: Center.
|
static |
Horizontal alignment: Align left.
|
static |
Horizontal alignment: Align right.
|
static |
Line ending style: Two short lines forming an arrowhead.
|
static |
Line ending style: No line ending.
|
static |
Line ending style: Unknown line ending style.
|
static |
Annotation type: Text annotation.
|
static |
Annotation type: Line annotation.
|
static |
Annotation type: Scribble annotation (freehand scribble).
|
static |
Annotation type: Unknown annotation type.