com.qoppa.pdf

Class CompareOptions

java.lang.Object

com.qoppa.pdf.CompareOptions

public class CompareOptions
extends Object

The options to use when adding a PDFDocument as a layer to a comparison document.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
CompareOptions() Default constructor.

Method Summary

Modifier and Type	Method and Description
Color	getColor() Gets the color used for the CompareOptions when converting the PDF content.
String	getLayerName() Gets the layer name used for the CompareOptions.
double	getRotation() Returns the rotation value used for positioning the PDF content.
double	getScaleX() Returns the X scale value used for positioning the PDF content.
double	getScaleY() Returns the Y scale value used for positioning the PDF content.
double	getX() Returns the X translate coordinate used for positioning the PDF content.
double	getY() Returns the Y translate coordinate used for positioning the PDF content.
void	setColor(Color color) Sets the color for the CompareOptions to be used when converting the PDF content.
void	setLayerName(String layerName) Sets the layer name of the CompareOptions.
void	setRotation(double rotation) Sets the rotation value used to position the PDF content.
void	setScaleX(double scaleX) Sets the X scale value used to position the PDF content.
void	setScaleY(double scaleY) Sets the Y scale value used to position the PDF content.
void	setX(double x) Sets the X translate coordinate used to position the PDF content.
void	setY(double y) Sets the Y translate coordinate used to position the PDF content.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompareOptions

public CompareOptions()

Default constructor. Creates a new CompareOptions with default values.

• layerName = "layer"
• color = Color.red
• x, y = 0
• scaleX, scaleY = 1
• rotation = 0

See Also:

Color

Method Detail

getLayerName

public String getLayerName()

Gets the layer name used for the CompareOptions.

Returns:

the layer name for the CompareOptions

See Also:

setLayerName(java.lang.String)

setLayerName

public void setLayerName(String layerName)

Sets the layer name of the CompareOptions.

Parameters:

layerName - the string for the layer name for the CompareOptions

See Also:

getLayerName()

getColor

public Color getColor()

Gets the color used for the CompareOptions when converting the PDF content.

Returns:

the color for the CompareOptions

See Also:

setColor(java.awt.Color)

setColor

public void setColor(Color color)

Sets the color for the CompareOptions to be used when converting the PDF content.

Parameters:

color - the color for the CompareOptions

See Also:

getLayerName()

getX

public double getX()

Returns the X translate coordinate used for positioning the PDF content. Default is 0.

Returns:

the X translate coordinate.

See Also:

setX(double)

setX

public void setX(double x)

Sets the X translate coordinate used to position the PDF content. Default is 0.

Parameters:

x -

See Also:

getX()

getY

public double getY()

Returns the Y translate coordinate used for positioning the PDF content. Default is 0.

Returns:

the Y translate coordinate.

See Also:

setY(double)

setY

public void setY(double y)

Sets the Y translate coordinate used to position the PDF content. Default is 0.

Parameters:

y -

See Also:

getY()

getScaleX

public double getScaleX()

Returns the X scale value used for positioning the PDF content. Default is 1.

Returns:

the X scale value.

See Also:

setScaleX(double)

setScaleX

public void setScaleX(double scaleX)

Sets the X scale value used to position the PDF content. Default is 1.

Parameters:

scaleX -

See Also:

getScaleX()

getScaleY

public double getScaleY()

Returns the Y scale value used for positioning the PDF content. Default is 1.

Returns:

the Y scale value.

See Also:

setScaleY(double)

setScaleY

public void setScaleY(double scaleY)

Sets the Y scale value used to position the PDF content. Default is 1.

Parameters:

scaleY -

See Also:

getScaleY()

getRotation

public double getRotation()

Returns the rotation value used for positioning the PDF content. Default is 0.

Returns:

the rotation value.

See Also:

setRotation(double)

setRotation

public void setRotation(double rotation)

Sets the rotation value used to position the PDF content. Default is 0.

Parameters:

rotation -

See Also:

getRotation()