| java.lang.Object | ||
| ↳ | com.pdftron.pdf.OptionsBase | |
| ↳ | com.pdftron.pdf.DiffOptions | |
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
DiffOptions()
Constructor.
| |||||||||||
|
DiffOptions(String json_string)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
getAddGroupAnnots()
Gets the value AddGroupAnnots from the options object
Whether we should add an annot layer indicating the difference regions
| ||||||||||
| int |
getBlendMode()
Gets the value BlendMode from the options object
How the two colors should be blended.
| ||||||||||
| ColorPt |
getColorA()
Gets the value ColorA from the options object
The difference color for the first page.
| ||||||||||
| ColorPt |
getColorB()
Gets the value ColorB from the options object
The difference color for the second page
| ||||||||||
| double |
getLuminosityCompression()
Gets the value LuminosityCompression from the options object.
| ||||||||||
| DiffOptions |
setAddGroupAnnots(boolean value)
Sets the value for AddGroupAnnots in the options object
Whether we should add an annot layer indicating the difference regions
| ||||||||||
| DiffOptions |
setBlendMode(int value)
Sets the value for BlendMode in the options object
How the two colors should be blended.
| ||||||||||
| DiffOptions |
setColorA(ColorPt value)
Sets the value for ColorA in the options object
The difference color for the first page.
| ||||||||||
| DiffOptions |
setColorB(ColorPt value)
Sets the value for ColorB in the options object
The difference color for the second page
| ||||||||||
| DiffOptions |
setLuminosityCompression(double value)
Sets the value for LuminosityCompression in the options object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
Public Methods
public boolean getAddGroupAnnots ()
Gets the value AddGroupAnnots from the options object Whether we should add an annot layer indicating the difference regions
Returns
- a boolean, Whether we should add an annot layer indicating the difference regions.
Throws
| PDFNetException |
|---|
public int getBlendMode ()
Gets the value BlendMode from the options object How the two colors should be blended.
Returns
- a int, How the two colors should be blended..
Throws
| PDFNetException |
|---|
public ColorPt getColorA ()
Gets the value ColorA from the options object The difference color for the first page.
Returns
- a ColorPt, The difference color for the first page..
Throws
| PDFNetException |
|---|
public ColorPt getColorB ()
Gets the value ColorB from the options object The difference color for the second page
Returns
- a ColorPt, The difference color for the second page.
Throws
| PDFNetException |
|---|
public double getLuminosityCompression ()
Gets the value LuminosityCompression from the options object. Allows for a more or less binary comparison. High values will cause the visual comparison to behave in a strict difference/no difference fashion, while values closer to one will produce more nuanced diffs. Note: This is a special-purpose API for very specific advanced use cases. Most users can safely ignore it.
Returns
- The current value for LuminosityCompression.
Throws
| PDFNetException |
|---|
public DiffOptions setAddGroupAnnots (boolean value)
Sets the value for AddGroupAnnots in the options object Whether we should add an annot layer indicating the difference regions
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DiffOptions setBlendMode (int value)
Sets the value for BlendMode in the options object How the two colors should be blended.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DiffOptions setColorA (ColorPt value)
Sets the value for ColorA in the options object The difference color for the first page.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DiffOptions setColorB (ColorPt value)
Sets the value for ColorB in the options object The difference color for the second page
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public DiffOptions setLuminosityCompression (double value)
Sets the value for LuminosityCompression in the options object. Allows for a more or less binary comparison. High values will cause the visual comparison to behave in a strict difference/no difference fashion, while values closer to one will produce more nuanced diffs. Note: This is a special-purpose API for very specific advanced use cases. Most users can safely ignore it.
Parameters
| value | The new value for LuminosityCompression. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|