RectF

java.lang.Object
- CPDFGeneration.android.graphics.RectF

```
public class RectF
extends java.lang.Object
```
A rectangle with float coordinates.
The rectangle is represented by four edges: left, top, right, bottom. This is similar in spirit to Android's android.graphics.RectF.

Unless otherwise stated, this class does not enforce that left <= right and top <= bottom. Some operations assume a non-empty rectangle.

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`bottom` The Y coordinate of the bottom edge of the rectangle.
`float`	`left` The X coordinate of the left edge of the rectangle.
`float`	`right` The X coordinate of the right edge of the rectangle.
`float`	`top` The Y coordinate of the top edge of the rectangle.

Constructor Summary

Constructors
Constructor and Description
`RectF()` Creates an empty rectangle with all coordinates initialized to `0`.
`RectF(float left, float top, float right, float bottom)` Creates a rectangle with the specified coordinates.
`RectF(RectF r)` Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`centerX()` Returns the horizontal center coordinate of the rectangle: `(left + right) / 2`.
`float`	`centerY()` Returns the vertical center coordinate of the rectangle: `(top + bottom) / 2`.
`boolean`	`contains(float x, float y)` Returns whether the point `(x, y)` is inside the rectangle.
`boolean`	`contains(float left, float top, float right, float bottom)` Returns whether the rectangle defined by the specified edges is fully contained within this rectangle.
`boolean`	`contains(RectF r)` Returns whether `r` is fully contained within this rectangle.
`boolean`	`equals(java.lang.Object o)` Indicates whether some other object is "equal to" this one.
`int`	`hashCode()` Returns a hash code value for this rectangle.
`float`	`height()` Returns the rectangle's height: `bottom - top`.
`void`	`inset(float dx, float dy)` Insets the rectangle by `(dx, dy)`.
`boolean`	`intersect(float left, float top, float right, float bottom)` Intersects this rectangle with the rectangle defined by the specified edges.
`boolean`	`intersect(RectF r)` Intersects this rectangle with `r`.
`boolean`	`intersects(float left, float top, float right, float bottom)` Returns whether this rectangle intersects the rectangle defined by the specified edges.
`static boolean`	`intersects(RectF a, RectF b)` Returns whether rectangles `a` and `b` intersect.
`boolean`	`isEmpty()` Returns `true` if the rectangle is empty (i.e.
`void`	`offset(float dx, float dy)` Offsets the rectangle by adding `dx` to `left`/`right` and `dy` to `top`/`bottom`.
`void`	`offsetTo(float newLeft, float newTop)` Moves the rectangle so that its top-left corner becomes `(newLeft, newTop)`, keeping its width and height unchanged.
`void`	`printShortString(java.io.PrintWriter pw)` Prints the compact representation of this rectangle to the given `PrintWriter`.
`void`	`scale(float scale)` Scales this rectangle in place by the given factor.
`void`	`set(float left, float top, float right, float bottom)` Sets this rectangle's coordinates to the specified values.
`void`	`set(RectF src)` Copies the coordinates from `src` into this rectangle.
`void`	`setEmpty()` Sets this rectangle to `(0,0,0,0)`.
`boolean`	`setIntersect(RectF a, RectF b)` Sets this rectangle to the intersection of `a` and `b`.
`void`	`sort()` Ensures that `left <= right` and `top <= bottom` by swapping edges if needed.
`java.lang.String`	`toShortString()` Returns a compact string representation of this rectangle.
`java.lang.String`	`toShortString(java.lang.StringBuilder sb)` Returns a compact string representation of this rectangle using the provided `StringBuilder`.
`java.lang.String`	`toString()` Returns a string representation of this rectangle.
`void`	`union(float x, float y)` Expands this rectangle to include the point `(x, y)`.
`void`	`union(float left, float top, float right, float bottom)` Unions this rectangle with the rectangle defined by the specified edges.
`void`	`union(RectF r)` Unions this rectangle with `r`.
`float`	`width()` Returns the rectangle's width: `right - left`.

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

- Field Detail
  - left
```
public float left
```
    The X coordinate of the left edge of the rectangle.
  - top
```
public float top
```
    The Y coordinate of the top edge of the rectangle.
  - right
```
public float right
```
    The X coordinate of the right edge of the rectangle.
  - bottom
```
public float bottom
```
    The Y coordinate of the bottom edge of the rectangle.
- Constructor Detail
  - RectF
```
public RectF()
```
    Creates an empty rectangle with all coordinates initialized to 0.
  - RectF
```
public RectF(float left,
             float top,
             float right,
             float bottom)
```
    Creates a rectangle with the specified coordinates.
    No range checking is performed; the caller must ensure that left <= right and top <= bottom if a non-empty rectangle is required.
    
    Parameters:
    
    left - x coordinate of the left edge
    
    top - y coordinate of the top edge
    
    right - x coordinate of the right edge
    
    bottom - y coordinate of the bottom edge
  - RectF
```
public RectF(RectF r)
```
    Copy constructor. Creates a rectangle initialized with the values from r.
    If r is null, this rectangle is set to empty (all zeros).
    
    Parameters:
    
    r - the rectangle to copy from; may be null
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    Indicates whether some other object is "equal to" this one.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the reference object with which to compare
    
    Returns:
    
    true if this rectangle has the same edge values as o; otherwise false
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this rectangle.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    hash code
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this rectangle.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representation in the form RectF(left, top, right, bottom)
  - toShortString
```
public java.lang.String toShortString()
```
    Returns a compact string representation of this rectangle.
    
    Returns:
    
    compact string in the form [left,top][right,bottom]
  - toShortString
```
public java.lang.String toShortString(java.lang.StringBuilder sb)
```
    Returns a compact string representation of this rectangle using the provided StringBuilder.
    
    Parameters:
    
    sb - builder to write into (will be cleared)
    
    Returns:
    
    compact string in the form [left,top][right,bottom]
    
    Throws:
    
    java.lang.NullPointerException - if sb is null
  - printShortString
```
public void printShortString(java.io.PrintWriter pw)
```
    Prints the compact representation of this rectangle to the given PrintWriter.
    
    Parameters:
    
    pw - writer to print to
    
    Throws:
    
    java.lang.NullPointerException - if pw is null
  - isEmpty
```
public final boolean isEmpty()
```
    Returns true if the rectangle is empty (i.e. left >= right or top >= bottom).
    
    Returns:
    
    true if empty; otherwise false
  - width
```
public final float width()
```
    Returns the rectangle's width: right - left.
    No validation is performed; the result may be negative if left > right.
    
    Returns:
    
    width value
  - height
```
public final float height()
```
    Returns the rectangle's height: bottom - top.
    No validation is performed; the result may be negative if top > bottom.
    
    Returns:
    
    height value
  - centerX
```
public final float centerX()
```
    Returns the horizontal center coordinate of the rectangle: (left + right) / 2.
    No validation is performed.
    
    Returns:
    
    x coordinate of center
  - centerY
```
public final float centerY()
```
    Returns the vertical center coordinate of the rectangle: (top + bottom) / 2.
    No validation is performed.
    
    Returns:
    
    y coordinate of center
  - setEmpty
```
public void setEmpty()
```
    Sets this rectangle to (0,0,0,0).
  - set
```
public void set(float left,
                float top,
                float right,
                float bottom)
```
    Sets this rectangle's coordinates to the specified values.
    No range checking is performed; the caller must ensure that left <= right and top <= bottom if a non-empty rectangle is required.
    
    Parameters:
    
    left - x coordinate of the left edge
    
    top - y coordinate of the top edge
    
    right - x coordinate of the right edge
    
    bottom - y coordinate of the bottom edge
  - set
```
public void set(RectF src)
```
    Copies the coordinates from src into this rectangle.
    
    Parameters:
    
    src - the source rectangle
    
    Throws:
    
    java.lang.NullPointerException - if src is null
  - offset
```
public void offset(float dx,
                   float dy)
```
    Offsets the rectangle by adding dx to left/right and dy to top/bottom.
    
    Parameters:
    
    dx - delta x
    
    dy - delta y
  - offsetTo
```
public void offsetTo(float newLeft,
                     float newTop)
```
    Moves the rectangle so that its top-left corner becomes (newLeft, newTop), keeping its width and height unchanged.
    
    Parameters:
    
    newLeft - new left coordinate
    
    newTop - new top coordinate
  - inset
```
public void inset(float dx,
                  float dy)
```
    Insets the rectangle by (dx, dy).
    - If dx > 0, the rectangle becomes narrower; if dx < 0, it becomes wider.
    - If dy > 0, the rectangle becomes shorter; if dy < 0, it becomes taller.
    Parameters:
    
    dx - amount to add/subtract on left/right edges
    
    dy - amount to add/subtract on top/bottom edges
  - contains
```
public boolean contains(float x,
                        float y)
```
    Returns whether the point (x, y) is inside the rectangle.
    The left and top edges are considered inside; the right and bottom edges are considered outside. That is, containment means left <= x < right and top <= y < bottom.
    
    An empty rectangle never contains any point.
    
    Parameters:
    
    x - x coordinate to test
    
    y - y coordinate to test
    
    Returns:
    
    true if the point is contained; otherwise false
  - contains
```
public boolean contains(float left,
                        float top,
                        float right,
                        float bottom)
```
    Returns whether the rectangle defined by the specified edges is fully contained within this rectangle.
    
    Parameters:
    
    left - left edge of the rectangle to test
    
    top - top edge of the rectangle to test
    
    right - right edge of the rectangle to test
    
    bottom - bottom edge of the rectangle to test
    
    Returns:
    
    true if the specified rectangle is contained; otherwise false
  - contains
```
public boolean contains(RectF r)
```
    Returns whether r is fully contained within this rectangle.
    
    Parameters:
    
    r - rectangle to test
    
    Returns:
    
    true if r is contained; otherwise false
    
    Throws:
    
    java.lang.NullPointerException - if r is null
  - intersect
```
public boolean intersect(float left,
                         float top,
                         float right,
                         float bottom)
```
    Intersects this rectangle with the rectangle defined by the specified edges.
    If the rectangles intersect, this rectangle is updated to the intersection and true is returned. Otherwise this rectangle is not modified and false is returned.
    
    Parameters:
    
    left - left edge of the other rectangle
    
    top - top edge of the other rectangle
    
    right - right edge of the other rectangle
    
    bottom - bottom edge of the other rectangle
    
    Returns:
    
    true if an intersection occurred and this rectangle was updated; otherwise false
  - intersect
```
public boolean intersect(RectF r)
```
    Intersects this rectangle with r.
    
    Parameters:
    
    r - other rectangle
    
    Returns:
    
    true if an intersection occurred and this rectangle was updated; otherwise false
    
    Throws:
    
    java.lang.NullPointerException - if r is null
  - setIntersect
```
public boolean setIntersect(RectF a,
                            RectF b)
```
    Sets this rectangle to the intersection of a and b.
    
    Parameters:
    
    a - first rectangle
    
    b - second rectangle
    
    Returns:
    
    true if a and b intersect and this rectangle was updated; otherwise false
    
    Throws:
    
    java.lang.NullPointerException - if a or b is null
  - intersects
```
public boolean intersects(float left,
                          float top,
                          float right,
                          float bottom)
```
    Returns whether this rectangle intersects the rectangle defined by the specified edges.
    This method does not modify this rectangle.
    
    Parameters:
    
    left - left edge of the other rectangle
    
    top - top edge of the other rectangle
    
    right - right edge of the other rectangle
    
    bottom - bottom edge of the other rectangle
    
    Returns:
    
    true if the rectangles intersect; otherwise false
  - intersects
```
public static boolean intersects(RectF a,
                                 RectF b)
```
    Returns whether rectangles a and b intersect.
    
    Parameters:
    
    a - first rectangle
    
    b - second rectangle
    
    Returns:
    
    true if they intersect; otherwise false
    
    Throws:
    
    java.lang.NullPointerException - if a or b is null
  - union
```
public void union(float left,
                  float top,
                  float right,
                  float bottom)
```
    Unions this rectangle with the rectangle defined by the specified edges.
    If this rectangle is empty, it becomes the specified rectangle. If the specified rectangle is empty, no changes are made.
    
    Parameters:
    
    left - left edge to union
    
    top - top edge to union
    
    right - right edge to union
    
    bottom - bottom edge to union
  - union
```
public void union(RectF r)
```
    Unions this rectangle with r.
    
    Parameters:
    
    r - rectangle to union with
    
    Throws:
    
    java.lang.NullPointerException - if r is null
  - union
```
public void union(float x,
                  float y)
```
    Expands this rectangle to include the point (x, y).
    No check is performed to see whether this rectangle is non-empty.
    
    Parameters:
    
    x - x coordinate of the point to include
    
    y - y coordinate of the point to include
  - sort
```
public void sort()
```
    Ensures that left <= right and top <= bottom by swapping edges if needed.
    If the edges are already in order, nothing changes.
  - scale
```
public void scale(float scale)
```
    Scales this rectangle in place by the given factor.
    
    Parameters:
    
    scale - scale factor (e.g. 2.0f doubles the size)

Class RectF

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

left

top

right

bottom

Constructor Detail

RectF

RectF

RectF

Method Detail

equals

hashCode

toString

toShortString

toShortString

printShortString

isEmpty

width

height

centerX

centerY

setEmpty

set

set

offset

offsetTo

inset

contains

contains

contains

intersect

intersect

setIntersect

intersects

intersects

union

union

union

sort

scale