Annotation syncing

In this document
chevron_rightRequirements
chevron_rightJump to annotation

PDFNet supports annotation syncing between different clients to allow for collaboration. All the required locking, change tracking, merging and view updating are handled internally. Below are instructions on how to handle the import and export of annotation changes on the client side. While the server component is not described here, that implementation would be straightforward. The server would receive XFDF XML data, which it would then pass onto all other active clients that are part of the collaboration session. The clients take care of the updating. The server can store any XFDF data as it likes, since the data is just an XML string.

Requirements

Here are a few requirements for syncing to work as expected:

  • A permanent and unique string identifier is needed for the userId. UserId needs to be permanent and cannot be changed later on. For example, if Alice was used for the userId, however, was later changed to AliceB, the viewer will no longer treat it as the same user. Therefore, we recommend that you generate a UUID for each user.
  • Similar to userId, each annotation will also need its own UUID, aka annotId. This UUID also needs to be permanent and unique.
  • Annotation changes are stored as XFDF command strings, which PDFNet generates when changes are made. However, any custom modification to the XFDF command string could lead to unexpected results, thus, modification to the XFDF command string are not recommended.
  • Existing annotations that do not have a unique identifier will not work, it is recommended that you pre-process all annotations to make sure they all have unique identifiers.
  • Undo and redo will be automatically enabled upon using annotation syncing.

Initializing and sending annotation changes

Add the following after ToolManager is initialized:

// supply a permanent and unique userId here
mToolManager.enableAnnotManager("12345-67890-ABCD-EFGH", new AnnotManager.AnnotManagerListener() {
    @Override
    public void onLocalChange(String action, String xfdfCommand) {
        // a local annotation change event has happened,
        // now is the time to send the XFDF command string to your remote service
        // action is one of {@link AnnotManager.AnnotationAction#ADD}
        //                  {@link AnnotManager.AnnotationAction#MODIFY}
        //                  {@link AnnotManager.AnnotationAction#DELETE}
        //                  {@link AnnotManager.AnnotationAction#UNDO}
        //                  {@link AnnotManager.AnnotationAction#REDO}
        // xfdfCommand is the XFDF command string, modification to this string is not recommended
    }
});

PDFNet will generate a unique identifier for every annotation created through the PDFTron SDK. However, if you would like to generate your own annotation identification, you are able to do so as follows:

mToolManager.setExternalAnnotationManagerListener(
    new ToolManager.ExternalAnnotationManagerListener() {
        @Override
        public String generateKey() {
            // generate your own permanent and unique annotId here
            return "-KEhbKjioTTFI0IM_nim";
        }
    });

Receiving annotation changes

When an annotation change event is received from a remote service, add the following to notify the viewer about the change:

public void receivedAnnotationEvents(String xfdfCommand) {
    if (mToolManager.getAnnotManager() != null) {
        mToolManager.getAnnotManager().onRemoteChange(xfdfCommand);
    }
}

Jump to annotation

To jump to an annotation by id:

public void jumpToAnnotation(String annotId) {
    if (mToolManager.getAnnotManager() != null) {
        mToolManager.getAnnotManager().jumpToAnnot(annotId);
    }
}