Adobe® AIR® API Reference for HTML Developers
Home  |  Show Classes List |  Index  |  Appendixes

Language Reference only       
Rectangle 
3D:
Context3D
Context3DBlendFactor
Context3DClearMask
Context3DCompareMode
Context3DProgramType
Context3DRenderMode
Context3DStencilAction
Context3DTextureFormat
Context3DTriangleFace
Context3DVertexBufferFormat
CubeTexture
IndexBuffer3D
Program3D
Stage3D
Texture
VertexBuffer3D
Air.net:
ServiceMonitor
SocketMonitor
URLMonitor
Air.update:
ApplicationUpdater
ApplicationUpdaterUI
DownloadErrorEvent
StatusFileUpdateErrorEvent
StatusFileUpdateEvent
StatusUpdateErrorEvent
StatusUpdateEvent
UpdateEvent
Data:
EncryptedLocalStore
SQLCollationType
SQLColumnNameStyle
SQLColumnSchema
SQLConnection
SQLError
SQLErrorEvent
SQLErrorOperation
SQLEvent
SQLIndexSchema
SQLMode
SQLResult
SQLSchema
SQLSchemaResult
SQLStatement
SQLTableSchema
SQLTransactionLockType
SQLTriggerSchema
SQLUpdateEvent
SQLViewSchema
Desktop:
Clipboard
ClipboardFormats
ClipboardTransferMode
DockIcon
Icon
InteractiveIcon
NativeApplication
NativeProcess
NativeProcessStartupInfo
NotificationType
SystemTrayIcon
Display:
BitmapData
NativeMenu
NativeMenuItem
Screen
Stage
StageDisplayState
StageQuality
Events:
ActivityEvent
AsyncErrorEvent
BrowserInvokeEvent
DataEvent
DatagramSocketDataEvent
DNSResolverEvent
DRMAuthenticateEvent
DRMStatusEvent
ErrorEvent
Event
EventDispatcher
FileListEvent
HTTPStatusEvent
InvokeEvent
InvokeEventReason
IOErrorEvent
LocationChangeEvent
MouseEvent
NativeProcessExitEvent
NetDataEvent
NetMonitorEvent
NetStatusEvent
OutputProgressEvent
ProgressEvent
SampleDataEvent
SecurityErrorEvent
ServerSocketConnectEvent
StatusEvent
StorageVolumeChangeEvent
TimerEvent
UncaughtErrorEvent
UncaughtErrorEvents
File:
File
FileMode
FileStream
StorageVolume
StorageVolumeInfo
Functions:
trace()
generateRandomBytes()
navigateToURL()
sendToURL()
Geom:
Matrix
Point
Rectangle
Media:
AudioDecoder
AudioPlaybackMode
H264Level
H264Profile
H264VideoStreamSettings
ID3Info
InputMediaStream
Microphone
MicrophoneEnhancedMode
MicrophoneEnhancedOptions
Sound
SoundChannel
SoundCodec
SoundLoaderContext
SoundMixer
SoundTransform
VideoCodec
VideoStatus
VideoStreamSettings
Native window:
NativeWindow
NativeWindowBoundsEvent
NativeWindowDisplayState
NativeWindowDisplayStateEvent
NativeWindowInitOptions
NativeWindowRenderMode
NativeWindowResize
NativeWindowSystemChrome
NativeWindowType
Net:
AAAARecord
ARecord
CertificateStatus
DatagramSocket
DNSResolver
FileFilter
InterfaceAddress
IPVersion
LocalConnection
MXRecord
NetConnection
NetMonitor
NetStreamAppendBytesAction
NetStreamMulticastInfo
NetworkInfo
NetworkInterface
ObjectEncoding
PTRRecord
ResourceRecord
Responder
SecureSocket
ServerSocket
SharedObject
SharedObjectFlushStatus
Socket
SRVRecord
URLLoader
URLLoaderDataFormat
URLRequest
URLRequestDefaults
URLRequestHeader
URLRequestMethod
URLStream
URLVariables
XMLSocket
Security:
ReferencesValidationSetting
RevocationCheckSettings
SignatureStatus
SignerTrustSettings
X500DistinguishedName
X509Certificate
XMLSignatureValidator
System:
Capabilities
Security
System
Updater
Ui:
Keyboard
KeyboardType
KeyLocation
Mouse
MouseCursorData
Utils:
Vector
ByteArray
Collator
CollatorMode
CompressionAlgorithm
CurrencyFormatter
CurrencyParseResult
DateTimeFormatter
DateTimeNameContext
DateTimeNameStyle
DateTimeStyle
Endian
HTMLLoader
HTMLPDFCapability
LastOperationStatus
LocaleID
NationalDigitsType
NumberFormatter
NumberParseResult
StringTools
Timer
window.runtime propertywindow.runtime.flash.geom.Rectangle
InheritanceRectangle Inheritance Object

Runtime Versions: AIR 1.0,

A Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height.

The x, y, width, and height properties of the Rectangle class are independent of each other; changing the value of one property has no effect on the others. However, the right and bottom properties are integrally related to those four properties. For example, if you change the value of the right property, the value of the width property changes; if you change the bottom property, the value of the height property changes.

