Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
CloseEvent

Package | mx.events
Class | public class CloseEvent
Inheritance | CloseEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The CloseEvent class represents event objects specific to popup windows, such as the Alert control.

See also

mx.controls.Alert

Public Properties

| Property | Defined By
--- | --- | ---
|  | detail : int Identifies the button in the popped up control that was clicked. | CloseEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | CloseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:int = -1) Constructor. | CloseEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CLOSE : String = close [static] The CloseEvent.CLOSE constant defines the value of the type property of the event object for a close event. | CloseEvent

Property Detail

detail | property

`public var detail:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Identifies the button in the popped up control that was clicked. This property is for controls with multiple buttons. The Alert control sets this property to one of the following constants:

- `Alert.YES`
- `Alert.NO`
- `Alert.OK`
- `Alert.CANCEL`

Constructor Detail

CloseEvent | () | Constructor

`public function CloseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:int = -1)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.
| `detail:int` (default = `-1`)`` — Value of the detail property; identifies the button in the popped up control that was clicked.

Constant Detail

CLOSE | Constant

`public static const CLOSE:String = close`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `CloseEvent.CLOSE` constant defines the value of the `type` property of the event object for a `close` 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`.
`detail` | For controls with multiple buttons, `detail` identifies the button in the popped up control that was clicked.
`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.

Wed Nov 15 2017, 09:50 AM +01:00