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

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The PopUpEvent class represents an event dispatched by the SkinnablePopUpContainer.

Public Properties

| Property | Defined By
--- | --- | ---
|  | commit : Boolean Specifies whether the event listener should commit the data returned in the data property. | PopUpEvent
|  | data : * The data to commit. | PopUpEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | PopUpEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, commit:Boolean = false, data:*) Constructor. | PopUpEvent

Public Constants

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

Property Detail

commit | property

`public var commit:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

Specifies whether the event listener should commit the data returned in the `data` property. Only used with `PopUpEvent.CLOSE` event.

data | property |

`public var data:*`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The data to commit. Only used with `PopUpEvent.CLOSE` event.

Constructor Detail

PopUpEvent | () | Constructor

`public function PopUpEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, commit:Boolean = false, data:*)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.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.
| `commit:Boolean` (default = `false`)`` — Specifies whether the listener should commit the data from the SkinnablePopUpContainer. Only used with the `PopUpEvent.CLOSE` event.
| `data:*` (default = `NaN`)`` — The data to commit. Only used with the `PopUpEvent.CLOSE` event.

Constant Detail

CLOSE | Constant

`public static const CLOSE:String = close`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The PopUpEvent.CLOSE constant defines the value of the `type` property of the PopUpEvent object for an `close` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`commit` | Specifies whether the listener should commit the data.
`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`.
`Data` | Any data returned to the application from the SkinnablePopUpContainer.
`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.
`Type` | PopUpEvent.OPEN

OPEN | Constant |

`public static const OPEN:String = open`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The PopUpEvent.OPEN constant defines the value of the `type` property of the PopUpEvent object for an `open` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`commit` | Not used
`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`.
`Data` | Not used
`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.
`Type` | PopUpEvent.OPEN

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