FindReplaceDirection

Inheritance: java.lang.Object

public class FindReplaceDirection

Specifies direction for replace operations.

Examples:

Shows how to determine which direction a find-and-replace operation traverses the document in.

 public void direction(int findReplaceDirection) throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Insert three runs which we can search for using a regex pattern.
     // Place one of those runs inside a text box.
     builder.writeln("Match 1.");
     builder.writeln("Match 2.");
     builder.writeln("Match 3.");
     builder.writeln("Match 4.");

     // We can use a "FindReplaceOptions" object to modify the find-and-replace process.
     FindReplaceOptions options = new FindReplaceOptions();

     // Assign a custom callback to the "ReplacingCallback" property.
     TextReplacementRecorder callback = new TextReplacementRecorder();
     options.setReplacingCallback(callback);

     // Set the "Direction" property to "FindReplaceDirection.Backward" to get the find-and-replace
     // operation to start from the end of the range, and traverse back to the beginning.
     // Set the "Direction" property to "FindReplaceDirection.Forward" to get the find-and-replace
     // operation to start from the beginning of the range, and traverse to the end.
     options.setDirection(findReplaceDirection);

     doc.getRange().replace(Pattern.compile("Match \\d*"), "Replacement", options);

     Assert.assertEquals("Replacement.\r" +
             "Replacement.\r" +
             "Replacement.\r" +
             "Replacement.", doc.getText().trim());

     switch (findReplaceDirection) {
         case FindReplaceDirection.FORWARD:
             Assert.assertEquals(new String[]{"Match 1", "Match 2", "Match 3", "Match 4"}, callback.getMatches().toArray());
             break;
         case FindReplaceDirection.BACKWARD:
             Assert.assertEquals(new String[]{"Match 4", "Match 3", "Match 2", "Match 1"}, callback.getMatches().toArray());
             break;
     }
 }

 public static Object[][] directionDataProvider() {
     return new Object[][]
             {
                     {FindReplaceDirection.BACKWARD},
                     {FindReplaceDirection.FORWARD},
             };
 }

 /// 
 /// Records all matches that occur during a find-and-replace operation in the order that they take place.
 /// 
 private static class TextReplacementRecorder implements IReplacingCallback {
     public int replacing(ReplacingArgs e) {
         mMatches.add(e.getMatch().group(0));
         return ReplaceAction.REPLACE;
     }

     public ArrayList getMatches() {
         return mMatches;
     }

     private final ArrayList mMatches = new ArrayList();
 }
 

Fields

Field	Description
BACKWARD	Matched items are replaced from last back to first.
FORWARD	Matched items are replaced from first to last.
length

Methods

Method	Description
fromName(String findReplaceDirectionName)
getName(int findReplaceDirection)
getValues()
toString(int findReplaceDirection)

BACKWARD

public static int BACKWARD

Matched items are replaced from last back to first.

FORWARD

public static int FORWARD

Matched items are replaced from first to last.

length

public static int length

fromName(String findReplaceDirectionName)

public static int fromName(String findReplaceDirectionName)

Parameters:

Parameter	Type	Description
findReplaceDirectionName	java.lang.String

Returns: int

getName(int findReplaceDirection)

public static String getName(int findReplaceDirection)

Parameters:

Parameter	Type	Description
findReplaceDirection	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int findReplaceDirection)

public static String toString(int findReplaceDirection)

Parameters:

Parameter	Type	Description
findReplaceDirection	int

Returns: java.lang.String