Packageat.display
Classpublic class EveWindowed
InheritanceEveWindowed Inheritance mx.core.WindowedApplication
ImplementsIEveWindowed, IHistoryManagerClient

EveWindowed defines a WindowedApplication based on the Adobe AIR framework.



Public Properties
 PropertyDefined by
  captureFilename : String = "eveScreenCapture"
[static] The name for the file to save from the eVE screen capture process, minus extension.
EveWindowed
  captureSettingsSet : Boolean
[read-only] The screen capture settings have been saved if set to true, otherwise it is false.
EveWindowed
  crumbManager : ApplicationCrumbManager
EveWindowed
  dataInterface : IDataInterface
[read-only] Reference to the DataInterface instance.
EveWindowed
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
EveWindowed
  fullscreenOnActivate : Boolean
Sets the display state to fullScreenInteractive when the eVE application regains system focus if set to true.
EveWindowed
  fullscreenOnStartup : Boolean = true
Determines if the application is in FULL_SCREEN_INTERACTIVE mode on startup.
EveWindowed
  historyManager : ApplicationHistoryManager
EveWindowed
  overlayModule : IOverlayModule
[read-only] Reference to the OverlayModule instance.
EveWindowed
  thumbnailPrefix : String = "tn_"
[static] The value for the prefix of the thumbnail that is saved, if set in the eVE Capture Settings window.
EveWindowed
  useDefaultCrumbManagement : Boolean = true
EveWindowed
Protected Properties
 PropertyDefined by
  defaultState : String = ""
EveWindowed
  eveFontsRegistered : Boolean
[static] Set to true if the fonts that are used by default in eVE are added to the registered font list.
EveWindowed
Public Methods
 MethodDefined by
  
Constructor.
EveWindowed
  
addExitRoutine(routine:Function, objDispatchingCompleteEvent:IEventDispatcher = null, isAsync:Boolean = false):void
EveWindowed
  
fullScreen():void
Sets the display mode of the program to StageDisplayState.FULL_SCREEN_INTERACTIVE.
EveWindowed
  
getState(stateName:String = null):Object
EveWindowed
  
loadState(state:Object):void
EveWindowed
  
EveWindowed
  
quit(promptBeforeExit:Boolean = false):void
Allows eVE to quit with a prompt asking if the user is sure they want to quit.
EveWindowed
  
reset():void
Resets the crumbManager
EveWindowed
  
saveState():Object
EveWindowed
  
screenCapture(e:Event = null):void
Handles the actual screen capture based on the settings in the eVE Capture Settings window.
EveWindowed
  
updateCrumbDisplay(e:Event = null):void
EveWindowed
Protected Methods
 MethodDefined by
  
activateHandler(e:AIREvent):void
Sets the application to StageDisplayState.FULL_SCREEN_INTERACTIVE when the application regains focus if fullScreenOnActivate is true.
EveWindowed
  
applicationCompleteHandler(e:FlexEvent):void
Runs when the application's FlexEvent.APPLICATION_COMPLETE event fires.
EveWindowed
  
Handles all of the bubbling OverlayEvents.
EveWindowed
  
creationCompleteHandler(e:FlexEvent):void
Runs when the application's FlexEvent.CREATION_COMPLETE event fires.
EveWindowed
  
EveWindowed
  

Called by the onInitialize event handler.

EveWindowed
  
keyHandler(e:KeyboardEvent):void
Sets the default eVE keyboard shortcuts.
EveWindowed
  
onRoutineComplete(e:Event):void
EveWindowed
  
onStateChange(e:StateChangeEvent):void
EveWindowed
  
onStateChangeCrumbHandler(e:StateChangeEvent):void
EveWindowed
  
Pops up a window to display the eVE Capture Settings window.
EveWindowed
  
preinitializeHandler(e:FlexEvent):void
Runs when the application's FlexEvent.PREINITIALIZE event fires.
EveWindowed
  
quitHandler(e:CloseEvent):void
Handles the event when the quit Alert box is closed.
EveWindowed
  
saveFile(file:File = null, byteArray:ByteArray = null):void
This method saves the file to the system as a PNG file.
EveWindowed
  
