Packageflash.events
Classpublic class NativeWindowDisplayStateEvent
InheritanceNativeWindowDisplayStateEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window display state changes. There are two types of events:

See also

flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING
flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE

Public Properties
 PropertyDefined By
  AIR-only afterDisplayState : String
[read-only] The display state of the NativeWindow after the change.
NativeWindowDisplayStateEvent
  AIR-only beforeDisplayState : String
[read-only] The display state of the NativeWindow before the change.
NativeWindowDisplayStateEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AIR-only NativeWindowDisplayStateEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, beforeDisplayState:String = "", afterDisplayState:String = "")
Creates an Event object with specific information relevant to window display state events.
NativeWindowDisplayStateEvent
  
AIR-only clone():Event
[override] Creates a copy of the NativeWindowDisplayStateEvent object and sets the value of each property to match that of the original.
NativeWindowDisplayStateEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
AIR-only toString():String
[override] Returns a string that contains all the properties of the NativeWindowDisplayStateEvent object.
NativeWindowDisplayStateEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] The ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] The Event.CHANGE constant defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] The Event.CLEAR constant efines the value of the type property of a clear event object.
Event
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
 InheritedDISPLAYING : String = "displaying"
[static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
Event
  AIR-only DISPLAY_STATE_CHANGE : String = "displayStateChange"
[static] Defines the value of the type property of a displayStateChange event object.
NativeWindowDisplayStateEvent
  AIR-only DISPLAY_STATE_CHANGING : String = "displayStateChanging"
[static] Defines the value of the type property of a displayStateChanging event object.
NativeWindowDisplayStateEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant defines the value of the type property of an init event object.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] The Event.PASTE constant defines the value of the type property of a paste event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
Event
Property Detail
AIR-only afterDisplayStateproperty
afterDisplayState:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The display state of the NativeWindow after the change.

If the event is displayStateChanging, the display state has not yet changed; afterDisplayState indicates the new display state if the event is not canceled. If the event is displayStateChanged, afterDisplayState indicates the current value.



Implementation
    public function get afterDisplayState():String
AIR-only beforeDisplayStateproperty 
beforeDisplayState:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The display state of the NativeWindow before the change.

If the event is displayStateChanging, the display state has not yet changed; beforeDisplayState reflects the Window's current display state. If the event is displayStateChanged, beforeDisplayState indicates the previous value.



Implementation
    public function get beforeDisplayState():String
Constructor Detail
AIR-only NativeWindowDisplayStateEvent()Constructor
public function NativeWindowDisplayStateEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, beforeDisplayState:String = "", afterDisplayState:String = "")

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates an Event object with specific information relevant to window display state events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Possible values are:
  • NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING
  • NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be cancelled.
 
beforeDisplayState:String (default = "") — The displayState before the change.
 
afterDisplayState:String (default = "") — The displayState after the change.
Method Detail
AIR-only clone()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates a copy of the NativeWindowDisplayStateEvent object and sets the value of each property to match that of the original.

Returns
Event — A new NativeWindowDisplayStateEvent object with property values that match those of the original.
AIR-only toString()method 
override public function toString():String

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Returns a string that contains all the properties of the NativeWindowDisplayStateEvent object. The string has the following format:

[NativeWindowDisplayStateEvent type=value bubbles=value cancelable=value beforeDisplayState=value afterDisplayState=value]

Returns
String — A string that contains all the properties of the NativeWindowDisplayStateEvent object.
Constant Detail
AIR-only DISPLAY_STATE_CHANGEConstant
public static const DISPLAY_STATE_CHANGE:String = "displayStateChange"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Defines the value of the type property of a displayStateChange event object. This event has the following properties:

PropertiesValues
afterDisplayStateThe old display state of the window.
beforeDisplayStateThe new display state of the window.
targetThe NativeWindow instance that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.

See also

flash.display.NativeWindow
AIR-only DISPLAY_STATE_CHANGINGConstant 
public static const DISPLAY_STATE_CHANGING:String = "displayStateChanging"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Defines the value of the type property of a displayStateChanging event object. This event has the following properties:

PropertiesValues
afterDisplayStateThe display state of the window before the pending change.
beforeDisplayStateThe display state of the window after the pending change.
targetThe NativeWindow instance that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelabletrue; canceling the event will prevent the change.

See also

flash.display.NativeWindow



© 2009 Adobe Systems Incorporated. All rights reserved.
Fri Aug 14 2009, 04:09 PM +05:30