flash.geom.Rectangle

	Property	Defined By
		bottom : Number The sum of the y and height properties.	Rectangle
		bottomRight : Point The location of the Rectangle object's bottom-right corner, determined by the values of the right and bottom properties.	Rectangle
		height : Number The height of the rectangle, in pixels.	Rectangle
		left : Number The x coordinate of the top-left corner of the rectangle.	Rectangle
		right : Number The sum of the x and width properties.	Rectangle
		size : Point The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.	Rectangle
		top : Number The y coordinate of the top-left corner of the rectangle.	Rectangle
		topLeft : Point The location of the Rectangle object's top-left corner, determined by the x and y coordinates of the point.	Rectangle
		width : Number The width of the rectangle, in pixels.	Rectangle
		x : Number The x coordinate of the top-left corner of the rectangle.	Rectangle
		y : Number The y coordinate of the top-left corner of the rectangle.	Rectangle

	Method	Defined By
		Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0) Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters.	Rectangle
		clone():Rectangle Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.	Rectangle
		contains(x:Number, y:Number):Boolean Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.	Rectangle
		containsPoint(point:Point):Boolean Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.	Rectangle
		containsRect(rect:Rectangle):Boolean Determines whether the Rectangle object specified by the rect parameter is contained within this Rectangle object.	Rectangle
		equals(toCompare:Rectangle):Boolean Determines whether the object specified in the toCompare parameter is equal to this Rectangle object.	Rectangle
		inflate(dx:Number, dy:Number):void Increases the size of the Rectangle object by the specified amounts, in pixels.	Rectangle
		inflatePoint(point:Point):void Increases the size of the Rectangle object.	Rectangle
		intersection(toIntersect:Rectangle):Rectangle If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object.	Rectangle
		intersects(toIntersect:Rectangle):Boolean Determines whether the object specified in the toIntersect parameter intersects with this Rectangle object.	Rectangle
		isEmpty():Boolean Determines whether or not this Rectangle object is empty.	Rectangle
		offset(dx:Number, dy:Number):void Adjusts the location of the Rectangle object, as determined by its top-left corner, by the specified amounts.	Rectangle
		offsetPoint(point:Point):void Adjusts the location of the Rectangle object using a Point object as a parameter.	Rectangle
		setEmpty():void Sets all of the Rectangle object's properties to 0.	Rectangle
		toString():String Builds and returns a string that lists the horizontal and vertical positions and the width and height of the Rectangle object.	Rectangle
		union(toUnion:Rectangle):Rectangle Adds two rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two rectangles.	Rectangle

Property Detail

bottom

property

bottom:Number

Runtime Versions:

1.0

The sum of the y and height properties.

A rectangle image showing location and measurement properties.

See also

y
height

bottomRight

property

bottomRight:Point

Runtime Versions:

1.0

The location of the Rectangle object's bottom-right corner, determined by the values of the right and bottom properties.

A rectangle image showing location and measurement properties.

See also

Point

height

property

var height:Number

Runtime Versions:

1.0

The height of the rectangle, in pixels. Changing the height value of a Rectangle object has no effect on the x, y, and width properties.

A rectangle image showing location and measurement properties.

See also

x
y
height

left

property

left:Number

Runtime Versions:

1.0

The x coordinate of the top-left corner of the rectangle. Changing the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.

The value of the left property is equal to the value of the x property.

A rectangle image showing location and measurement properties.

See also

x
y
width
height

right

property

right:Number

Runtime Versions:

1.0

The sum of the x and width properties.

A rectangle image showing location and measurement properties.

See also

x
width

size

property

size:Point

Runtime Versions:

1.0

The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.

See also

Point

top

property

top:Number

Runtime Versions:

1.0

The y coordinate of the top-left corner of the rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties. However it does affect the height property, whereas changing the y value does not affect the height property.

The value of the top property is equal to the value of the y property.

A rectangle image showing location and measurement properties.

See also

x
y
width
height

topLeft

property

topLeft:Point

Runtime Versions:

1.0

The location of the Rectangle object's top-left corner, determined by the x and y coordinates of the point.

A rectangle image showing location and measurement properties.

See also

Point
x
y

width

property

var width:Number

Runtime Versions:

1.0

The width of the rectangle, in pixels. Changing the width value of a Rectangle object has no effect on the x, y, and height properties.

A rectangle image showing location and measurement properties.

See also

x
y
height

property

var x:Number

Runtime Versions:

1.0

The x coordinate of the top-left corner of the rectangle. Changing the value of the x property of a Rectangle object has no effect on the y, width, and height properties.

The value of the x property is equal to the value of the left property.

See also

left

property

var y:Number

Runtime Versions:

1.0

The y coordinate of the top-left corner of the rectangle. Changing the value of the y property of a Rectangle object has no effect on the x, width, and height properties.

The value of the y property is equal to the value of the top property.

See also

x
width
height
top

Constructor Detail

Rectangle

()

Constructor

function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)

Runtime Versions:

1.0

Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters. If you call this function without parameters, a rectangle with x, y, width, and height properties set to 0 is created.

Parameters

	`x:Number` (default = `0`) — The x coordinate of the top-left corner of the rectangle.

	`y:Number` (default = `0`) — The y coordinate of the top-left corner of the rectangle.

	`width:Number` (default = `0`) — The width of the rectangle, in pixels.

	`height:Number` (default = `0`) — The height of the rectangle, in pixels.

See also

x
y
width
height

Method Detail

clone

()

method

function clone():Rectangle

Runtime Versions:

1.0

Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.

Returns

Rectangle — A new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.

See also

x
y
width
height

contains

()

method

function contains(x:Number, y:Number):Boolean

Runtime Versions:

1.0

Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.

