com.adobe.livecycle.signatures.client.types
Class PositionRectangle

java.lang.Object
  com.adobe.livecycle.signatures.client.types.PositionRectangle

All Implemented Interfaces:

java.io.Serializable

public class PositionRectangle
extends java.lang.Object
implements java.io.Serializable

Represents the position of a signature field located within a PDF document. A signature field's rectangle defines the location of the signature field on the PDF document page in default user space units. An object of this type is used when programmatically adding a signature field to a PDF document. To see this type used in a code example, see the Adding a signature field to a PDF document using the Java API quick start in Programming with Adobe Experience Manager forms.

See Also:

Serialized Form

Constructor Summary

PositionRectangle()
A constructor that creates a PositionRectangle object.

PositionRectangle(int lowerLeftX, int lowerLeftY, int width, int height)
A constructor that creates a PositionRectangle object.

Method Summary

boolean	equals(java.lang.Object obj) Specifies if this type is equal to a specific object.
int	getHeight() Returns the height of the signature field.
int	getLowerLeftX() Returns the lower-left X position of the signature field.
int	getLowerLeftY() Returns the lower-left Y position of the signature field.
int	getWidth() Returns the width of the signature field.
void	setHeight(int height) Sets the height of the signature field.
void	setLowerLeftX(int lowerLeftX) Sets the lower-left X position of the signature field.
void	setLowerLeftY(int lowerLeftY) Sets the lower-left Y position of the signature field.
void	setWidth(int width) Sets the width of the signature field.
java.lang.String	toString() Returns this type as a string.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PositionRectangle

public PositionRectangle()

A constructor that creates a PositionRectangle object.

PositionRectangle

public PositionRectangle(int lowerLeftX,
                         int lowerLeftY,
                         int width,
                         int height)

A constructor that creates a PositionRectangle object.

Parameters:

lowerLeftX - The lower-left X side of the signature field.

lowerLeftY - The lower-left Y side of the signature field.

width - The width of the signature field.

height - The height of the signature field.

Negative values are not allowed for lowerLeftX and lowerLeftY because the origin of PDF documents start at lower left (for example, 0,0). Negative values are not allowed for height and width values.

Method Detail

getHeight

public int getHeight()

Returns the height of the signature field.

Returns:

The height of the signature field.

getWidth

public int getWidth()

Returns the width of the signature field.

Returns:

The width of the signature field.

toString

public java.lang.String toString()

Returns this type as a string.

Overrides:

toString in class java.lang.Object

Returns:

A string value that represents this object.

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object obj)

Specifies if this type is equal to a specific object.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getLowerLeftX

public int getLowerLeftX()

Returns the lower-left X position of the signature field.

Returns:

The lower-left X position of the signature field.

setLowerLeftX

public void setLowerLeftX(int lowerLeftX)

Sets the lower-left X position of the signature field.

Parameters:

lowerLeftX - The lower-left X position of the signature field.

getLowerLeftY

public int getLowerLeftY()

Returns the lower-left Y position of the signature field.

Returns:

The lower-left Y position of the signature field.

setLowerLeftY

public void setLowerLeftY(int lowerLeftY)

Sets the lower-left Y position of the signature field.

Parameters:

lowerLeftY - The lower-left Y position of the signature field.

setHeight

public void setHeight(int height)

Sets the height of the signature field.

Parameters:

height - The height of the signature field.

setWidth

public void setWidth(int width)

Sets the width of the signature field.

Parameters:

width - The width of the signature field.