Packageat.events
Classpublic class OverlayEvent
InheritanceOverlayEvent Inheritance flash.events.Event
ImplementsIOverlayEvent

Events that allow for loading of content in a pop up window via the OverlayModule.

See also

at.modules.OverlayModule


Public Properties
 PropertyDefined by
  fadeInDuration : uint
The amoutn of time it takes for the PopUp window to fade into view.
OverlayEvent
  filename : String
Path and filename for the requested file.
OverlayEvent
  titleWindowStyleName : String
Name of the styleName for the PopUp window.
OverlayEvent
  uniqueID : String
OverlayEvent
  windowTitle : String
String title for displayed name on the PopUp window.
OverlayEvent
Public Methods
 MethodDefined by
  
OverlayEvent(type:String, filename:String = null, windowTitle:String = null, fadeInDuration:uint = 500, titleWindowStyleName:String = null, bubbles:Boolean = true, cancelable:Boolean = false, uniqueID:String = "")
Constructor.
OverlayEvent
  
clone():Event
OverlayEvent
  
OverlayEvent
  
OverlayEvent
  
toString():String
OverlayEvent
Public Constants
 ConstantDefined by
  OVERLAY_CLOSED : String = "overlayClosed"
[static] The OverlayEvent.OVERLAY_CLOSED constant defines the value of the type property of the event object for a overlayClosed event.
OverlayEvent
  OVERLAY_ERROR : String = "overlayError"
[static] The OverlayEvent.OVERLAY_ERROR constant defines the value of the type property of the event object for a overlayError event.
OverlayEvent
  OVERLAY_LOADED : String = "overlayLoaded"
[static] The OverlayEvent.OVERLAY_LOADED constant defines the value of the type property of the event object for a overlayLoaded event.
OverlayEvent
  OVERLAY_REQUEST : String = "overlayRequest"
[static] The OverlayEvent.OVERLAY_REQUEST constant defines the value of the type property of the event object for a overlayRequest event.
OverlayEvent
Property detail
fadeInDurationproperty
public var fadeInDuration:uint

The amoutn of time it takes for the PopUp window to fade into view. Value is in milliseconds.

The default value is 500.

filenameproperty 
public var filename:String

Path and filename for the requested file.

The default value is null.

titleWindowStyleNameproperty 
public var titleWindowStyleName:String

Name of the styleName for the PopUp window.

The default value is null.

uniqueIDproperty 
public var uniqueID:String

windowTitleproperty 
public var windowTitle:String

String title for displayed name on the PopUp window.

The default value is null.

Constructor detail
OverlayEvent()constructor
public function OverlayEvent(type:String, filename:String = null, windowTitle:String = null, fadeInDuration:uint = 500, titleWindowStyleName:String = null, bubbles:Boolean = true, cancelable:Boolean = false, uniqueID:String = "")

Constructor.

Parameters
type:String
 
filename:String (default = null)
 
windowTitle:String (default = null)
 
fadeInDuration:uint (default = 500)
 
titleWindowStyleName:String (default = null)
 
bubbles:Boolean (default = true)
 
cancelable:Boolean (default = false)
 
uniqueID:String (default = "")
Method detail
clone()method
public override function clone():Event

Returns
Event
getOverlayClosedEvent()method 
public function getOverlayClosedEvent():String

Returns
String
getOverlayLoadedEvent()method 
public function getOverlayLoadedEvent():String

Returns
String
toString()method 
public override function toString():String

Returns
String
Constant detail
OVERLAY_CLOSEDconstant
public static const OVERLAY_CLOSED:String = "overlayClosed"

The OverlayEvent.OVERLAY_CLOSED constant defines the value of the type property of the event object for a overlayClosed event.

OVERLAY_ERRORconstant 
public static const OVERLAY_ERROR:String = "overlayError"

The OverlayEvent.OVERLAY_ERROR constant defines the value of the type property of the event object for a overlayError event.

OVERLAY_LOADEDconstant 
public static const OVERLAY_LOADED:String = "overlayLoaded"

The OverlayEvent.OVERLAY_LOADED constant defines the value of the type property of the event object for a overlayLoaded event.

OVERLAY_REQUESTconstant 
public static const OVERLAY_REQUEST:String = "overlayRequest"

The OverlayEvent.OVERLAY_REQUEST constant defines the value of the type property of the event object for a overlayRequest event.