Summary: Ctors | Methods | Inherited Methods | [Expand All]
public class

# TextDiffOptions

extends OptionsBase

java.lang.Object
↳ | com.pdftron.pdf.OptionsBase
| ↳ | com.pdftron.pdf.TextDiffOptions

## Summary

Public Constructors
| TextDiffOptions() Constructor.
| TextDiffOptions(String json_string) Constructor.

Public Methods
TextDiffOptions | addIgnoreZonesForPage(RectCollection regions, int page_num) Adds a collection of ignorable regions for the given page Optional list of page areas that will be not be processed
ColorPt | getColorA() Gets the value ColorA from the options object The difference color for deletions
ColorPt | getColorB() Gets the value ColorB from the options object The difference color for insertions
boolean | getCompareStyles() Gets the value CompareStyles from the options object Whether to highlight text style differences.
boolean | getCompareUsingZOrder() Gets the value CompareUsingZOrder from the options object Whether to use z-order (aka paint order) when comparing text between A and B.
ColorPt | getExtraMoveColor() Gets the value ExtraMoveColor from the options object The difference color for extra moves
boolean | getExtraMoveHighlight() Gets the value ExtraMoveHighlight from the options object Whether to highlight text in between short-distance moves when comparing text between A and B.
double | getExtraMoveOpacity() Gets the value ExtraMoveOpacity from the options object The difference opacity for extra moves
double | getOpacityA() Gets the value OpacityA from the options object The difference opacity for deletions
double | getOpacityB() Gets the value OpacityB from the options object The difference opacity for insertions
boolean | getShowPlaceholders() Gets the value ShowPlaceholders from the options object Whether to show placeholder annotations.
TextDiffOptions | setColorA(ColorPt color) Sets the value for ColorA in the options object The difference color for deletions
TextDiffOptions | setColorB(ColorPt color) Sets the value for ColorB in the options object The difference color for insertions
TextDiffOptions | setCompareStyles(boolean value) Sets the value for CompareStyles in the options object Whether to highlight text style differences.
TextDiffOptions | setCompareUsingZOrder(boolean value) Sets the value for CompareUsingZOrder in the options object Whether to use z-order (aka paint order) when comparing text between A and B.
TextDiffOptions | setExtraMoveColor(ColorPt color) Sets the value for ExtraMoveColor in the options object The difference color for extra moves
TextDiffOptions | setExtraMoveHighlight(boolean value) Sets the value for ExtraMoveHighlight in the options object Whether to highlight text in between short-distance moves when comparing text between A and B.
TextDiffOptions | setExtraMoveOpacity(double opacity) Sets the value for ExtraMoveOpacity in the options object The difference opacity for extra moves
TextDiffOptions | setOpacityA(double opacity) Sets the value for OpacityA in the options object The difference opacity for deletions
TextDiffOptions | setOpacityB(double opacity) Sets the value for OpacityB in the options object The difference opacity for insertions
TextDiffOptions | setShowPlaceholders(boolean value) Sets the value for ShowPlaceholders in the options object Whether to show placeholder annotations.

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public TextDiffOptions ()

Constructor.

##### Throws

PDFNetException |

#### public TextDiffOptions (String json_string)

Constructor.

##### Throws

PDFNetException |

## Public Methods

#### public TextDiffOptions addIgnoreZonesForPage (RectCollection regions, int page_num)

Adds a collection of ignorable regions for the given page Optional list of page areas that will be not be processed

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public ColorPt getColorA ()

Gets the value ColorA from the options object The difference color for deletions

##### Returns

- a ColorPt, The difference color for deletions in the form of R, G, B

##### Throws

PDFNetException |

#### public ColorPt getColorB ()

Gets the value ColorB from the options object The difference color for insertions

##### Returns

- a ColorPt, The difference color for insertions in the form of R, G, B

##### Throws

PDFNetException |

#### public boolean getCompareStyles ()

