com.aspose.drawing

Class Rectangle

java.lang.Object

com.aspose.ms.System.ValueType<T>

com.aspose.ms.lang.Struct<Rectangle>

com.aspose.drawing.Rectangle

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<Rectangle>, Cloneable

public class Rectangle
extends com.aspose.ms.lang.Struct<Rectangle>
implements com.aspose.ms.System.IEquatable<Rectangle>, Cloneable

Stores a set of four integers that represent the location and size of a rectangle.

Constructor Summary

Constructors

Constructor and Description
Rectangle()
Rectangle(int x, int y, int width, int height) Initializes a new instance of the Rectangle structure with the specified location and size.
Rectangle(Point location, Size size) Initializes a new instance of the Rectangle struct with the specified location and size.

Method Summary

Modifier and Type	Method and Description
static Rectangle	ceiling(RectangleF value) Converts the specified RectangleF structure to a Rectangle structure by rounding the RectangleF values to the next higher integer values.
Object	clone()
Rectangle	Clone()
void	CloneTo(Rectangle that)
boolean	contains(int x, int y) Determines if the specified point is contained within this Rectangle structure.
boolean	contains(Point pt) Determines if the specified point is contained within this Rectangle structure.
boolean	contains(Rectangle rect)
boolean	equals(Object obj) Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure.
boolean	equals(Rectangle other) Tests whether other Rectangle structure has the same location and size of this Rectangle structure.
static Rectangle	fromLTRB(int left, int top, int right, int bottom) Creates a Rectangle structure with the specified edge locations.
static Rectangle	fromPoints(Point point1, Point point2) Creates a new rectangle from two points.
int	getBottom() Gets the y-coordinate that is the sum of the Y and Height property values of this Rectangle structure.
static Rectangle	getEmpty() Gets a new instance of the Rectangle structure that has Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values set to zero.
int	getHeight() Gets the height of this Rectangle structure.
int	getLeft() Gets the x-coordinate of the left edge of this Rectangle structure.
Point	getLocation() Gets the coordinates of the upper-left corner of this Rectangle structure.
int	getRight() Gets the x-coordinate that is the sum of X and Width property values of this Rectangle structure.
Size	getSize() Gets the size of this Rectangle.
int	getTop() Gets the y-coordinate of the top edge of this Rectangle structure.
int	getWidth() Gets the width of this Rectangle structure.
int	getX() Gets the x-coordinate of the upper-left corner of this Rectangle structure.
int	getY() Gets the y-coordinate of the upper-left corner of this Rectangle structure.
int	hashCode() Returns the hash code for this Rectangle structure.
void	inflate(int width, int height) Enlarges this Rectangle by the specified amount.
static Rectangle	inflate(Rectangle rect, int x, int y)
void	inflate(Size size) Enlarges this Rectangle by the specified amount.
void	intersect(Rectangle rect) Replaces this Rectangle with the intersection of itself and the specified Rectangle.
static Rectangle	intersect(Rectangle a, Rectangle b) Returns a third Rectangle structure that represents the intersection of two other Rectangle structures.
boolean	intersectsWith(Rectangle rect) Determines if this rectangle intersects with rect.
boolean	isEmpty() Gets a value indicating whether all numeric properties of this Rectangle have values of zero.
static boolean	isEquals(Rectangle obj1, Rectangle obj2)
void	normalize() Normalizes the rectangle by making it's width and height positive, left less than right and top less than bottom.
void	offset(int x, int y) Adjusts the location of this rectangle by the specified amount.
void	offset(Point pos) Adjusts the location of this rectangle by the specified amount.
static boolean	op_Equality(Rectangle left, Rectangle right) Tests whether two Rectangle structures have equal location and size.
static boolean	op_Inequality(Rectangle left, Rectangle right) Tests whether two Rectangle structures differ in location or size.
static Rectangle	round(RectangleF value) Converts the specified RectangleF to a Rectangle by rounding the RectangleF values to the nearest integer values.
void	setHeight(int value) Sets the height of this Rectangle structure.
void	setLocation(Point value) Sets the coordinates of the upper-left corner of this Rectangle structure.
void	setSize(Size value) Sets the size of this Rectangle.
void	setWidth(int value) Sets the width of this Rectangle structure.
void	setX(int value) Sets the x-coordinate of the upper-left corner of this Rectangle structure.
void	setY(int value) Sets the y-coordinate of the upper-left corner of this Rectangle structure.
String	toString()
static Rectangle	truncate(RectangleF value) Converts the specified RectangleF to a Rectangle by truncating the RectangleF values.
static Rectangle	union(Rectangle a, Rectangle b) Gets a Rectangle structure that contains the union of two Rectangle structures.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rectangle

public Rectangle()

Rectangle

public Rectangle(int x,
                 int y,
                 int width,
                 int height)

Initializes a new instance of the Rectangle structure with the specified location and size.

Parameters:

x - The x-coordinate of the upper-left corner of the rectangle.

y - The y-coordinate of the upper-left corner of the rectangle.

width - The width of the rectangle.

height - The height of the rectangle.

Rectangle

public Rectangle(Point location,
                 Size size)

Initializes a new instance of the Rectangle struct with the specified location and size.

Parameters:

location - A Point that represents the upper-left corner of the rectangular region.

size - A Size(Rectangle.getSize()/Rectangle.setSize(Size)) that represents the width and height of the rectangular region.

Method Detail

fromLTRB

public static Rectangle fromLTRB(int left,
                                 int top,
                                 int right,
                                 int bottom)

Creates a Rectangle structure with the specified edge locations.

Parameters:

left - The x-coordinate of the upper-left corner of this Rectangle structure.

top - The y-coordinate of the upper-left corner of this Rectangle structure.

right - The x-coordinate of the lower-right corner of this Rectangle structure.

bottom - The y-coordinate of the lower-right corner of this Rectangle structure.

Returns:

The new Rectangle that this method creates.

intersect

public static Rectangle intersect(Rectangle a,
                                  Rectangle b)

Returns a third Rectangle structure that represents the intersection of two other Rectangle structures. If there is no intersection, an empty Rectangle is returned.

Parameters:

a - First rectangle to intersect.

b - Second rectangle to intersect.

Returns:

A Rectangle that represents the intersection of a and b.

op_Equality

public static boolean op_Equality(Rectangle left,
                                  Rectangle right)

Tests whether two Rectangle structures have equal location and size.

Parameters:

left - The Rectangle structure that is to the left of the equality operator.

right - The Rectangle structure that is to the right of the equality operator.

Returns:

This operator returns true if the two Rectangle structures have equal X, Y, Width, and Height properties.

op_Inequality

public static boolean op_Inequality(Rectangle left,
                                    Rectangle right)

Tests whether two Rectangle structures differ in location or size.

Parameters:

left - The Rectangle structure that is to the left of the inequality operator.

right - The Rectangle structure that is to the right of the inequality operator.

Returns:

This operator returns true if any of the X, Y, Width or Height properties of the two Rectangle structures are unequal; otherwise false.

ceiling

public static Rectangle ceiling(RectangleF value)

Converts the specified RectangleF structure to a Rectangle structure by rounding the RectangleF values to the next higher integer values.

Parameters:

value - The RectangleF structure to be converted.

Returns:

Returns a Rectangle.

truncate

public static Rectangle truncate(RectangleF value)

Converts the specified RectangleF to a Rectangle by truncating the RectangleF values.

Parameters:

value - The RectangleF to be converted.

Returns:

The truncated value of the Rectangle.

round

public static Rectangle round(RectangleF value)

Converts the specified RectangleF to a Rectangle by rounding the RectangleF values to the nearest integer values.

Parameters:

value - The RectangleF to be converted.

Returns:

A Rectangle.

union

public static Rectangle union(Rectangle a,
                              Rectangle b)

Gets a Rectangle structure that contains the union of two Rectangle structures.

Parameters:

a - A first rectangle to union.

b - A second rectangle to union.

Returns:

A Rectangle structure that bounds the union of the two Rectangle structures.

inflate

public static Rectangle inflate(Rectangle rect,
                                int x,
                                int y)

isEquals

public static boolean isEquals(Rectangle obj1,
                               Rectangle obj2)

fromPoints

public static Rectangle fromPoints(Point point1,
                                   Point point2)

Creates a new rectangle from two points. The created rectangle will be normalized with (left,top) lower than (right,bottom).

Parameters:

point1 - The first point.

point2 - The second point.

Returns:

A newly created rectangle.

getEmpty

public static Rectangle getEmpty()

Gets a new instance of the Rectangle structure that has Rectangle.X, Rectangle.Y, Rectangle.Width and Rectangle.Height values set to zero.

getX

public final int getX()

Gets the x-coordinate of the upper-left corner of this Rectangle structure.

Returns:

the x-coordinate of the upper-left corner of this Rectangle structure.

setX

public final void setX(int value)

Sets the x-coordinate of the upper-left corner of this Rectangle structure.

Parameters:

value - the x-coordinate of the upper-left corner of this Rectangle structure.

getY

public final int getY()

Gets the y-coordinate of the upper-left corner of this Rectangle structure.

Returns:

the y-coordinate of the upper-left corner of this Rectangle structure.

setY

public final void setY(int value)

Sets the y-coordinate of the upper-left corner of this Rectangle structure.

Parameters:

value - the y-coordinate of the upper-left corner of this Rectangle structure.

getLocation

public final Point getLocation()

Gets the coordinates of the upper-left corner of this Rectangle structure.

Returns:

the coordinates of the upper-left corner of this Rectangle structure.

setLocation

public final void setLocation(Point value)

Sets the coordinates of the upper-left corner of this Rectangle structure.

Parameters:

value - the coordinates of the upper-left corner of this Rectangle structure.

getWidth

public final int getWidth()

Gets the width of this Rectangle structure.

Returns:

the width of this Rectangle structure.

setWidth

public final void setWidth(int value)

Sets the width of this Rectangle structure.

Parameters:

value - the width of this Rectangle structure.

getHeight

public final int getHeight()

Gets the height of this Rectangle structure.

Returns:

the height of this Rectangle structure.

setHeight

public final void setHeight(int value)

Sets the height of this Rectangle structure.

Parameters:

value - the height of this Rectangle structure.

getSize

public final Size getSize()

Gets the size of this Rectangle.

Returns:

the size of this Rectangle.

setSize

public final void setSize(Size value)

Sets the size of this Rectangle.

Parameters:

value - the size of this Rectangle.

getLeft

public final int getLeft()

Gets the x-coordinate of the left edge of this Rectangle structure.

Returns:

the x-coordinate of the left edge of this Rectangle structure.

getTop

public final int getTop()

Gets the y-coordinate of the top edge of this Rectangle structure.

Returns:

the y-coordinate of the top edge of this Rectangle structure.

getRight

public final int getRight()

Gets the x-coordinate that is the sum of X and Width property values of this Rectangle structure.

Returns:

the x-coordinate that is the sum of X and Width property values of this Rectangle structure.

getBottom

public final int getBottom()

Gets the y-coordinate that is the sum of the Y and Height property values of this Rectangle structure.

Returns:

the y-coordinate that is the sum of the Y and Height property values of this Rectangle structure.

isEmpty

public final boolean isEmpty()

Gets a value indicating whether all numeric properties of this Rectangle have values of zero.

Returns:

This property returns true if the Rectangle.Width, Rectangle.Height, Rectangle.X, and Rectangle.Y properties of this Rectangle all have values of zero; otherwise, false.

equals

public boolean equals(Object obj)

Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure.

Specified by:

equals in interface com.aspose.ms.System.IEquatable<Rectangle>

Overrides:

equals in class Object

Parameters:

obj - The Object to test.

Returns:

This method returns true if obj is a Rectangle structure and its X, Y, Width, and Height properties are equal to the corresponding properties of this Rectangle structure; otherwise, false.

hashCode

public int hashCode()

Returns the hash code for this Rectangle structure. For information about the use of hash codes, see GetHashCode .

Overrides:

hashCode in class Object

Returns:

An integer that represents the hash code for this rectangle.

toString

public String toString()

Overrides:

toString in class Object

intersect

public final void intersect(Rectangle rect)

Replaces this Rectangle with the intersection of itself and the specified Rectangle.

Parameters:

rect - The Rectangle with which to intersect.

inflate

public final void inflate(int width,
                          int height)

Enlarges this Rectangle by the specified amount.

Parameters:

width - The amount to inflate this Rectangle horizontally.

height - The amount to inflate this Rectangle vertically.

inflate

public final void inflate(Size size)

Enlarges this Rectangle by the specified amount.

Parameters:

size - The size to inflate this Rectangle.

contains

public final boolean contains(int x,
                              int y)

Determines if the specified point is contained within this Rectangle structure.

Parameters:

x - The x-coordinate of the point to test.

y - The y-coordinate of the point to test.

Returns:

This method returns true if the point defined by x and y is contained within this Rectangle structure; otherwise false.

contains

public final boolean contains(Point pt)

Determines if the specified point is contained within this Rectangle structure.

Parameters:

pt - The Point to test.

Returns:

This method returns true if the point represented by pt is contained within this Rectangle structure; otherwise false.

contains

public final boolean contains(Rectangle rect)

intersectsWith

public final boolean intersectsWith(Rectangle rect)

Determines if this rectangle intersects with rect.

Parameters:

rect - The rectangle to test.

Returns:

This method returns true if there is any intersection, otherwise false.

offset

public final void offset(int x,
                         int y)

Adjusts the location of this rectangle by the specified amount.

Parameters:

x - The horizontal offset.

y - The vertical offset.

offset

public final void offset(Point pos)

Adjusts the location of this rectangle by the specified amount.

Parameters:

pos - The offset.

equals

public final boolean equals(Rectangle other)

Tests whether other Rectangle structure has the same location and size of this Rectangle structure.

Parameters:

other - Other rectangle to test

Returns:

This method returns true if other Rectangle structure and its X, Y, Width, and Height properties are equal to the corresponding properties of this Rectangle structure; otherwise, false.

CloneTo

public void CloneTo(Rectangle that)

Specified by:

CloneTo in class com.aspose.ms.System.ValueType<Rectangle>

Clone

public Rectangle Clone()

Specified by:

Clone in class com.aspose.ms.System.ValueType<Rectangle>

clone

public Object clone()

Overrides:

clone in class Object

normalize

public void normalize()

Normalizes the rectangle by making it's width and height positive, left less than right and top less than bottom.