A single change made to a PDF document after a signature. More...

Public Member Functions
synchronized int	getType () throws SignDocException
	Get the type of the change.
String	getName () throws SignDocException
	Get the name of the changed field, annotation, or attachment.
synchronized int	getPage () throws SignDocException
	Get the page number of a change made after this signature.
synchronized int	getFieldType () throws SignDocException
	Get the type of the field of a change made after this signature.
synchronized String	getAnnotationType () throws SignDocException
	Get the type of the annotation of a change made after this signature.
Static Public Attributes
static final int	t_other = 0
	Type of change: Other change.
static final int	t_field_added = 1
	Type of change: A field has been added.
static final int	t_field_removed = 2
	Type of change: A field has been removed.
static final int	t_field_modified = 3
	Type of change: Properties of a field have been modified.
static final int	t_field_filled_in = 4
	Type of change: The value of a field has been changed.
static final int	t_annotation_added = 5
	Type of change: An annotation has been added.
static final int	t_annotation_removed = 6
	Type of change: An annotation has been removed.
static final int	t_annotation_modified = 7
	Type of change: An annotation has been modified.
static final int	t_attachment_added = 8
	Type of change: An annotation has been added.
static final int	t_attachment_removed = 9
	Type of change: An annotation has been removed.
static final int	t_attachment_modified = 10
	Type of change: An annotation has been modified.
static final int	t_page_added = 11
	Type of change: A page has been added.
static final int	t_page_removed = 12
	Type of change: A page has been removed.
static final int	t_page_modified = 13
	Type of change: A page has been modified.
Protected Member Functions
void	finalize () throws Throwable
	Finalize this object.

Detailed Description

A single change made to a PDF document after a signature.

See also:: SignDocSignature.getChange()

Member Function Documentation

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

Finalize this object.

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

synchronized String de.softpro.doc.SignDocChange.getAnnotationType ( ) throws SignDocException

Get the type of the annotation of a change made after this signature.

Returns:: The annotation type as string, empty if not known (for instance, if the change does not involve an annotation).

synchronized int de.softpro.doc.SignDocChange.getFieldType ( ) throws SignDocException

Get the type of the field of a change made after this signature.

Returns:: The field type, SignDocField.t_unknown if not known (for instance, if the change does not involve a field): SignDocField.t_pushbutton, SignDocField.t_check_box, SignDocField.t_radio_button, SignDocField.t_text, SignDocField.t_list_box, SignDocField.t_combo_box, or SignDocField.t_signature.

String de.softpro.doc.SignDocChange.getName ( ) throws SignDocException

Get the name of the changed field, annotation, or attachment.

For change types t_field_added, t_field_removed, t_field_modified, t_annotation_added, t_annotation_removed, t_annotation_modified, t_attachment_added, t_attachment_removed, and t_attachment_modified, the name of the changed field, annotation, or attachment can be retrieved by calling this function.

Returns:: The name of the field, annotation, or attachment; empty if not available. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also:: getNameUTF8(), getType()

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

Get the page number of a change made after this signature.

Returns:: The one-based page number or 0 if not available. For removed items, the page number is in the document "as signed" by the signature described by the SignDocSignature object, for modified and added items, the page number is in the document "as signed" by the next signature (or the current version of the document if the SignDocSignature object describes the last signature).

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

Get the type of the change.

Returns:: The type of the change: t_other, t_field_added, t_field_removed, t_field_modified, t_field_filled_in, t_annotation_added, t_annotation_removed, t_annotation_modified, t_attachment_added, t_attachment_removed, t_attachment_modified, t_page_added, t_page_removed, t_page_modified.

Member Data Documentation

final int de.softpro.doc.SignDocChange.t_annotation_added = 5 [static]

Type of change: An annotation has been added.

This does not include widget annotations. getName() and getNameUTF8() return the name of the annotation. getPage() returns the page having the annotation, getAnnotationType() returns the type of the annotation.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_annotation_modified = 7 [static]

Type of change: An annotation has been modified.

This does not include widget annotations. getName() and getNameUTF8() return the name of the annotation. getPage() returns the page having the annotation, getAnnotationType() returns the type of the annotation.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_annotation_removed = 6 [static]

Type of change: An annotation has been removed.

This does not include widget annotations. getName() and getNameUTF8() return the name of the annotation. getPage() returns the page which had the annotation, getAnnotationType() returns the type of the annotation.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_attachment_added = 8 [static]

Type of change: An annotation has been added.

getName() and getNameUTF8() return the name of the attachment.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_attachment_modified = 10 [static]

Type of change: An annotation has been modified.

getName() and getNameUTF8() return the name of the attachment.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_attachment_removed = 9 [static]

Type of change: An annotation has been removed.

getName() and getNameUTF8() return the name of the attachment.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_field_added = 1 [static]

Type of change: A field has been added.

getName() and getNameUTF8() return the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_field_filled_in = 4 [static]

Type of change: The value of a field has been changed.

getName() and getNameUTF8() return the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_field_modified = 3 [static]

Type of change: Properties of a field have been modified.

getName() and getNameUTF8() return the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_field_removed = 2 [static]

Type of change: A field has been removed.

getName() and getNameUTF8() return the name of the field, getPage() returns the first page which had a widget of the field, getFieldType() returns the type of the field.

See also:: getType()

final int de.softpro.doc.SignDocChange.t_other = 0 [static]

Type of change: Other change.

There will be one change of this type if there are any changes to the document which do not fit into the other categories described by enum ChangeType.