Rectangular (FitLayout API 0.0.3 API)

java.lang.Object
- org.fit.layout.model.Rectangular

```
public class Rectangular
extends Object
```
This class represents a general rectangular area.

Author:

radek

Field Summary

Fields
Modifier and Type Field and Description

protected int x1

protected int x2

protected int y1

protected int y2

Fields
Modifier and Type	Field and Description
`protected int`	`x1`
`protected int`	`x2`
`protected int`	`y1`
`protected int`	`y2`

Constructor Summary

Constructors
Constructor and Description
`Rectangular()`
`Rectangular(int x1, int y1)` Creates an empty rectangle at the given coordinates.
`Rectangular(int x1, int y1, int x2, int y2)` Creates a rectangle at the given coordinates.
`Rectangular(Rectangle src)`
`Rectangular(Rectangular src)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(int x, int y)` Checks if this rectangle contains a point.
`void`	`copy(Rectangular src)`
`boolean`	`encloses(Rectangular other)` Checks if this rectangle entirely contains another rectangle.
`boolean`	`enclosesX(Rectangular other)` Checks if this rectangle entirely contains the X coordinates of another rectangle.
`boolean`	`enclosesY(Rectangular other)` Checks if this rectangle entirely contains the Y coordinates of another rectangle.
`boolean`	`equals(Object obj)`
`void`	`expandToEnclose(Rectangular other)`
`int`	`getArea()`
`int`	`getHeight()`
`int`	`getWidth()`
`int`	`getX1()`
`int`	`getX2()`
`int`	`getY1()`
`int`	`getY2()`
`Rectangular`	`hsplit(Rectangular other)` If this rectangle intersets with the other one, splits this rectangle horizontally so that it does not intersect with the other one anymore.
`Rectangular`	`intersection(Rectangular other)` Computes the intersection of this rectangle with another one.
`boolean`	`intersects(Rectangular other)`
`boolean`	`intersectsX(Rectangular other)`
`boolean`	`intersectsY(Rectangular other)`
`boolean`	`isEmpty()`
`int`	`midX()`
`int`	`midY()`
`void`	`move(int xofs, int yofs)` Changes the rectangle coordinates by adding the specified X and Y offsets
`Rectangular`	`replaceX(Rectangular other)` Replaces the X coordinates of the rectangle with the X coordinates of another one.
`Rectangular`	`replaceY(Rectangular other)` Replaces the Y coordinates of the rectangle with the Y coordinates of another one.
`void`	`setX1(int x1)`
`void`	`setX2(int x2)`
`void`	`setY1(int y1)`
`void`	`setY2(int y2)`
`String`	`toString()`
`Rectangular`	`union(Rectangular other)` Computes the union of this rectangle with another one.
`Rectangular`	`vsplit(Rectangular other)` If this rectangle intersets with the other one, splits this rectangle horizontally so that it does not intersect with the other one anymore.

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

- Field Detail
  - x1
```
protected int x1
```
  - y1
```
protected int y1
```
  - x2
```
protected int x2
```
  - y2
```
protected int y2
```
- Constructor Detail
  - Rectangular
```
public Rectangular()
```
  - Rectangular
```
public Rectangular(int x1,
                   int y1,
                   int x2,
                   int y2)
```
    Creates a rectangle at the given coordinates.
    
    Parameters:
    
    x1 -
    
    y1 -
    
    x2 -
    
    y2 -
  - Rectangular
```
public Rectangular(int x1,
                   int y1)
```
    Creates an empty rectangle at the given coordinates.
    
    Parameters:
    
    x1 -
    
    y1 -
  - Rectangular
```
public Rectangular(Rectangular src)
```
  - Rectangular
```
public Rectangular(Rectangle src)
```
- Method Detail
  - copy
```
public void copy(Rectangular src)
```
  - getX1
```
public int getX1()
```
    Returns:
    
    the x1
  - setX1
```
public void setX1(int x1)
```
    Parameters:
    
    x1 - the x1 to set
  - getX2
```
public int getX2()
```
    Returns:
    
    the x2
  - setX2
```
public void setX2(int x2)
```
    Parameters:
    
    x2 - the x2 to set
  - getY1
```
public int getY1()
```
    Returns:
    
    the y1
  - setY1
```
public void setY1(int y1)
```
    Parameters:
    
    y1 - the y1 to set
  - getY2
