An annotation. More...

Public Member Functions
synchronized int	getType () throws SignDocException
	Get the type of the annotation.
synchronized String	getName () throws SignDocException
	Get the name of the annotation.
synchronized int	getPage () throws SignDocException
	Get the page number of the annotation.
synchronized Rect	getBoundingBox () throws SignDocException
	Get the bounding box of the annotation.
synchronized int	setName (String aName) throws SignDocException
	Set the name of the annotation.
synchronized int	setLineEnding (int aStart, int aEnd) throws SignDocException
	Set line ending styles.
synchronized int	setColor (SignDocColor aColor) throws SignDocException
	Set the color of the annotation.
synchronized int	setBackgroundColor (SignDocColor aColor) throws SignDocException
	Set the background color of the annotation.
synchronized int	setBorderColor (SignDocColor aColor) throws SignDocException
	Set the border color of the annotation.
synchronized int	setOpacity (double aOpacity) throws SignDocException
	Set the opacity of the annotation.
synchronized int	setLineWidthInPoints (double aWidth) throws SignDocException
	Set line width in points.
synchronized int	setBorderLineWidthInPoints (double aWidth) throws SignDocException
	Set border line width in points.
synchronized int	newStroke () throws SignDocException
	Start a new stroke in a scribble annotation.
synchronized int	addPoint (Point aPoint) throws SignDocException
	Add a point to the current stroke of a scribble annotation.
synchronized int	addPoint (double aX, double aY) throws SignDocException
	Add a point to the current stroke of a scribble annotation.
synchronized int	setPlainText (String aText, String aFont, double aFontSize, int aHAlignment) throws SignDocException
	Set the text of a text annotation.
synchronized String	getPlainText () throws SignDocException
	Get the plain text of a text annotation.
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.
Static Public Attributes
static final int	t_unknown = 0
	Annotation type: Unknown annotation type.
static final int	t_line = 1
	Annotation type: Line annotation.
static final int	t_scribble = 2
	Annotation type: Scribble annotation (freehand scribble).
static final int	t_freetext = 3
	Annotation type: Text annotation.
static final int	le_unknown = 0
	Line ending style: Unknown line ending style.
static final int	le_none = 1
	Line ending style: No line ending.
static final int	le_arrow = 2
	Line ending style: Two short lines forming an arrowhead.
static final int	ha_left = 0
	Horizontal alignment: left.
static final int	ha_center = 1
	Horizontal alignment: center.
static final int	ha_right = 2
	Horizontal alignment: right.
static final int	rc_ok = 0
	Return code: Parameter set successfully.
static final int	rc_not_supported = 1
	Return code: Setting the parameter is not supported.
static final int	rc_invalid_value = 2
	Return code: The value for the parameter is invalid.
Protected Member Functions
void	finalize () throws Throwable
	Finalize this object.

Detailed Description

An annotation.

Member Function Documentation

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aPoint The point to be added.

Returns:: rc_ok if successful.

See also:: newStroke()

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in]	aX	The X coordinate of the point.
[in]	aY	The Y coordinate of the point.

Returns:: rc_ok if successful.

See also:: newStroke()

void de.softpro.doc.SignDocAnnotation.finalize ( ) throws Throwable [protected]

Finalize this object.

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

synchronized Rect de.softpro.doc.SignDocAnnotation.getBoundingBox ( ) throws SignDocException

Get the bounding box of the annotation.

The bounding box is available for objects returned by getAnnotation() only.

Returns:: The bounding box (using document coordinates, see Coordinate Systems) or null if not available.

synchronized String de.softpro.doc.SignDocAnnotation.getFont ( ) throws SignDocException

Get the font of a text annotation.

Returns:: The font name of the annotation. The return value is null if the font name is not available.

See also:: getFontSize(), getPlainText(), setPlainText()

synchronized Double de.softpro.doc.SignDocAnnotation.getFontSize ( ) throws SignDocException

Get the font size of a text annotation.

Returns:: The font size (in user space units) of the annotation. The return value is null if the font size is not available.

See also:: getFont(), getPlainText(), setPlainText()

synchronized String de.softpro.doc.SignDocAnnotation.getName ( ) throws SignDocException

Get the name of the annotation.

Returns:: The name of the annotation or an empty string if the name is not available.

synchronized int de.softpro.doc.SignDocAnnotation.getPage ( ) throws SignDocException

Get the page number of the annotation.

The page number is available for objects returned by SignDocDocument.getAnnotation() only.

Returns:: the 1-based page number of the annotation or 0 if the page number is not available.

synchronized String de.softpro.doc.SignDocAnnotation.getPlainText ( ) throws SignDocException

Get the plain text of a text annotation.

Returns:: The plain text of the annotation. The start of a new paragraph (except for the first one is represented by CR and/or LF characters. The return value is null if the plain text is not available.

See also:: getFont(), setPlainText()

synchronized int de.softpro.doc.SignDocAnnotation.getType ( ) throws SignDocException

Get the type of the annotation.

See also:: t_line, t_scribble

synchronized int de.softpro.doc.SignDocAnnotation.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.

Returns:: rc_ok if successful.

See also:: addPoint()

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aColor The background color of the annotation.

Returns:: rc_ok if successful.

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aColor The border color of the annotation.

Returns:: rc_ok if successful.

See also:: setBorderLineWidthInPoints()

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aWidth The border line width in points (1/72 inch). If this value is negative, no border lines will be drawn.

Returns:: rc_ok if successful.

See also:: setBorderColor()

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aColor The color of the annotation.

Returns:: rc_ok if successful.

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[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).

Returns:: rc_ok if successful.

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aWidth The line width in points (1/72 inch).

Returns:: rc_ok if successful.

synchronized int de.softpro.doc.SignDocAnnotation.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.

Parameters:

[in] aName The name of the annotation.

Returns:: rc_ok if successful.

synchronized int de.softpro.doc.SignDocAnnotation.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 must use an opacity of 1.0.

Parameters:

[in] aOpacity The opacity, 0.0 (transparent) through 1.0 (opaque).

Returns:: rc_ok if successful.

synchronized int de.softpro.doc.SignDocAnnotation.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:

 "Line before empty line\n\u00A0\nLine after empty line"

Note:: This function does not yet support complex scripts.

Parameters:

[in]	aText	The text. Allowed control characters are CR and LF. Any sequence of CR and LF characters starts a new paragraph.
[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).