com.aspose.pdf.comparison.sidebysidecomparison

Class SideBySideComparisonOptions

java.lang.Object

com.aspose.pdf.comparison.outputgenerator.IVentureLicenseTarget

com.aspose.pdf.comparison.sidebysidecomparison.SideBySideComparisonOptions

public class SideBySideComparisonOptions
extends IVentureLicenseTarget

Represents an options class for comparing documents with side-by-side output.

Constructor Summary

Constructors

Constructor and Description
SideBySideComparisonOptions() Creates an instance of SideBySideComparisonOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	getAdditionalChangeMarks() Get and set the property that determines whether additional change markers are displayed.
Rectangle	getComparisonArea1() Get and set the comparison area.
Rectangle	getComparisonArea2() Get and set the comparison area.
int	getComparisonMode() Gets and sets a comparison mode.
Color	getDeleteColor() Gets the color used to mark deleted content during a side-by-side comparison.
Rectangle[]	getExcludeAreas1() Get and set the exclude areas.
Rectangle[]	getExcludeAreas2() Get and set the exclude areas.
boolean	getExcludeTables() Get and set the option that determines whether tables are excluded from comparison.
Color	getInsertColor() Gets the color used to mark inserted content during a side-by-side comparison.
void	setAdditionalChangeMarks(boolean value) Get and set the property that determines whether additional change markers are displayed.
void	setComparisonArea1(Rectangle value) Get and set the comparison area.
void	setComparisonArea2(Rectangle value) Get and set the comparison area.
void	setComparisonMode(int value) Gets and sets a comparison mode.
void	setDeleteColor(Color value) Sets the color used to mark deleted content during a side-by-side comparison.
void	setExcludeAreas1(Rectangle[] value) Get and set the exclude areas.
void	setExcludeAreas2(Rectangle[] value) Get and set the exclude areas.
void	setExcludeTables(boolean value) Get and set the option that determines whether tables are excluded from comparison.
void	setInsertColor(Color value) Sets the color used to mark inserted content during a side-by-side comparison.
void	setVentureLicense(com.aspose.pdf.engine.licensemanagement.VentureLicense license)

Methods inherited from class com.aspose.pdf.comparison.outputgenerator.IVentureLicenseTarget

getVentureLicense

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SideBySideComparisonOptions

public SideBySideComparisonOptions()

Creates an instance of SideBySideComparisonOptions class.

Method Detail

getComparisonMode

public final int getComparisonMode()

Gets and sets a comparison mode. The default value is ComparisonMode.IgnoreSpaces.

Returns:

ComparisonMode element

setComparisonMode

public final void setComparisonMode(int value)

Gets and sets a comparison mode. The default value is ComparisonMode.IgnoreSpaces.

Parameters:

value - ComparisonMode element

getAdditionalChangeMarks

public final boolean getAdditionalChangeMarks()

Get and set the property that determines whether additional change markers are displayed. If set, displays change marks that are not on the current page but are present on another page. If the change lacates between words, the mark may not be positioned exactly relative to the whitespace character. The default value is false.

Returns:

boolean value

setAdditionalChangeMarks

public final void setAdditionalChangeMarks(boolean value)

Get and set the property that determines whether additional change markers are displayed. If set, displays change marks that are not on the current page but are present on another page. If the change lacates between words, the mark may not be positioned exactly relative to the whitespace character. The default value is false.

Parameters:

value - boolean value

getExcludeTables

public final boolean getExcludeTables()

Get and set the option that determines whether tables are excluded from comparison. This option cannot be set together with ComparisonArea1(getComparisonArea1()/setComparisonArea1(Rectangle)) and ComparisonArea2(getComparisonArea2()/setComparisonArea2(Rectangle)). The default value is false.

Returns:

boolean value

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 ComparisonArea1(getComparisonArea1()/setComparisonArea1(Rectangle)) and ComparisonArea2(getComparisonArea2()/setComparisonArea2(Rectangle)). The default value is false.

Parameters:

value - boolean value

getComparisonArea1

public final Rectangle getComparisonArea1()

