RevisionType

Inheritance: java.lang.Object

public class RevisionType

Specifies the type of change being tracked in Revision.

Examples:

Shows how to work with revisions in a document.

 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Normal editing of the document does not count as a revision.
 builder.write("This does not count as a revision. ");

 Assert.assertFalse(doc.hasRevisions());

 // To register our edits as revisions, we need to declare an author, and then start tracking them.
 doc.startTrackRevisions("John Doe", new Date());

 builder.write("This is revision #1. ");

 Assert.assertTrue(doc.hasRevisions());
 Assert.assertEquals(1, doc.getRevisions().getCount());

 // This flag corresponds to the "Review" -> "Tracking" -> "Track Changes" option in Microsoft Word.
 // The "StartTrackRevisions" method does not affect its value,
 // and the document is tracking revisions programmatically despite it having a value of "false".
 // If we open this document using Microsoft Word, it will not be tracking revisions.
 Assert.assertFalse(doc.getTrackRevisions());

 // We have added text using the document builder, so the first revision is an insertion-type revision.
 Revision revision = doc.getRevisions().get(0);
 Assert.assertEquals("John Doe", revision.getAuthor());
 Assert.assertEquals("This is revision #1. ", revision.getParentNode().getText());
 Assert.assertEquals(RevisionType.INSERTION, revision.getRevisionType());
 Assert.assertEquals(revision.getDateTime().getDate(), new Date().getDate());
 Assert.assertEquals(doc.getRevisions().getGroups().get(0), revision.getGroup());

 // Remove a run to create a deletion-type revision.
 doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0).remove();

 // Adding a new revision places it at the beginning of the revision collection.
 Assert.assertEquals(RevisionType.DELETION, doc.getRevisions().get(0).getRevisionType());
 Assert.assertEquals(2, doc.getRevisions().getCount());

 // Insert revisions show up in the document body even before we accept/reject the revision.
 // Rejecting the revision will remove its nodes from the body. Conversely, nodes that make up delete revisions
 // also linger in the document until we accept the revision.
 Assert.assertEquals("This does not count as a revision. This is revision #1.", doc.getText().trim());

 // Accepting the delete revision will remove its parent node from the paragraph text
 // and then remove the collection's revision itself.
 doc.getRevisions().get(0).accept();

 Assert.assertEquals(1, doc.getRevisions().getCount());
 Assert.assertEquals("This is revision #1.", doc.getText().trim());

 builder.writeln("");
 builder.write("This is revision #2.");

 // Now move the node to create a moving revision type.
 Node node = doc.getFirstSection().getBody().getParagraphs().get(1);
 Node endNode = doc.getFirstSection().getBody().getParagraphs().get(1).getNextSibling();
 Node referenceNode = doc.getFirstSection().getBody().getParagraphs().get(0);

 while (node != endNode)
 {
     Node nextNode = node.getNextSibling();
     doc.getFirstSection().getBody().insertBefore(node, referenceNode);
     node = nextNode;
 }

 Assert.assertEquals(RevisionType.MOVING, doc.getRevisions().get(0).getRevisionType());
 Assert.assertEquals(8, doc.getRevisions().getCount());
 Assert.assertEquals("This is revision #2.\rThis is revision #1. \rThis is revision #2.", doc.getText().trim());

 // The moving revision is now at index 1. Reject the revision to discard its contents.
 doc.getRevisions().get(1).reject();

 Assert.assertEquals(6, doc.getRevisions().getCount());
 Assert.assertEquals("This is revision #1. \rThis is revision #2.", doc.getText().trim());
 

Fields

Field	Description
DELETION	Content was removed from the document.
FORMAT_CHANGE	Change of formatting was applied to the parent node.
INSERTION	New content was inserted in the document.
MOVING	Content was moved in the document.
STYLE_DEFINITION_CHANGE	Change of formatting was applied to the parent style.
length

Methods

Method	Description
fromName(String revisionTypeName)
getName(int revisionType)
getValues()
toString(int revisionType)

DELETION

public static int DELETION

Content was removed from the document.

FORMAT_CHANGE

public static int FORMAT_CHANGE

Change of formatting was applied to the parent node.

INSERTION

public static int INSERTION

New content was inserted in the document.

MOVING

public static int MOVING

Content was moved in the document.

STYLE_DEFINITION_CHANGE

public static int STYLE_DEFINITION_CHANGE

Change of formatting was applied to the parent style.

length

public static int length

fromName(String revisionTypeName)

public static int fromName(String revisionTypeName)

Parameters:

Parameter	Type	Description
revisionTypeName	java.lang.String

Returns: int

getName(int revisionType)

public static String getName(int revisionType)

Parameters:

Parameter	Type	Description
revisionType	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int revisionType)

public static String toString(int revisionType)

Parameters:

Parameter	Type	Description
revisionType	int

Returns: java.lang.String