You can use the new Rectangle() constructor to create a Rectangle object.

View the examples

See also



Properties
 PropertyDefined 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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  height : Number
The height of the rectangle, in pixels.
Rectangle
  left : Number
The x coordinate of the top-left corner of the rectangle.
Rectangle
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  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
Public Methods
 MethodDefined 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
  
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
  
copyFrom(sourceRect:Rectangle):void
Copies all of rectangle data from the source Rectangle object into the calling Rectangle object.
Rectangle
  
equals(toCompare:Rectangle):Boolean
Determines whether the object specified in the toCompare parameter is equal to this Rectangle object.
Rectangle
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
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
  
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
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
setEmpty():void
Sets all of the Rectangle object's properties to 0.
Rectangle
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void
Sets the members of Rectangle to the specified values
Rectangle
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString():String
Builds and returns a string that lists the horizontal and vertical positions and the width and height of the Rectangle object.
Rectangle
  
Adds two rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two rectangles.
Rectangle
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

bottom

property
bottom:Number

Runtime Versions: AIR 1.0,

The sum of the y and height properties.

A rectangle image showing location and measurement properties.

See also

bottomRight

property 
bottomRight:Point

Runtime Versions: AIR 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

height

property 
public var height:Number

Runtime Versions: AIR 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

left

property 
left:Number

Runtime Versions: AIR 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

right

property 
right:Number

Runtime Versions: AIR 1.0,

The sum of the x and width properties.

A rectangle image showing location and measurement properties.

See also

size

property 
size:Point

Runtime Versions: AIR 1.0,

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

See also

top

property 
top:Number

Runtime Versions: AIR 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

topLeft

property 
topLeft:Point

Runtime Versions: AIR 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

width

property 
public var width:Number

Runtime Versions: AIR 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

property 
public var x:Number

Runtime Versions: AIR 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

y

property 
public var y:Number

Runtime Versions: AIR 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

Constructor Detail

Rectangle

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

Runtime Versions: AIR 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

Method Detail

clone

()method
public function clone():Rectangle

Runtime Versions: AIR 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

contains

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

Runtime Versions: AIR 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

containsPoint

()method 
public function containsPoint(point:Point):Boolean

Runtime Versions: AIR 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

containsRect

()method 
public function containsRect(rect:Rectangle):Boolean

Runtime Versions: AIR 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.

copyFrom

()method 
public function copyFrom(sourceRect:Rectangle):void

Runtime Versions:  3.0

Copies all of rectangle data from the source Rectangle object into the calling Rectangle object.

Parameters

sourceRect:Rectangle — The Rectangle object from which to copy the data.

equals

()method 
public function equals(toCompare:Rectangle):Boolean

Runtime Versions: AIR 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

inflate

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

Runtime Versions: AIR 1.0,

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

inflatePoint

()method 
public function inflatePoint(point:Point):void

Runtime Versions: AIR 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

intersection

()method 
public function intersection(toIntersect:Rectangle):Rectangle

Runtime Versions: AIR 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 
public function intersects(toIntersect:Rectangle):Boolean

Runtime Versions: AIR 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

isEmpty

()method 
public function isEmpty():Boolean

Runtime Versions: AIR 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 
public function offset(dx:Number, dy:Number):void

Runtime Versions: AIR 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 
public function offsetPoint(point:Point):void

Runtime Versions: AIR 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

setEmpty

()method 
public function setEmpty():void

Runtime Versions: AIR 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

setTo

()method 
public function setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void

Runtime Versions:  3.0

Sets the members of Rectangle to the specified values

Parameters

xa:Number — the values to set the rectangle to.
 
ya:Number
 
widtha:Number
 
heighta:Number

toString

()method 
public function toString():String

Runtime Versions: AIR 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

union

()method 
public function union(toUnion:Rectangle):Rectangle

Runtime Versions: AIR 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.
Examples

The following example uses the RectangleExample class to create three new Rectangle objects at various x,y coordinates and with various heights and widths and then uses the trace() method to confirm that the Rectangle instances were successfully created. Then a Boolean variable isContained is assigned to the result of the call to the containsRect() method, which determines that the second rectangle does not fully enclose the third rectangle.

Note: To test this example:

  1. Add the AIRAliases.js file to the project directory.
  2. Create an application descriptor file for the project, and test the project using ADL.
<html>
    <head>
      <script src="AIRAliases.js" />
      <script>
        function init() {
            var firstRect = new air.Rectangle();
            air.trace(firstRect);  // (x=0, y=0, w=0, h=0)
            var secondRect = new air.Rectangle(1, 3, 11, 13);
            air.trace(secondRect); // (x=1, y=3, w=11, h=13)
            var thirdRect = new air.Rectangle(5, 8, 17, 19);
            air.trace(thirdRect);  // (x=5, y=8, w=17, h=19)
            var isContained = secondRect.containsRect(thirdRect);
            air.trace(isContained); // false
        }
      </script>
    </head>
    <body onload='init()'>
    </body>
</html>