CompareOverlayOptions (Qoppa jPDFEditor API)

java.lang.Object
- com.qoppa.pdf.compare.CompareOverlayOptions

```
public class CompareOverlayOptions
extends Object
```
This class contains settings used by the PDFEditorBean to display documents in overlay comparison mode.

Constructor Summary

Constructors
Constructor and Description

CompareOverlayOptions()

Constructors
Constructor and Description
`CompareOverlayOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`getColorCompare()` Gets the color of the comparison document.
`Color`	`getColorOriginal()` Gets the color of the original document.
`double`	`getRotation()` Gets the rotation of the overlayed document.
`double`	`getScaleX()` Gets the x scale of the overlayed document.
`double`	`getScaleY()` Gets the y scale of the overlayed document.
`double`	`getX()` Get the x offset of the overlayed document.
`double`	`getY()` Get the y offset of the overlayed document.
`boolean`	`isRenderCompare()` Returns true if the comparison document will render.
`boolean`	`isRenderOriginal()` Returns true if the original document will be rendered.
`void`	`setColorCompare(Color color)` Set the color of the comparison document.
`void`	`setColorOriginal(Color color)` Set the color of the the original document.
`void`	`setRenderCompare(boolean render)` Set to true to show the comparison document.
`void`	`setRenderOriginal(boolean render)` Set to true to show the original document.
`void`	`setRotation(double rotation)` Sets the rotation of the overlayed document.
`void`	`setScaleX(double scaleX)` Sets the x scale of the overlayed document.
`void`	`setScaleY(double scaleY)` Sets the y scale of the overlayed document.
`void`	`setX(double x)` Set the x offset of the overlayed document.
`void`	`setY(double y)` Set the y offset of the overlayed document.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CompareOverlayOptions
```
public CompareOverlayOptions()
```
- Method Detail
  - isRenderOriginal
```
public boolean isRenderOriginal()
```
    Returns true if the original document will be rendered.
    
    Returns:
    
    true if the original document will be rendered in overlay mode.
  - setRenderOriginal
```
public void setRenderOriginal(boolean render)
```
    Set to true to show the original document.
    
    Parameters:
    
    render - Set to true to show the original document.
  - isRenderCompare
```
public boolean isRenderCompare()
```
    Returns true if the comparison document will render.
    
    Returns:
    
    true if the comparison document will render.
  - setRenderCompare
```
public void setRenderCompare(boolean render)
```
    Set to true to show the comparison document.
    
    Parameters:
    
    render - Set to true to show the comparison document.
  - setColorOriginal
```
public void setColorOriginal(Color color)
```
    Set the color of the the original document.
    
    Parameters:
    
    color - The color of the original document.
  - getColorOriginal
```
public Color getColorOriginal()
```
    Gets the color of the original document.
    
    Returns:
    
    The color the original document.
  - setColorCompare
```
public void setColorCompare(Color color)
```
    Set the color of the comparison document.
    
    Parameters:
    
    color - The color of the comparison document.
  - getColorCompare
```
public Color getColorCompare()
```
    Gets the color of the comparison document.
    
    Returns:
    
    The color of the comparison document.
  - getX
```
public double getX()
```
    Get the x offset of the overlayed document.
    
    Returns:
    
    The x offset of the overlayed document.
  - setX
```
public void setX(double x)
```
    Set the x offset of the overlayed document.
    
    Parameters:
    
    x - The x offset of the overlayed document.
  - getY
```
public double getY()
```
    Get the y offset of the overlayed document.
    
    Returns:
    
    the y offset of the overlayed document.
  - setY
```
public void setY(double y)
```
    Set the y offset of the overlayed document.
    
    Parameters:
    
    y - The y offset of the overlayed document.
  - getRotation
```
public double getRotation()
```
    Gets the rotation of the overlayed document.
    
    Returns:
    
    The rotation of the overlayed document.
  - setRotation
```
public void setRotation(double rotation)
```
    Sets the rotation of the overlayed document.
    
    Parameters:
    
    rotation -
  - getScaleX
```
public double getScaleX()
```
    Gets the x scale of the overlayed document.
    
    Returns:
    
    The x scale of the overlayed document.
  - setScaleX
```
public void setScaleX(double scaleX)
```
    Sets the x scale of the overlayed document.
    
    Parameters:
    
    scaleX - The x scale of the overlayed document.
  - getScaleY
```
public double getScaleY()
```
    Gets the y scale of the overlayed document.
    
    Returns:
    
    The y scale of the overlayed document.
  - setScaleY
```
public void setScaleY(double scaleY)
```
    Sets the y scale of the overlayed document.
    
    Parameters:
    
    scaleY - The y scale of the overlayed document.

Class CompareOverlayOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompareOverlayOptions

Method Detail

isRenderOriginal

setRenderOriginal

isRenderCompare

setRenderCompare

setColorOriginal

getColorOriginal

setColorCompare

getColorCompare

getX

setX

getY

setY

getRotation

setRotation

getScaleX

setScaleX

getScaleY

setScaleY