ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

NativeWindowBoundsEvent  - AS3

Packageflash.events
Classpublic class NativeWindowBoundsEvent
InheritanceNativeWindowBoundsEvent Inheritance Event Inheritance 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



Public Properties
 PropertyDefined 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
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
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
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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:

PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.

Related API Elements

    

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:

PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
bubblesNo.
cancelabletrue; cancelling the event will prevent the window move.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
targetThe NativeWindow object that has just changed state.

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

Related API Elements

    

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:

PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.

Related API Elements

    

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:

PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
targetThe NativeWindow object that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelabletrue; cancelling the event will prevent the window move.

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

Related API Elements