Get and set the comparison area. Used for the first page or document in the comparison method. This option can't be setted along with ExcludeTables(getExcludeTables()/setExcludeTables(boolean)), ExcludeAreas1(getExcludeAreas1()/setExcludeAreas1(Rectangle[])) and ExcludeAreas2(getExcludeAreas2()/setExcludeAreas2(Rectangle[])) options.

Returns:

Rectangle instance

setComparisonArea1

public final void setComparisonArea1(Rectangle value)

Get and set the comparison area. Used for the first page or document in the comparison method. This option can't be setted along with ExcludeTables(getExcludeTables()/setExcludeTables(boolean)), ExcludeAreas1(getExcludeAreas1()/setExcludeAreas1(Rectangle[])) and ExcludeAreas2(getExcludeAreas2()/setExcludeAreas2(Rectangle[])) options.

Parameters:

value - Rectangle instance

getComparisonArea2

public final Rectangle getComparisonArea2()

Get and set the comparison area. Used for the second page or document in the comparison method. This option can't be setted along with ExcludeTables(getExcludeTables()/setExcludeTables(boolean)), ExcludeAreas1(getExcludeAreas1()/setExcludeAreas1(Rectangle[])) and ExcludeAreas2(getExcludeAreas2()/setExcludeAreas2(Rectangle[])) options.

Returns:

Rectangle instance

setComparisonArea2

public final void setComparisonArea2(Rectangle value)

Get and set the comparison area. Used for the second page or document in the comparison method. This option can't be setted along with ExcludeTables(getExcludeTables()/setExcludeTables(boolean)), ExcludeAreas1(getExcludeAreas1()/setExcludeAreas1(Rectangle[])) and ExcludeAreas2(getExcludeAreas2()/setExcludeAreas2(Rectangle[])) options.

Parameters:

value - Rectangle instance

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 ExcludeTables(getExcludeTables()/setExcludeTables(boolean)). This option can't be setted along with ComparisonArea1(getComparisonArea1()/setComparisonArea1(Rectangle)) option.

Returns:

array of Rectangle instances

setExcludeAreas1

public final void setExcludeAreas1(Rectangle[] value)

Get and set the exclude areas. Used for the first page or document in the comparison method. This option can be setted along with ExcludeTables(getExcludeTables()/setExcludeTables(boolean)). This option can't be setted along with ComparisonArea1(getComparisonArea1()/setComparisonArea1(Rectangle)) option.

Parameters:

value - 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 ExcludeTables(getExcludeTables()/setExcludeTables(boolean)). This option can't be setted along with ComparisonArea2(getComparisonArea2()/setComparisonArea2(Rectangle)) option.

Returns:

array of Rectangle instances

setExcludeAreas2

public final void setExcludeAreas2(Rectangle[] value)

Get and set the exclude areas. Used for the second page or document in the comparison method. This option can be setted along with ExcludeTables(getExcludeTables()/setExcludeTables(boolean)). This option can't be setted along with ComparisonArea2(getComparisonArea2()/setComparisonArea2(Rectangle)) option.

Parameters:

value - Rectangle instance

getDeleteColor

public final Color getDeleteColor()

Gets the color used to mark deleted content during a side-by-side comparison. This property defines the visual representation for deletions in the comparison result.

Returns:

the color used to mark deleted content during a side-by-side comparison.

setDeleteColor

public final void setDeleteColor(Color value)

Sets the color used to mark deleted content during a side-by-side comparison. This property defines the visual representation for deletions in the comparison result.

Parameters:

value - the color used to mark deleted content during a side-by-side comparison.

getInsertColor

public final Color getInsertColor()

Gets the color used to mark inserted content during a side-by-side comparison. This property defines the visual representation for insertion in the comparison result.

Returns:

the color used to mark inserted content during a side-by-side comparison.

setInsertColor

public final void setInsertColor(Color value)

Sets the color used to mark inserted content during a side-by-side comparison. This property defines the visual representation for insertion in the comparison result.

Parameters:

value - the color used to mark inserted content during a side-by-side comparison.

setVentureLicense

public final void setVentureLicense(com.aspose.pdf.engine.licensemanagement.VentureLicense license)

Overrides:

setVentureLicense in class IVentureLicenseTarget