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

TitleWindowBoundsEvent  - AS3 Flex

Packagespark.events
Classpublic class TitleWindowBoundsEvent
InheritanceTitleWindowBoundsEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The TitleWindowBoundsEvent class represents event objects that are dispatched when bounds of a Spark TitleWindow changes, either by moving or resizing.

More examples

Learn more

Related API Elements



Public Properties
 PropertyDefined By
  afterBounds : Rectangle
The bounds of the object after the action.
TitleWindowBoundsEvent
  beforeBounds : Rectangle
The bounds of the object before the action.
TitleWindowBoundsEvent
 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
  
TitleWindowBoundsEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeBounds:Rectangle = null, afterBounds:Rectangle = null)
Constructor.
TitleWindowBoundsEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 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
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  WINDOW_MOVE : String = "windowMove"
[static] The TitleWindowBoundsEvent.WINDOW_MOVE constant defines the value of the type property of the event object for a windowMove event.
TitleWindowBoundsEvent
  WINDOW_MOVE_END : String = "windowMoveEnd"
[static] The TitleWindowBoundsEvent.WINDOW_MOVE_END constant defines the value of the type property of the event object for a windowMoveEnd event.
TitleWindowBoundsEvent
  WINDOW_MOVE_START : String = "windowMoveStart"
[static] The TitleWindowBoundsEvent.WINDOW_MOVE_START constant defines the value of the type property of the event object for a windowMoveStart event.
TitleWindowBoundsEvent
  WINDOW_MOVING : String = "windowMoving"
[static] The TitleWindowBoundsEvent.WINDOW_MOVING constant defines the value of the type property of the event object for a windowMoving event.
TitleWindowBoundsEvent
Property Detail

afterBounds

property
public var afterBounds:Rectangle

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The bounds of the object after the action. If this event is cancelable, afterBounds is the future bounds of the window. Otherwise, it is the current bounds.

The following list shows how this property is set for the different event types:

  • WINDOW_MOVE - The current bounds of the window.
  • WINDOW_MOVE_END - The final bounds of the window, before the drag.
  • WINDOW_MOVE_START - null.
  • WINDOW_MOVING - The future bounds of the window if the window moves to the current cursor position.

beforeBounds

property 
public var beforeBounds:Rectangle

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The bounds of the object before the action. If this event is cancelable, beforeBounds is the current bounds of the window. Otherwise, it is the bounds before a change occurred.

The following list shows how this property is set for the different event types:

  • WINDOW_MOVE - The previous bounds of the window.
  • WINDOW_MOVE_END - The starting bounds of the window, before the drag.
  • WINDOW_MOVE_START - The starting bounds of the window.
  • WINDOW_MOVING - The current bounds of the window.
Constructor Detail

TitleWindowBoundsEvent

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
beforeBounds:Rectangle (default = null) — The bounds of the window before the action. If this event is cancelable, beforeBounds is the current bounds of the window. Otherwise, it is the bounds before a change occurred.
 
afterBounds:Rectangle (default = null) — The bounds of the window after the action. If this event is cancelable, afterBounds is the future bounds of the window. Otherwise, it is the current bounds.
Constant Detail

WINDOW_MOVE

Constant
public static const WINDOW_MOVE:String = "windowMove"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The TitleWindowBoundsEvent.WINDOW_MOVE constant defines the value of the type property of the event object for a windowMove event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
beforeBoundsThe previous bounds of the object.
afterBoundsThe current bounds of the object.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

WINDOW_MOVE_END

Constant 
public static const WINDOW_MOVE_END:String = "windowMoveEnd"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The TitleWindowBoundsEvent.WINDOW_MOVE_END constant defines the value of the type property of the event object for a windowMoveEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
beforeBoundsThe starting bounds of the object.
afterBoundsThe final bounds of the object.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

WINDOW_MOVE_START

Constant 
public static const WINDOW_MOVE_START:String = "windowMoveStart"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The TitleWindowBoundsEvent.WINDOW_MOVE_START constant defines the value of the type property of the event object for a windowMoveStart event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
beforeBoundsThe starting bounds of the object.
afterBoundsnull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

WINDOW_MOVING

Constant 
public static const WINDOW_MOVING:String = "windowMoving"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The TitleWindowBoundsEvent.WINDOW_MOVING constant defines the value of the type property of the event object for a windowMoving event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
beforeBoundsThe current bounds of the object.
afterBoundsThe future bounds of the object if the object moves to the current cursor position.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.