Handles the event when the screen capture settings have been saved.
EveWindowed
Events
 EventSummaryDefined by
   Dispatched when the eVE Screen Capture Settings window is closed.EveWindowed
   Dispatched when the eVE Screen Capture Settings window is opened.EveWindowed
   Dispatched when the HistoryManager is reset.EveWindowed
   Dispatched when a file is saved with the eVE screen capture utility.EveWindowed
Property detail
captureFilenameproperty
public static var captureFilename:String = "eveScreenCapture"

The name for the file to save from the eVE screen capture process, minus extension.

This value can be set at any point, and will use the String provided and automatically save a file to the specified location with that name.

The default value is "eveScreenCapture".

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.

This property can be used as the source for data binding.

Implementation
    public function get captureSettingsSet():Boolean
crumbManagerproperty 
public var crumbManager:ApplicationCrumbManager

This property can be used as the source for data binding.

dataInterfaceproperty 
dataInterface:IDataInterface  [read-only]

Reference to the DataInterface instance.

Implementation
    public function get dataInterface():IDataInterface
debugModeproperty 
public 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.

defaultStateproperty 
protected var defaultState:String = ""

eveFontsRegisteredproperty 
protected static var eveFontsRegistered:Boolean

Set to true if the fonts that are used by default in eVE are added to the registered font list.

fullscreenOnActivateproperty 
fullscreenOnActivate:Boolean  [read-write]

Sets the display state to fullScreenInteractive when the eVE application regains system focus if set to true.

The default value is true.

Implementation
    public function get fullscreenOnActivate():Boolean
    public function set fullscreenOnActivate(value:Boolean):void
fullscreenOnStartupproperty 
public var fullscreenOnStartup:Boolean = true

Determines if the application is in FULL_SCREEN_INTERACTIVE mode on startup.

This will call fullscreen() on APPLICATION_COMPLETE.

The default value is true.

historyManagerproperty 
public var historyManager:ApplicationHistoryManager

overlayModuleproperty 
overlayModule:IOverlayModule  [read-only]

Reference to the OverlayModule instance.

Implementation
    public function get overlayModule():IOverlayModule
thumbnailPrefixproperty 
public static var thumbnailPrefix:String = "tn_"

The value for the prefix of the thumbnail that is saved, if set in the eVE Capture Settings window.

This is the value that is used before the captureFilename for the thumbnail.

The default is tn_eveScreenCapture

The default value is "tn_".

useDefaultCrumbManagementproperty 
public var useDefaultCrumbManagement:Boolean = true

Constructor detail
EveWindowed()constructor
public function EveWindowed()

Constructor.

Method detail
activateHandler()method
protected function activateHandler(e:AIREvent):void

Sets the application to StageDisplayState.FULL_SCREEN_INTERACTIVE when the application regains focus if fullScreenOnActivate is true.

Parameters
e:AIREvent — The AIR event
addExitRoutine()method 
public function addExitRoutine(routine:Function, objDispatchingCompleteEvent:IEventDispatcher = null, isAsync:Boolean = false):void

Parameters
routine:Function
 
objDispatchingCompleteEvent:IEventDispatcher (default = null)
 
isAsync:Boolean (default = false)
applicationCompleteHandler()method 
protected function applicationCompleteHandler(e:FlexEvent):void

Runs when the application's FlexEvent.APPLICATION_COMPLETE event fires.

Parameters
e:FlexEvent
createOverlay()method 
protected function createOverlay(e:OverlayEvent):void

Handles all of the bubbling OverlayEvents.

All of the OverlayEvent.OVERLAY_REQUEST and OverlayEvent.OVERLAY_VIDEO_REQUEST that are dispatched in the application, should be bubbling by default. eVE will handle the display of the pop up based on the settings in the event. This includes files and videos that will be played in overlay.

Parameters
e:OverlayEvent — The OverlayEvent

See also

creationCompleteHandler()method 
protected function creationCompleteHandler(e:FlexEvent):void

Runs when the application's FlexEvent.CREATION_COMPLETE event fires. Ensures that the currentState is not null by assigning it the empty string if no default state is specified, or sets the current state.

Parameters
e:FlexEvent
executeExitRoutines()method 
protected function executeExitRoutines():void

fullScreen()method 
public function fullScreen():void

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

getState()method 
public function getState(stateName:String = null):Object

