SignDoc SDK (Java)  5.0.0
SignDocChange Class Reference

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

Inheritance diagram for SignDocChange:

Public Member Functions

synchronized int getType () throws SignDocException
 Get the type of the change. More...
 
String getName () throws SignDocException
 Get the name of the changed field, annotation, or attachment. More...
 
synchronized int getPage () throws SignDocException
 Get the page number of a change made after this signature. More...
 
synchronized int getFieldType () throws SignDocException
 Get the type of the field of a change made after this signature. More...
 
synchronized String getAnnotationType () throws SignDocException
 Get the type of the annotation of a change made after this signature. More...
 
synchronized void close ()
 Destroy the underlying native object (for java.lang.AutoCloseable). More...
 

Static Public Attributes

static final int t_other = 0
 Type of change: Other change. More...
 
static final int t_field_added = 1
 Type of change: A field has been added. More...
 
static final int t_field_removed = 2
 Type of change: A field has been removed. More...
 
static final int t_field_modified = 3
 Type of change: Properties of a field have been modified. More...
 
static final int t_field_filled_in = 4
 Type of change: The value of a field has been changed. More...
 
static final int t_annotation_added = 5
 Type of change: An annotation has been added. More...
 
static final int t_annotation_removed = 6
 Type of change: An annotation has been removed. More...
 
static final int t_annotation_modified = 7
 Type of change: An annotation has been modified. More...
 
static final int t_attachment_added = 8
 Type of change: An annotation has been added. More...
 
static final int t_attachment_removed = 9
 Type of change: An annotation has been removed. More...
 
static final int t_attachment_modified = 10
 Type of change: An annotation has been modified. More...
 
static final int t_page_added = 11
 Type of change: A page has been added. More...
 
static final int t_page_removed = 12
 Type of change: A page has been removed. More...
 
static final int t_page_modified = 13
 Type of change: A page has been modified. More...
 

Protected Member Functions

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

Detailed Description

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

See also
SignDocSignature.getChange()

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 String 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 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_digsig.
String 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 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).

Member Data Documentation

final int 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 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 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 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 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 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 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 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 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 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 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 these constants.

See also
getType()
final int t_page_added = 11
static

Type of change: A page has been added.

getPage() returns the number of the page in the newer version of the document.

See also
getType()
final int t_page_modified = 13
static

Type of change: A page has been modified.

getPage() returns the number of the page.

See also
getType()
final int t_page_removed = 12
static

Type of change: A page has been removed.

getPage() returns the number of the page in the older version of the document.

See also
getType()

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