public static interface

ToolManager.AnnotationModificationListener

com.pdftron.pdf.tools.ToolManager.AnnotationModificationListener
Known Indirect Subclasses

Class Overview

This interface can be used to monitor annotation modification events such as added/edited/removed.

For listening to events that change the structure of PDF document such as page manipulation see ToolManager.PdfDocModificationListener.

Summary

Public Methods
abstract void annotationsCouldNotBeAdded(String errorMessage)
Called when annotations couldn't have been added
abstract void onAnnotationsAdded(Map<Annot, Integer> annots)
Called when annotations have been added to the document.
abstract void onAnnotationsModified(Map<Annot, Integer> annots, Bundle extra)
Called when annotations have been modified.
abstract void onAnnotationsPreModify(Map<Annot, Integer> annots)
Called right before annotations have been modified.
abstract void onAnnotationsPreRemove(Map<Annot, Integer> annots)
Called right before annotations have been removed from the document.
abstract void onAnnotationsRemoved(Map<Annot, Integer> annots)
Called when annotations have been removed from the document.
abstract void onAnnotationsRemovedOnPage(int pageNum)
Called when all annotations in the specified page have been removed.

Public Methods

public abstract void annotationsCouldNotBeAdded (String errorMessage)

Called when annotations couldn't have been added

Parameters
errorMessage The error message

public abstract void onAnnotationsAdded (Map<Annot, Integer> annots)

Called when annotations have been added to the document.

Parameters
annots The list of annotations (a pair of annotation and the page number where the annotation is on)

public abstract void onAnnotationsModified (Map<Annot, Integer> annots, Bundle extra)

Called when annotations have been modified.

Parameters
annots The list of annotations (a pair of annotation and the page number where the annotation is on)

public abstract void onAnnotationsPreModify (Map<Annot, Integer> annots)

Called right before annotations have been modified.

Parameters
annots The list of annotations (a pair of annotation and the page number where the annotation is on)

public abstract void onAnnotationsPreRemove (Map<Annot, Integer> annots)

Called right before annotations have been removed from the document. All actions to be performed on the annots need to be done here

Parameters
annots The list of annotations (a pair of annotation and the page number where the annotation is on)

public abstract void onAnnotationsRemoved (Map<Annot, Integer> annots)

Called when annotations have been removed from the document. No action should be performed on the annots, use onAnnotationsPreRemove instead.

Parameters
annots The list of annotations (a pair of annotation and the page number where the annotation is on)

public abstract void onAnnotationsRemovedOnPage (int pageNum)

Called when all annotations in the specified page have been removed.

Parameters
pageNum The page number where the annotations are on