Packageat.modules
Classpublic class OverlayModule
ImplementsIOverlayModule

Handles the loading and display of different types of PopUp windows.

The OverlayModule is now a static class.

All dispatched OverlayEvent of the type OVERLAY_REQUEST and OVERLAY_VIDEO_REQUEST will be handled by the EveWindowed component.



Public Properties
 PropertyDefined by
  closeOnModalClick : Boolean = true
[static] If set to true and the modal area is clicked, the overlay will close.
OverlayModule
  container : DisplayObject
[static][read-only] The DisplayObject to which the OverlayWindows are loaded.
OverlayModule
  currentTitle : String = ""
[static] Holder for the title of the PopUp window.
OverlayModule
  debugMode : Boolean = false
[static] Outputs useful information for debugging this component for developers when true.
OverlayModule
  overlayContainer : UIComponent
[static]
OverlayModule
  showModal : Boolean = true
[static] Determines if the the background behind the window blurs and absorbs clicks (true) or not (false).
OverlayModule
  uniqueID : String
[static][read-only] Read-Only.
OverlayModule
Protected Properties
 PropertyDefined by
  disp : EventDispatcher
The event dispatcher for the class.
OverlayModule
Public Methods
 MethodDefined by
  
OverlayModule(caller:Function = null)
OverlayModule
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static]
OverlayModule
  
centerPopUpWindow(e:Event):void
[static] This handles the centering of the OverlayWindow once the final sizes of the loaded content have been determined.
OverlayModule
  
closeWindow(e:CloseEvent = null):void
[static] Handles the window CloseEvent to destroy the PopUp.
OverlayModule
  
createOverlay(filename:String, fadeDuration:uint = 500, windowTitle:String = "", windowStyleName:String = null, uniqueID:String = ""):void
[static] Creates a PopUp window and displays a specified file (swfs or other graphics).
OverlayModule
  
createPopUpWindow(fadeDuration:uint = 500, windowTitle:String = "", uniqueID:String = ""):OverlayWindow
[static] Creates an empty PopUpWindow of the type OverlayWindow to add anything to after its popped up, such as custom components.
OverlayModule
  
destroy():void
[static] This method removes event listeners, unloads SWFLoaders, removes the PopUp from the stage, and resets the OverlayModule for the next PopUp.
OverlayModule
  
dispatchEvent(event:Event):void
[static]
OverlayModule
  
[static]
OverlayModule
  
[static] The loadOverlay method takes an OverlayEvent and passes it to the appropriate handler, based on its type.
OverlayModule
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[static]
OverlayModule
  
showPopUpWindow(visualClass:Class, fadeDuration:uint = 500, windowTitle:String = "", uniqueID:String = ""):OverlayWindow
[static] Creates a PopUpWindow of the type OverlayWindow and automatically adds visual elements to it via the visualClass parameter.
OverlayModule
Protected Methods
 MethodDefined by
  
[static] This method, through the event passed in, loads an item into a newly created SWFLoader to be displayed in an OverlayWindow.
OverlayModule
  
modalClick(e:MouseEvent):void
[static] Handles the clicking of the modal area and closes the PopUp.
OverlayModule
Events
 EventSummaryDefined by
   Dispatched with the PopUp window is closed.OverlayModule
   Dispatched when the PopUp window is fully loaded and centered.OverlayModule
Property detail
closeOnModalClickproperty
public static var closeOnModalClick:Boolean = true

If set to true and the modal area is clicked, the overlay will close. If false, clicking the modal area has no effect.

containerproperty 
container:DisplayObject  [read-only]

The DisplayObject to which the OverlayWindows are loaded.

Implementation
    public static 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 static function get currentTitle():String
    public function set currentTitle(value:String):void
debugModeproperty 
public static var debugMode:Boolean = false

Outputs useful information for debugging this component for developers when true.

The output is typically in the form of trace statements and Alerts.

The default value is false.

dispproperty 
protected var disp:EventDispatcher

The event dispatcher for the class.