Gets the value CompareStyles from the options object Whether to highlight text style differences. Off by default. Text style includes font, size, bold, italic and text color. For example, if a word is italic in document A and is bold in document B, we can highlight the location of the word in both documents.

##### Returns

- a boolean, Whether to highlight text style differences. Off by default.

##### Throws

PDFNetException |

#### public boolean getCompareUsingZOrder ()

Gets the value CompareUsingZOrder from the options object Whether to use z-order (aka paint order) when comparing text between A and B. On by default.

##### Returns

- a boolean, Whether to use z-order (aka paint order) when comparing text between A and B. On by default..

##### Throws

PDFNetException |

#### public ColorPt getExtraMoveColor ()

Gets the value ExtraMoveColor from the options object The difference color for extra moves

##### Returns

- a ColorPt, The difference color for extra moves in the form of R, G, B

##### Throws

PDFNetException |

#### public boolean getExtraMoveHighlight ()

Gets the value ExtraMoveHighlight from the options object Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default.

##### Returns

- a boolean, Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default.

##### Throws

PDFNetException |

#### public double getExtraMoveOpacity ()

Gets the value ExtraMoveOpacity from the options object The difference opacity for extra moves

##### Returns

- a double, The difference opacity for extra moves in between 0.0 (transparent) and 1.0 (opaque)

##### Throws

PDFNetException |

#### public double getOpacityA ()

Gets the value OpacityA from the options object The difference opacity for deletions

##### Returns

- a double, The difference opacity for deletions in between 0.0 (transparent) and 1.0 (opaque)

##### Throws

PDFNetException |

#### public double getOpacityB ()

Gets the value OpacityB from the options object The difference opacity for insertions

##### Returns

- a double, The difference opacity for insertions in between 0.0 (transparent) and 1.0 (opaque)

##### Throws

PDFNetException |

#### public boolean getShowPlaceholders ()

Gets the value ShowPlaceholders from the options object Whether to show placeholder annotations. On by default. Placeholders are insertion locations in document A and deletion locations in document B. For example, if a word is removed from document B, we can highlight the location of the original word in document A, but there is no word to highlight in B (it's removed). In this case a small "placeholder" annotation is placed in B to identify the location of the removal.

##### Returns

- a boolean, Whether to show placeholder annotations. On by default.

##### Throws

PDFNetException |

#### public TextDiffOptions setColorA (ColorPt color)

Sets the value for ColorA in the options object The difference color for deletions

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setColorB (ColorPt color)

Sets the value for ColorB in the options object The difference color for insertions

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setCompareStyles (boolean value)

Sets the value for CompareStyles in the options object Whether to highlight text style differences. Off by default. Text style includes font, size, bold, italic and text color. For example, if a word is italic in document A and is bold in document B, we can highlight the location of the word in both documents.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setCompareUsingZOrder (boolean value)

Sets the value for CompareUsingZOrder in the options object Whether to use z-order (aka paint order) when comparing text between A and B. On by default.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setExtraMoveColor (ColorPt color)

Sets the value for ExtraMoveColor in the options object The difference color for extra moves

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setExtraMoveHighlight (boolean value)

Sets the value for ExtraMoveHighlight in the options object Whether to highlight text in between short-distance moves when comparing text between A and B. Off by default.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setExtraMoveOpacity (double opacity)

Sets the value for ExtraMoveOpacity in the options object The difference opacity for extra moves

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setOpacityA (double opacity)

Sets the value for OpacityA in the options object The difference opacity for deletions

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setOpacityB (double opacity)

Sets the value for OpacityB in the options object The difference opacity for insertions

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |

#### public TextDiffOptions setShowPlaceholders (boolean value)

Sets the value for ShowPlaceholders in the options object Whether to show placeholder annotations. On by default. Placeholders are insertion locations in document A and deletion locations in document B. For example, if a word is removed from document B, we can highlight the location of the original word in document A, but there is no word to highlight in B (it's removed). In this case a small "placeholder" annotation is placed in B to identify the location of the removal.

##### Returns

- this object, for call chaining

##### Throws

PDFNetException |