PDFRect (Gnostice XtremeDocumentStudio (for Java) API Docs)

java.lang.Object
- com.gnostice.documents.pdf.PDFRect

All Implemented Interfaces:

Cloneable
```
public class PDFRect
extends Object
implements Cloneable
```
This class represents a rectangle or rectangular area on a page. A PdfRect object is specified by x-y coordinates of its top-left corner, its width, and its height. These specifications of a rectangle are applied in a literal sense. As a result, the actual position and size of a rectangle object on a page is wholly dependent on whatever measurement unit that is currently applicable.
For example, on a page where the measurement unit is inch, the height and width of a rectangle will be applied in inches, literally. On a page with pixel as the measurement unit, the rectangle's position and size will be applied in pixels, literally. As this can cause serious shifts in position, care has to be taken when reusing a rectangle in different places or in different situations.

Some classes may have methods that specify a PdfRect object and a particular measurement unit as arguments. In these cases, the position and size of the rectangle are applied in the specified measurement unit. When no measurement unit is specified or cannot be determined, the height, width, and x-y coordinates of its top-left corner will be applied in points, or or points as in "one inch equals 72 points equals 96 pixels."

Since:

1.0

Constructor Summary

Constructors
Constructor and Description
`PDFRect(double x, double y, double width, double height)` Constructs a `PdfRect` object at position (`x`, `y`) with specified width and height.
`PDFRect(PDFArray array, double pageHeight)`
`PDFRect(Rectangle rect)` Constructs a `PdfRect` object with specified `Rectangle` object.
`PDFRect(Rectangle2D rect)` Constructs a `PdfRect` object with specified `Rectangle2D` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`bottom()` Returns distance from top of page to bottom of this rectangle.
`Object`	`clone()`
`double`	`getX()` Returns x-coordinate of top-left corner of this rectangle.
`double`	`getY()` Returns y-coordinate of top-left corner of this rectangle.
`double`	`height()` Returns height of this rectangle.
`double`	`left()` Returns distance from left side of page to left side of this rectangle.
`double`	`right()` Returns distance from left side of page to right side of this rectangle.
`double`	`top()` Returns distance from top side of page to top side of this rectangle.
`String`	`toString()` Returns a string representation of the rectangle.
`double`	`width()` Returns width of this rectangle.

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

- Constructor Detail
  - PDFRect
```
public PDFRect(double x,
               double y,
               double width,
               double height)
```
    Constructs a PdfRect object at position (x, y) with specified width and height.
    
    Parameters:
    
    x - x-coordinate of the top-left corner of the rectangle
    
    y - y-coordinate of the top-left corner of the rectangle
    
    width - width of the rectangle
    
    height - height of the rectangle
    
    Example
    
    See example.
  - PDFRect
```
public PDFRect(Rectangle rect)
```
    Constructs a PdfRect object with specified Rectangle object.
    
    Parameters:
    
    rect - a rectangle
    
    Example
    
    See example.
  - PDFRect
```
public PDFRect(Rectangle2D rect)
```
    Constructs a PdfRect object with specified Rectangle2D object.
    
    Parameters:
    
    rect - a rectangle
    
    Example
    
    See example.
  - PDFRect
```
public PDFRect(PDFArray array,
               double pageHeight)
```
- Method Detail
  - height
```
public double height()
```
    Returns height of this rectangle.
    
    Returns:
    
    height of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - width
```
public double width()
```
    Returns width of this rectangle.
    
    Returns:
    
    width of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - getX
```
public double getX()
```
    Returns x-coordinate of top-left corner of this rectangle.
    
    Returns:
    
    x-coordinate of top-left corner of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - getY
```
public double getY()
```
    Returns y-coordinate of top-left corner of this rectangle.
    
    Returns:
    
    y-coordinate of top-left corner of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - bottom
```
public double bottom()
```
    Returns distance from top of page to bottom of this rectangle.
    
    Returns:
    
    distance from top of page to bottom of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - left
```
public double left()
```
    Returns distance from left side of page to left side of this rectangle.
    
    Returns:
    
    distance from left side of page to left side of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - right
```
public double right()
```
    Returns distance from left side of page to right side of this rectangle.
    
    Returns:
    
    distance from left side of page to right side of this rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - top
```
public double top()
```
    Returns distance from top side of page to top side of this rectangle.
    
    Returns:
    
    distance from top side of page to top side of the rectangle
    
    Since:
    
    1.0
    
    Example
    
    See example.
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Returns a string representation of the rectangle. A rectangle with top-left corner at (200, 100), width of 250, and height of 100 will return a string in the format [x = 200.0 y = 100.0 w = 250.0 h = 100.0].
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string containing the x-coordinate of the top-left corner, y-coordinate of the top-left corner, width, and height of the rectangle

Class PDFRect

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDFRect

PDFRect

PDFRect

PDFRect

Method Detail

height

width

getX

getY

bottom

left

right

top

clone

toString