See also

flash.events.EventDispatcher
overlayContainerproperty 
overlayContainer:UIComponent  [read-write]

Implementation
    public static function get overlayContainer():UIComponent
    public function set overlayContainer(value:UIComponent):void
showModalproperty 
public static var showModal:Boolean = true

Determines if the the background behind the window blurs and absorbs clicks (true) or not (false).

The default value is true.

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 static function get uniqueID():String
Constructor detail
OverlayModule()constructor
public function OverlayModule(caller:Function = null)Parameters
caller:Function (default = null)
Method detail
addEventListener()method
public static function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Parameters
type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)

See also

flash.events.EventDispatcher
centerPopUpWindow()method 
public static function centerPopUpWindow(e: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
e:Event
closeWindow()method 
public static function closeWindow(e:CloseEvent = null):void

Handles the window CloseEvent to destroy the PopUp.

Parameters
e:CloseEvent (default = null) — Event for the closing of the PopUp
createOverlay()method 
public static function createOverlay(filename:String, fadeDuration:uint = 500, windowTitle:String = "", windowStyleName:String = null, uniqueID:String = ""):void

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

Parameters
filename:String — The name of the file to be popped-up
 
fadeDuration:uint (default = 500) — The path to the file, with or without trailing slash
 
windowTitle:String (default = "") — The amount of time it takes for the window to fade in; in milliseconds
 
windowStyleName:String (default = null) — The displayed text title of the window being popped-up
 
uniqueID:String (default = "") — The styleName of the window
createPopUpWindow()method 
public static function createPopUpWindow(fadeDuration:uint = 500, windowTitle:String = "", uniqueID:String = ""):OverlayWindow

Creates an empty PopUpWindow of the type OverlayWindow to add anything to after its popped up, such as custom components.

Parameters
fadeDuration:uint (default = 500)
 
windowTitle:String (default = "")
 
uniqueID:String (default = "")

Returns
OverlayWindow

See also

destroy()method 
public static 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 static function dispatchEvent(event:Event):voidParameters
event:Event
getInstance()method 
public static function getInstance():OverlayModule

Returns
OverlayModule
loadFromOverlayRequest()method 
protected static function loadFromOverlayRequest(e:OverlayEvent):void

This method, through the event passed in, loads an item into a newly created SWFLoader to be displayed in an OverlayWindow.

Parameters
e:OverlayEvent — Event for a file overlay PopUp
loadOverlay()method 
public static function loadOverlay(e:OverlayEvent):void

The loadOverlay method takes an OverlayEvent and passes it to the appropriate handler, based on its type.

Parameters
e:OverlayEvent
modalClick()method 
protected static function modalClick(e:MouseEvent):void

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

Parameters
e:MouseEvent — Event for the click
removeEventListener()method 
public static function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters
type:String
 
listener:Function
 
useCapture:Boolean (default = false)

See also

flash.events.EventDispatcher
showPopUpWindow()method 
public static function showPopUpWindow(visualClass:Class, fadeDuration:uint = 500, windowTitle:String = "", uniqueID:String = ""):OverlayWindow

Creates a PopUpWindow of the type OverlayWindow and automatically adds visual elements to it via the visualClass parameter. If your visual elements contain a label property, that label will be applied to you pop up window title.

Parameters
visualClass:Class — Any class reference that extends from UIComponent.
 
fadeDuration:uint (default = 500) — Length in miliseconds that the pop up will fade in and out
 
windowTitle:String (default = "") — The title of the popup window. If your visual elements contain a label property, that label will be applied to you pop up window title.
 
uniqueID:String (default = "") — Used for eVE Data Collections when tracking individual OverlayWindow

Returns
OverlayWindow — at.containers.OverlayWindow

See also

Event detail
overlayClosedevent 
Event object type: at.events.OverlayEvent

Dispatched with the PopUp window is closed.

overlayLoadedevent  
Event object type: at.events.OverlayEvent

Dispatched when the PopUp window is fully loaded and centered.