Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
TitleWindowBoundsEvent

Package | spark.events
Class | public class TitleWindowBoundsEvent
Inheritance | TitleWindowBoundsEvent flash.events.Event

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.

See also

spark.components.TitleWindow

Public Properties

| Property | Defined By
--- | --- | ---
|  | afterBounds : Rectangle The bounds of the object after the action. | TitleWindowBoundsEvent
|  | beforeBounds : Rectangle The bounds of the object before the action. | TitleWindowBoundsEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | TitleWindowBoundsEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeBounds:Rectangle = null, afterBounds:Rectangle = null) Constructor. | TitleWindowBoundsEvent

Public Constants

| Constant | Defined 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`beforeBounds` | The previous bounds of the object.
`afterBounds` | The current bounds of the object.
`target` | The 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`beforeBounds` | The starting bounds of the object.
`afterBounds` | The final bounds of the object.
`target` | The 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`currentTarget` | The 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`.
`beforeBounds` | The starting bounds of the object.
`afterBounds` | null
`target` | The 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`currentTarget` | The 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`.
`beforeBounds` | The current bounds of the object.
`afterBounds` | The future bounds of the object if the object moves to the current cursor position.
`target` | The 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.

Sun Mar 5 2017, 03:42 PM +11:00