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

PopUpEvent  - AS3 Flex
Packagespark.events
Classpublic class PopUpEvent
InheritancePopUpEvent Inheritance Event Inheritance Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Public Properties
 PropertyDefined By
 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
  commit : Boolean
Specifies whether the event listener should commit the data returned in the data property.
PopUpEvent
 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
  data : *
The data to commit.
PopUpEvent
 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
  
PopUpEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, commit:Boolean = false, data:*)
Constructor.
PopUpEvent
 Inherited
clone():Event
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
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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:

PropertyValue
bubblesfalse
cancelablefalse
commitSpecifies whether the listener should commit the data.
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.
DataAny data returned to the application from the SkinnablePopUpContainer.
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.
TypePopUpEvent.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:

PropertyValue
bubblesfalse
cancelablefalse
commitNot used
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.
DataNot used
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.
TypePopUpEvent.OPEN



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy