NativeWindowDisplayStateEvent

Package	flash.events
Class	public class NativeWindowDisplayStateEvent
Inheritance	NativeWindowDisplayStateEvent Event 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:

NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING
NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE

Related API Elements

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

Public Properties

	Property		Defined By
		afterDisplayState : String [read-only] The display state of the NativeWindow after the change.	NativeWindowDisplayStateEvent
		beforeDisplayState : String [read-only] The display state of the NativeWindow before the change.	NativeWindowDisplayStateEvent
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		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
		clone():Event [override] Creates a copy of the NativeWindowDisplayStateEvent object and sets the value of each property to match that of the original.	NativeWindowDisplayStateEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the NativeWindowDisplayStateEvent object.	NativeWindowDisplayStateEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		DISPLAY_STATE_CHANGE : String = "displayStateChange" [static] Defines the value of the type property of a displayStateChange event object.	NativeWindowDisplayStateEvent
		DISPLAY_STATE_CHANGING : String = "displayStateChanging" [static] Defines the value of the type property of a displayStateChanging event object.	NativeWindowDisplayStateEvent

Property Detail

afterDisplayState

property

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

beforeDisplayState

property

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

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

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.

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

DISPLAY_STATE_CHANGE

Constant

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:

Properties	Values
`afterDisplayState`	The old display state of the window.
`beforeDisplayState`	The new display state of the window.
`target`	The NativeWindow instance that has just changed state.
`bubbles`	No.
`currentTarget`	Indicates the object that is actively processing the Event object with an event listener.
`cancelable`	`false`; There is no default behavior to cancel.

Related API Elements

flash.display.NativeWindow

DISPLAY_STATE_CHANGING

Constant

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:

Properties	Values
`afterDisplayState`	The display state of the window before the pending change.
`beforeDisplayState`	The display state of the window after the pending change.
`target`	The NativeWindow instance that has just changed state.
`bubbles`	No.
`currentTarget`	Indicates the object that is actively processing the Event object with an event listener.
`cancelable`	`true`; canceling the event will prevent the change.

Related API Elements

flash.display.NativeWindow

Legal Notices | Online Privacy Policy

NativeWindowDisplayStateEvent - AS3

Classes x

afterDisplayState

beforeDisplayState

NativeWindowDisplayStateEvent

clone

toString

DISPLAY_STATE_CHANGE

DISPLAY_STATE_CHANGING