Packageat.display
Interfacepublic interface IEveWindowed extends flash.events.IEventDispatcher
ImplementorsEveWindowed

This interface represents the methods used in the eVE EveWindowed Class. Use this interface in your projects that require the eVE EveWindowed in leiu of referencing the eVE Classes directly.



Public Properties
 PropertyDefined by
  captureSettingsSet : Boolean
[read-only] The screen capture settings have been saved if set to true, otherwise it is false.
IEveWindowed
  dataInterface : IDataInterface
[read-only] Returns a reference to the eVE DataInterface for reference to components outside of eVE.
IEveWindowed
  overlayModule : IOverlayModule
[read-only] Returns a reference to the eVE OverlayModule for reference to components outside of eVE.
IEveWindowed
Public Methods
 MethodDefined by
  
addExitRoutine(routine:Function, objDispatchingCompleteEvent:IEventDispatcher = null, isAsync:Boolean = false):void
If you need some extra code to fire before eVE completely shutsdown you can use this function to add your clean up code to eVE internal clean up list.
IEveWindowed
  
fullScreen():void
Sets the display mode of the program to StageDisplayState.FULL_SCREEN_INTERACTIVE.
IEveWindowed
  
loadState(arg1:Object):void
IEveWindowed
  
quit(arg1:Boolean = false):void
Allows eVE to quit with a prompt asking if the user is sure they want to quit.
IEveWindowed
  
reset():void
Resets your eVE Application to its initial state.
IEveWindowed
  
updateCrumbDisplay(arg1:Event = null):void
Causes the crumb display to update.
IEveWindowed
Property detail
captureSettingsSetproperty
captureSettingsSet:Boolean  [read-only]

The screen capture settings have been saved if set to true, otherwise it is false.

The default value is false.

Implementation
    public function get captureSettingsSet():Boolean
dataInterfaceproperty 
dataInterface:IDataInterface  [read-only]

Returns a reference to the eVE DataInterface for reference to components outside of eVE.

Implementation
    public function get dataInterface():IDataInterface
overlayModuleproperty 
overlayModule:IOverlayModule  [read-only]

Returns a reference to the eVE OverlayModule for reference to components outside of eVE.

Implementation
    public function get overlayModule():IOverlayModule
Method detail
addExitRoutine()method
public function addExitRoutine(routine:Function, objDispatchingCompleteEvent:IEventDispatcher = null, isAsync:Boolean = false):void

If you need some extra code to fire before eVE completely shutsdown you can use this function to add your clean up code to eVE internal clean up list. Once EveWindowed.quit() is called and the quit request is confirmed it will go through the list and and fire off each function in its list. If you determine you function code needs to fire asynchronously, you need to dispatch an Event.COMPLETE to let eVE know you code has finished processing.

Parameters
routine:Function — The function that you want to execute on eVE Closing.
 
objDispatchingCompleteEvent:IEventDispatcher (default = null) — The object that will dispatch the Event.COMPLETE once the code is finished.
 
isAsync:Boolean (default = false) — Let's eVE know that this function will need to fire asynchronously.
fullScreen()method 
public function fullScreen():void

Sets the display mode of the program to StageDisplayState.FULL_SCREEN_INTERACTIVE.

loadState()method 
public function loadState(arg1:Object):void

Parameters
arg1:Object
quit()method 
public function quit(arg1:Boolean = false):void

Allows eVE to quit with a prompt asking if the user is sure they want to quit.

If promptBeforeExit is true then eVE will issue an Alert box to ask if you really want to quit or not.

Parameters
arg1:Boolean (default = false) — Prompt to quit if true
reset()method 
public function reset():void

Resets your eVE Application to its initial state. This includes setting the current state to null, resetting the crumb manager and the history manager.

updateCrumbDisplay()method 
public function updateCrumbDisplay(arg1:Event = null):void

Causes the crumb display to update.

Parameters
arg1:Event (default = null)