```
public int getY2()
```
    Returns:
    
    the y2
  - setY2
```
public void setY2(int y2)
```
    Parameters:
    
    y2 - the y2 to set
  - getWidth
```
public int getWidth()
```
  - getHeight
```
public int getHeight()
```
  - midX
```
public int midX()
```
  - midY
```
public int midY()
```
  - move
```
public void move(int xofs,
                 int yofs)
```
    Changes the rectangle coordinates by adding the specified X and Y offsets
    
    Parameters:
    
    xofs - the X offset
    
    yofs - the Y offset
  - getArea
```
public int getArea()
```
  - isEmpty
```
public boolean isEmpty()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - encloses
```
public boolean encloses(Rectangular other)
```
    Checks if this rectangle entirely contains another rectangle.
    
    Parameters:
    
    other - the other rectangle
    
    Returns:
    
    true when the other rectangle is completely contained in this one
  - enclosesX
```
public boolean enclosesX(Rectangular other)
```
    Checks if this rectangle entirely contains the X coordinates of another rectangle.
    
    Parameters:
    
    other - the other rectangle
    
    Returns:
    
    true when the X coordinates of the other rectangle are completely contained in this one
  - enclosesY
```
public boolean enclosesY(Rectangular other)
```
    Checks if this rectangle entirely contains the Y coordinates of another rectangle.
    
    Parameters:
    
    other - the other rectangle
    
    Returns:
    
    true when the Y coordinates of the other rectangle are completely contained in this one
  - contains
```
public boolean contains(int x,
                        int y)
```
    Checks if this rectangle contains a point.
    
    Parameters:
    
    x - the point X coordinate
    
    y - the point Y coordinate
    
    Returns:
    
    true when the point is contained in this one
  - intersects
```
public boolean intersects(Rectangular other)
```
  - intersectsX
```
public boolean intersectsX(Rectangular other)
```
  - intersectsY
```
public boolean intersectsY(Rectangular other)
```
  - intersection
```
public Rectangular intersection(Rectangular other)
```
    Computes the intersection of this rectangle with another one.
    
    Parameters:
    
    other - the other rectangle
    
    Returns:
    
    the resulting intersection or an empty rectangle when there is no intersection
  - union
```
public Rectangular union(Rectangular other)
```
    Computes the union of this rectangle with another one.
    
    Parameters:
    
    other - the other rectangle
    
    Returns:
    
    the union rectangle
  - replaceX
```
public Rectangular replaceX(Rectangular other)
```
    Replaces the X coordinates of the rectangle with the X coordinates of another one.
    
    Parameters:
    
    other - the rectangle whose X coordinates will be used
    
    Returns:
    
    the resulting rectangle
  - replaceY
```
public Rectangular replaceY(Rectangular other)
```
    Replaces the Y coordinates of the rectangle with the Y coordinates of another one.
    
    Parameters:
    
    other - the rectangle whose Y coordinates will be used
    
    Returns:
    
    the resulting rectangle
  - hsplit
```
public Rectangular hsplit(Rectangular other)
```
    If this rectangle intersets with the other one, splits this rectangle horizontally so that it does not intersect with the other one anymore.
    
    Parameters:
    
    other - the rectangle used to split this one
    
    Returns:
    
    if this rectangle had to be split in two parts, the second one is returned. Otherwise, null is returned.
  - vsplit
```
public Rectangular vsplit(Rectangular other)
```
    If this rectangle intersets with the other one, splits this rectangle horizontally so that it does not intersect with the other one anymore.
    
    Parameters:
    
    other - the rectangle used to split this one
    
    Returns:
    
    if this rectangle had to be split in two parts, the second one is returned. Otherwise, null is returned.
  - expandToEnclose
```
public void expandToEnclose(Rectangular other)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Rectangular

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x1

y1

x2

y2

Constructor Detail

Rectangular

Rectangular

Rectangular

Rectangular

Rectangular

Method Detail

copy

getX1

setX1

getX2

setX2

getY1

setY1

getY2

setY2

getWidth

getHeight

midX

midY

move

getArea

isEmpty

equals

encloses

enclosesX

enclosesY

contains

intersects

intersectsX

intersectsY

intersection

union

replaceX

replaceY

hsplit

vsplit

expandToEnclose

toString