Parameters
stateName:String (default = null) — The stateName

Returns
Object
initializeDatabase()method 
protected function initializeDatabase():void

Called by the onInitialize event handler. Creates/Copies the Eve Application database to the local machine's Application Storage. The name of the database copied/created is specified in the GlobalSettings.databaseName variable.

If using a pre-populated database, be sure the database exists in the bin-debug directory of the project, otherwise, a an empty database (with empty tables built) will be created in the local machine's Application Storage.

keyHandler()method 
protected function keyHandler(e:KeyboardEvent):void

Sets the default eVE keyboard shortcuts.

If Control (Command on Mac) + Shift + C is pressed, a screenshot is taken of the eVE application. If the settings have not been set for this run of the application, then it pops up the eVE Screen Capture Settings window.

Control (Command on Mac) + Shift + W always opens the eVE Screen Capture Settings window.

Parameters
e:KeyboardEvent — The KeyboardEvent
loadState()method 
public function loadState(state:Object):void

Parameters
state:Object
onHistoryChanged()method 
public function onHistoryChanged(e:HistoryChangedEvent):void

Parameters
e:HistoryChangedEvent — The event
onRoutineComplete()method 
protected function onRoutineComplete(e:Event):voidParameters
e:Event
onStateChange()method 
protected function onStateChange(e:StateChangeEvent):void

Parameters
e:StateChangeEvent — The event
onStateChangeCrumbHandler()method 
protected function onStateChangeCrumbHandler(e:StateChangeEvent):void

Parameters
e:StateChangeEvent — The event
popUpCaptureSettings()method 
protected function popUpCaptureSettings():void

Pops up a window to display the eVE Capture Settings window.

preinitializeHandler()method 
protected function preinitializeHandler(e:FlexEvent):void

Runs when the application's FlexEvent.PREINITIALIZE event fires.

This event handler runs the DataInterface.initializeDatabase method, saves the application's default state in the ApplicationHistoryManager, and updates the default crumbManager's display.

Parameters
e:FlexEvent
quit()method 
public function quit(promptBeforeExit: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
promptBeforeExit:Boolean (default = false) — Prompt to quit if true
quitHandler()method 
protected function quitHandler(e:CloseEvent):void

Handles the event when the quit Alert box is closed. If Alert.YES the program quits.

Parameters
e:CloseEvent
reset()method 
public function reset():void

Resets the crumbManager

saveFile()method 
protected function saveFile(file:File = null, byteArray:ByteArray = null):void

This method saves the file to the system as a PNG file.

After the screen is captured, saveFile saves the file(s) to the specified location on the hard drive.

Parameters
file:File (default = null) — The File that has the path information
 
byteArray:ByteArray (default = null) — The image to save
saveState()method 
public function saveState():Object

Returns
Object
screenCapture()method 
public function screenCapture(e:Event = null):void

Handles the actual screen capture based on the settings in the eVE Capture Settings window.

If no save location was set, it defaults to the computer's desktop.

Parameters
e:Event (default = null) — The event
screenCaptureSettingsSaved()method 
protected function screenCaptureSettingsSaved(e:ScreenCaptureEvent):void

Handles the event when the screen capture settings have been saved.

Parameters
e:ScreenCaptureEvent — The ScreenCaptureEvent

See also

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

Parameters
e:Event (default = null)
Event detail
captureSettingsClosedevent 
Event object type: at.events.ScreenCaptureEvent
ScreenCaptureEvent.type property = at.events.ScreenCaptureEvent.CAPTURE_SETTINGS_CLOSED

Dispatched when the eVE Screen Capture Settings window is closed.

Defines when the eVE Screen Capture Settings window is closed.

captureSettingsOpenedevent  
Event object type: at.events.ScreenCaptureEvent
ScreenCaptureEvent.type property = at.events.ScreenCaptureEvent.CAPTURE_SETTINGS_OPENED

Dispatched when the eVE Screen Capture Settings window is opened.

Defines when the eVE Screen Capture Settings window is opened.

historyResetevent  
Event object type: flash.events.Event

Dispatched when the HistoryManager is reset.

screenCaptureFileSavedevent  
Event object type: at.events.ScreenCaptureEvent

Dispatched when a file is saved with the eVE screen capture utility.