ComparisonOptions

Inheritance: java.lang.Object, com.aspose.pdf.comparison.ComparisonOptions

public class ComparisonOptions extends Object

Represents a PDF document comparison options class.

Constructors

ConstructorDescription
ComparisonOptionsCreates a {@link ComparisonOptions} class instance.

Methods

MethodDescription
getEditOperationsOrderGets and sets the edit operations order.
getExcludeAreas1Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.
getExcludeAreas2Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.
getExtractionAreaGet and set the rectangular area in which the text of pages will be compared. This option can’t be setted along with {@code ExcludeTables}({ #getExcludeTables}/{ #setExcludeTables(boolean)}), {@code ExcludeAreas1}({ #getExcludeAreas1}/{ #setExcludeAreas1(Rectangle[])}) and { ExcludeAreas2}({ #getExcludeAreas2}/{ #setExcludeAreas2(Rectangle[])}) options.
isExcludeTablesGet and set the option that determines whether tables are excluded from comparison. This option cannot be set together with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option. The default value is {@code false}.
setEditOperationsOrderGets and sets the edit operations order.
setExcludeAreas1Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.
setExcludeAreas2Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.
setExcludeTablesGet and set the option that determines whether tables are excluded from comparison. This option cannot be set together with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option. The default value is {@code false}.
setExtractionAreaGet and set the rectangular area in which the text of pages will be compared. This option can’t be setted along with {@code ExcludeTables}({ #getExcludeTables}/{ #setExcludeTables(boolean)}), {@code ExcludeAreas1}({ #getExcludeAreas1}/{ #setExcludeAreas1(Rectangle[])}) and { ExcludeAreas2}({ #getExcludeAreas2}/{ #setExcludeAreas2(Rectangle[])}) options.

ComparisonOptions

public ComparisonOptions()

Creates a {@link ComparisonOptions} class instance.

getEditOperationsOrder

public final EditOperationsOrder getEditOperationsOrder()

Gets and sets the edit operations order.

Returns: EditOperationsOrder element

getExcludeAreas1

public final Rectangle [] getExcludeAreas1()

Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.

Returns: array of Rectangle instances

getExcludeAreas2

public final Rectangle [] getExcludeAreas2()

Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.

Returns: array of Rectangle instances

getExtractionArea

public final Rectangle getExtractionArea()

Get and set the rectangular area in which the text of pages will be compared. This option can’t be setted along with {@code ExcludeTables}({ #getExcludeTables}/{ #setExcludeTables(boolean)}), {@code ExcludeAreas1}({ #getExcludeAreas1}/{ #setExcludeAreas1(Rectangle[])}) and { ExcludeAreas2}({ #getExcludeAreas2}/{ #setExcludeAreas2(Rectangle[])}) options.

Returns: Rectangle instance

isExcludeTables

public final boolean isExcludeTables()

Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option. The default value is {@code false}.

Returns: boolean value

setEditOperationsOrder

Gets and sets the edit operations order.

setExcludeAreas1

Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.

setExcludeAreas2

Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with {@code ExcludeTables}({@link #isExcludeTables}/{@link #setExcludeTables(boolean)}). This option can’t be setted along with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option.

setExcludeTables

public final void setExcludeTables(boolean value)

Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with {@code ExtractionArea}({@link #getExtractionArea}/{@link #setExtractionArea(Rectangle)}) option. The default value is {@code false}.

Parameters:

ParameterTypeDescription
valueboolean value

setExtractionArea

Get and set the rectangular area in which the text of pages will be compared. This option can’t be setted along with {@code ExcludeTables}({ #getExcludeTables}/{ #setExcludeTables(boolean)}), {@code ExcludeAreas1}({ #getExcludeAreas1}/{ #setExcludeAreas1(Rectangle[])}) and { ExcludeAreas2}({ #getExcludeAreas2}/{ #setExcludeAreas2(Rectangle[])}) options.