Parameters

	`x:Number` — The x coordinate (horizontal position) of the point.

	`y:Number` — The y coordinate (vertical position) of the point.

Returns

Boolean — A value of true if the Rectangle object contains the specified point; otherwise false.

See also

Point

containsPoint

()

method

function containsPoint(point:Point):Boolean

Runtime Versions:

1.0

Determines whether the specified point is contained within the rectangular region defined by this Rectangle object. This method is similar to the Rectangle.contains() method, except that it takes a Point object as a parameter.

Parameters

point:Point — The point, as represented by its x and y coordinates.

Returns

Boolean — A value of true if the Rectangle object contains the specified point; otherwise false.

See also

contains()
Point

containsRect

()

method

function containsRect(rect:Rectangle):Boolean

Runtime Versions:

1.0

Determines whether the Rectangle object specified by the rect parameter is contained within this Rectangle object. A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.

Parameters

rect:Rectangle — The Rectangle object being checked.

Returns

Boolean — A value of true if the Rectangle object that you specify is contained by this Rectangle object; otherwise false.

equals

()

method

function equals(toCompare:Rectangle):Boolean

Runtime Versions:

1.0

Determines whether the object specified in the toCompare parameter is equal to this Rectangle object. This method compares the x, y, width, and height properties of an object against the same properties of this Rectangle object.

Parameters

toCompare:Rectangle — The rectangle to compare to this Rectangle object.

Returns

Boolean — A value of true if the object has exactly the same values for the x, y, width, and height properties as this Rectangle object; otherwise false.

See also

x
y
width
height

inflate

()

method

function inflate(dx:Number, dy:Number):void

Runtime Versions:

Increases the size of the Rectangle object by the specified amounts, in pixels. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.

Parameters

	`dx:Number` — The value to be added to the left and the right of the Rectangle object. The following equation is used to calculate the new width and position of the rectangle: x -= dx; width += 2 * dx;

	`dy:Number` — The value to be added to the top and the bottom of the Rectangle. The following equation is used to calculate the new height and position of the rectangle: y -= dy; height += 2 * dy;

See also

x
y

inflatePoint

()

method

function inflatePoint(point:Point):void

Runtime Versions:

1.0

Increases the size of the Rectangle object. This method is similar to the Rectangle.inflate() method except it takes a Point object as a parameter.

The following two code examples give the same result:

  var rect1 = new air.Rectangle(0,0,2,5);
  rect1.inflate(2,2)

  var rect1 = new air.Rectangle(0,0,2,5);
  var pt1 = new air.Point(2,2);
  rect1.inflatePoint(pt1)

Parameters

point:Point — The x property of this Point object is used to increase the horizontal dimension of the Rectangle object. The y property is used to increase the vertical dimension of the Rectangle object.

See also

Point

intersection

()

method

function intersection(toIntersect:Rectangle):Rectangle

Runtime Versions:

1.0

If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.

The resulting intersection rectangle.

Parameters

toIntersect:Rectangle — The Rectangle object to compare against to see if it intersects with this Rectangle object.

Returns

Rectangle — A Rectangle object that equals the area of intersection. If the rectangles do not intersect, this method returns an empty Rectangle object; that is, a rectangle with its x, y, width, and height properties set to 0.

intersects

()

method

function intersects(toIntersect:Rectangle):Boolean

Runtime Versions:

1.0

Determines whether the object specified in the toIntersect parameter intersects with this Rectangle object. This method checks the x, y, width, and height properties of the specified Rectangle object to see if it intersects with this Rectangle object.

Parameters

toIntersect:Rectangle — The Rectangle object to compare against this Rectangle object.

Returns

Boolean — A value of true if the specified object intersects with this Rectangle object; otherwise false.

See also

x
y
width
height

isEmpty

()

method

function isEmpty():Boolean

Runtime Versions:

1.0

Determines whether or not this Rectangle object is empty.

Returns

Boolean — A value of true if the Rectangle object's width or height is less than or equal to 0; otherwise false.

offset

()

method

function offset(dx:Number, dy:Number):void

Runtime Versions:

1.0

Adjusts the location of the Rectangle object, as determined by its top-left corner, by the specified amounts.

Parameters

	`dx:Number` — Moves the x value of the Rectangle object by this amount.

	`dy:Number` — Moves the y value of the Rectangle object by this amount.

offsetPoint

()

method

function offsetPoint(point:Point):void

Runtime Versions:

1.0

Adjusts the location of the Rectangle object using a Point object as a parameter. This method is similar to the Rectangle.offset() method, except that it takes a Point object as a parameter.

Parameters

point:Point — A Point object to use to offset this Rectangle object.

See also

Point

setEmpty

()

method

function setEmpty():void

Runtime Versions:

1.0

Sets all of the Rectangle object's properties to 0. A Rectangle object is empty if its width or height is less than or equal to 0.

This method sets the values of the x, y, width, and height properties to 0.

See also

x
y
width
height

toString

()

method

function toString():String

Runtime Versions:

1.0

Builds and returns a string that lists the horizontal and vertical positions and the width and height of the Rectangle object.

Returns

String — A string listing the value of each of the following properties of the Rectangle object: x, y, width, and height.

See also

x
y
width
height

union

()

method

function union(toUnion:Rectangle):Rectangle

Runtime Versions:

1.0

Adds two rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two rectangles.

The resulting union rectangle.

Note: The union() method ignores rectangles with 0 as the height or width value, such as: var rect2:Rectangle = new Rectangle(300,300,50,0);

Parameters

toUnion:Rectangle — A Rectangle object to add to this Rectangle object.

Returns

Rectangle — A new Rectangle object that is the union of the two rectangles.

Adobe AIR Language Reference for HTML Developers This Help system only	Index \| Frames No Frames
Rectangle

window.runtime property	window.runtime.flash.geom.Rectangle