flash.events

# NativeWindowBoundsEvent - AS3

Package | flash.events
Class | public class NativeWindowBoundsEvent
Inheritance | NativeWindowBoundsEvent Event Object
Subclasses | FlexNativeWindowBoundsEvent

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

A NativeWindow object dispatches a NativeWindowBoundsEvent object when the size or location of the window changes.

There are four types of events:

- `NativeWindowBoundsEvent.MOVING`
- `NativeWindowBoundsEvent.MOVE`
- `NativeWindowBoundsEvent.RESIZING`
- `NativeWindowBoundsEvent.RESIZE`

Related API Elements

flash.events.NativeWindowBoundsEvent.MOVING
flash.events.NativeWindowBoundsEvent.MOVE
flash.events.NativeWindowBoundsEvent.RESIZING
flash.events.NativeWindowBoundsEvent.RESIZE

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | afterBounds : Rectangle [read-only] The bounds of the window after the change. | NativeWindowBoundsEvent
|  | beforeBounds : Rectangle [read-only] The bounds of the window before the change. | NativeWindowBoundsEvent
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NativeWindowBoundsEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeBounds:Rectangle = null, afterBounds:Rectangle = null) Creates an Event object with specific information relevant to window bounds events. | NativeWindowBoundsEvent
|  | clone():Event [override] Creates a copy of the NativeWindowBoundsEvent object and sets the value of each property to match that of the original. | NativeWindowBoundsEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the NativeWindowBoundsEvent object. | NativeWindowBoundsEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | MOVE : String = "move" [static] Defines the value of the type property of a move event object. | NativeWindowBoundsEvent
|  | MOVING : String = "moving" [static] Defines the value of the type property of a moving event object. | NativeWindowBoundsEvent
|  | RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object. | NativeWindowBoundsEvent
|  | RESIZING : String = "resizing" [static] Defines the value of the type property of a resizing event object. | NativeWindowBoundsEvent

Property Detail

### afterBounds

property

`afterBounds:Rectangle` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

The bounds of the window after the change.

If the event is `moving` or `resizing`, the bounds have not yet changed; `afterBounds` indicates the new bounds if the event is not canceled. If the event is `move` or `resize`, `afterBounds` indicates the new bounds.

Implementation
`public function get afterBounds():Rectangle`

### beforeBounds

property

`beforeBounds:Rectangle` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

The bounds of the window before the change.

If the event is `moving` or `resizing`, the bounds have not yet changed; `beforeBounds` reflects the current bounds. If the event is `move` or `resize`, `beforeBounds` indicates the original value.

Implementation
`public function get beforeBounds():Rectangle`
Constructor Detail

### NativeWindowBoundsEvent

()
Constructor

`public function NativeWindowBoundsEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeBounds:Rectangle = null, afterBounds:Rectangle = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Creates an Event object with specific information relevant to window bounds events. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event. Possible values are:

- `NativeWindowBoundsEvent.MOVING`
- `NativeWindowBoundsEvent.MOVE`
- `NativeWindowBoundsEvent.RESIZING`
- `NativeWindowBoundsEvent.RESIZE`

| `bubbles:Boolean` (default = `false`)`` — Indicates whether the Event object participates in the bubbling stage of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Indicates whether the Event object can be canceled.
| `beforeBounds:Rectangle` (default = `null`)`` — Indicates the bounds before the most recent change or the pending change.
| `afterBounds:Rectangle` (default = `null`)`` — Indicates the bounds after the most recent change or the pending change.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Creates a copy of the NativeWindowBoundsEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new NativeWindowBoundsEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Returns a string that contains all the properties of the NativeWindowBoundsEvent object. The string has the following format:

`[NativeWindowBoundsEvent type=value bubbles=value cancelable=value previousDisplayState=value currentDisplayState=value]`

Returns

| `String` — A string that contains all the properties of the NativeWindowBoundsEvent object.

Constant Detail

### MOVE

Constant

`public static const MOVE:String = "move"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Defines the value of the `type` property of a `move` event object.

This event has the following properties:

Properties | Values
--- | ---
`afterBounds` | The new bounds of the window.
`beforeBounds` | The old bounds of the window.
`target` | The NativeWindow object that has just changed state.
`bubbles` | No.
`currentTarget` | Indicates the object that is actively processing the Event object with an event listener.
`cancelable` | `false`; There is no default behavior to cancel.

Related API Elements

flash.display.NativeWindow

### MOVING

Constant

`public static const MOVING:String = "moving"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Defines the value of the `type` property of a `moving` event object.

This event has the following properties:

Properties | Values
--- | ---
`afterBounds` | The bounds of the window after the pending change.
`beforeBounds` | The bounds of the window before the pending change.
`bubbles` | No.
`cancelable` | `true`; cancelling the event will prevent the window move.
`currentTarget` | Indicates the object that is actively processing the Event object with an event listener.
`target` | The NativeWindow object that has just changed state.

Note: On Linux, the `preventDefault()` method is not supported for this event.

Related API Elements

flash.display.NativeWindow

### RESIZE

Constant

`public static const RESIZE:String = "resize"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Defines the value of the `type` property of a `resize` event object.

This event has the following properties:

Properties | Values
--- | ---
`afterBounds` | The new bounds of the window.
`beforeBounds` | The old bounds of the window.
`target` | The NativeWindow object that has just changed state.
`bubbles` | No.
`currentTarget` | Indicates the object that is actively processing the Event object with an event listener.
`cancelable` | `false`; There is no default behavior to cancel.

Related API Elements

flash.display.NativeWindow

### RESIZING

Constant

`public static const RESIZING:String = "resizing"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Defines the value of the `type` property of a `resizing` event object.

This event has the following properties:

Properties | Values
--- | ---
`afterBounds` | The bounds of the window after the pending change.
`beforeBounds` | The bounds of the window before the pending change.
`target` | The NativeWindow object that has just changed state.
`bubbles` | No.
`currentTarget` | Indicates the object that is actively processing the Event object with an event listener.
`cancelable` | `true`; cancelling the event will prevent the window move.

Note: On Linux, the `preventDefault()` method is not supported for this event.

Related API Elements

flash.display.NativeWindow

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00