Packageat.modules
Interfacepublic interface IOverlayModule
ImplementorsOverlayModule



Public Properties
 PropertyDefined by
  container : DisplayObject
[read-only] The DisplayObject to which the OverlayWindows are loaded.
IOverlayModule
  currentTitle : String
Holder for the title of the PopUp window.
IOverlayModule
  filepath : String
If the overlay contains an externally loaded asset (swf or video) you can obtain the filename from this accessor.
IOverlayModule
  overlayContainer : UIComponent
An accessor to the current overlay's container component.
IOverlayModule
  uniqueID : String
[read-only] Read-Only.
IOverlayModule
Public Methods
 MethodDefined by
  
addEventListener(arg1:String, arg2:Function, arg3:Boolean = false, arg4:int = 0, arg5:Boolean = false):void
Adds an event listener.
IOverlayModule
  
centerPopUpWindow(arg1:Event):void
This handles the centering of the OverlayWindow once the final sizes of the loaded content have been determined.
IOverlayModule
  
closeWindow(arg1:CloseEvent = null):void
Handles the window CloseEvent to destroy the PopUp.
IOverlayModule
  
createOverlay(arg1:String, arg2:uint = 0, arg3:String = null, arg4:String = null, arg5:String = null):void
Creates a PopUp window and displays a specified file (swfs or other graphics).
IOverlayModule
  
destroy():void
This method removes event listeners, unloads SWFLoaders, removes the PopUp from the stage, and resets the OverlayModule for the next PopUp.
IOverlayModule
  
dispatchEvent(arg1:Event):void
Dispatches an event.
IOverlayModule
  
getInstance():Object
Returns an instance of the Overlay Module.
IOverlayModule
  
modalClick(arg1:MouseEvent):void
Handles the clicking of the modal area and closes the PopUp.
IOverlayModule
  
removeEventListener(arg1:String, arg2:Function, arg3:Boolean = false):void
Removes an event listener.
IOverlayModule
Property detail
containerproperty
container:DisplayObject  [read-only]

The DisplayObject to which the OverlayWindows are loaded.

Implementation
    public function get container():DisplayObject
currentTitleproperty 
currentTitle:String  [read-write]

Holder for the title of the PopUp window. Stored in a variable until the window is loaded and centered. The Flash Player still shows the title despite the opacity of the OverlayWindow due to a bug in the player.

The default value is "".

Implementation
    public function get currentTitle():String
    public function set currentTitle(value:String):void
filepathproperty 
filepath:String  [read-write]

If the overlay contains an externally loaded asset (swf or video) you can obtain the filename from this accessor.

Implementation
    public function get filepath():String
    public function set filepath(value:String):void
overlayContainerproperty 
overlayContainer:UIComponent  [read-write]

An accessor to the current overlay's container component.

Implementation
    public function get overlayContainer():UIComponent
    public function set overlayContainer(value:UIComponent):void
uniqueIDproperty 
uniqueID:String  [read-only]

Read-Only. An optional unique identifier for the content of the overlay. It is set interally by the OverlayModule and is obtained by the uniqueID parameter supplied by eVE implementation developers when opening an overlay.

Implementation
    public function get uniqueID():String
Method detail
addEventListener()method
public function addEventListener(arg1:String, arg2:Function, arg3:Boolean = false, arg4:int = 0, arg5:Boolean = false):void

Adds an event listener.

Parameters
arg1:String
 
arg2:Function
 
arg3:Boolean (default = false)
 
arg4:int (default = 0)
 
arg5:Boolean (default = false)

See also

flash.events.EventDispatcher
centerPopUpWindow()method 
public function centerPopUpWindow(arg1:Event):void

This handles the centering of the OverlayWindow once the final sizes of the loaded content have been determined. This is where the fadeInTransitionTime applies, as it will fade in the window according to that time.

Parameters
arg1:Event
closeWindow()method 
public function closeWindow(arg1:CloseEvent = null):void

Handles the window CloseEvent to destroy the PopUp.

Parameters
arg1:CloseEvent (default = null) — Event for the closing of the PopUp
createOverlay()method 
public function createOverlay(arg1:String, arg2:uint = 0, arg3:String = null, arg4:String = null, arg5:String = null):void

Creates a PopUp window and displays a specified file (swfs or other graphics).

Parameters
arg1:String — The name of the file to be popped-up
 
arg2:uint (default = 0) — The path to the file, with or without trailing slash
 
arg3:String (default = null) — The amount of time it takes for the window to fade in; in milliseconds
 
arg4:String (default = null) — The displayed text title of the window being popped-up
 
arg5:String (default = null) — The styleName of the window
destroy()method 
public function destroy():void

This method removes event listeners, unloads SWFLoaders, removes the PopUp from the stage, and resets the OverlayModule for the next PopUp.

dispatchEvent()method 
public function dispatchEvent(arg1:Event):void

Dispatches an event.

Parameters
arg1:Event

See also

flash.events.EventDispatcher
getInstance()method 
public function getInstance():Object

Returns an instance of the Overlay Module.

Returns
Object
modalClick()method 
public function modalClick(arg1:MouseEvent):void

Handles the clicking of the modal area and closes the PopUp.

Parameters
arg1:MouseEvent — Event for the click
removeEventListener()method 
public function removeEventListener(arg1:String, arg2:Function, arg3:Boolean = false):void

Removes an event listener.

Parameters
arg1:String
 
arg2:Function
 
arg3:Boolean (default = false)

See also

flash.events.EventDispatcher