| Package | flash.events |
| Class | public class StageOrientationEvent |
| Inheritance | StageOrientationEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
setAspectRatio()
method of the Stage is called.
There are two types of StageOrientationEvent event:
The orientationChanging
(StageOrientationEvent.ORIENTATION_CHANGING), is dispatched
before the screen changes to a new orientation. Calling the preventDefault()
method of the event object dispatched for orientationChanging prevents the stage from
changing orientation.
The orientationChange
(StageOrientationEvent.ORIENTATION_CHANGE), is dispatched
after the screen changes to a new orientation.
Note: If the autoOrients property is false, then the stage orientation
does not change when a device is rotated. Thus, StageOrientationEvents are only dispatched for
device rotation when autoOrients is true.
More examples
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| afterOrientation : String [read-only]
The orientation of the stage after the change. | StageOrientationEvent | ||
| beforeOrientation : String [read-only]
The orientation of the stage before the change. | StageOrientationEvent | ||
 | 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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
StageOrientationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeOrientation:String = null, afterOrientation:String = null)
Creates a StageOrientationEvent object with specific information relevant to stage orientation events. | StageOrientationEvent | ||
[override]
Creates a copy of the StageOrientationEvent object and sets the value of each property to match that of the original. | StageOrientationEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the StageOrientationEvent object. | StageOrientationEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CLEAR : String = "clear" [static]
The Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| 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 | |
| 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 | |
| HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
| LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| ORIENTATION_CHANGE : String = "orientationChange" [static]
The ORIENTATION_CHANGE constant defines the value of the type property of
a orientationChange event object. | StageOrientationEvent | ||
| ORIENTATION_CHANGING : String = "orientationChanging" [static]
The ORIENTATION_CHANGING constant defines the value of the type property of
a orientationChanging event object. | StageOrientationEvent | ||
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
| UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| 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
afterOrientation | property |
beforeOrientation | property |
Constructor Detail
StageOrientationEvent | () | Constructor |
public function StageOrientationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeOrientation:String = null, afterOrientation:String = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
Creates a StageOrientationEvent object with specific information relevant to stage orientation events. Event objects are passed as parameters to event listeners. Generally you do not create this event using the constructor function. Instead, you add an event listener on the Stage object to detect these events as they occur.
Parameterstype:String — The type of the event: StageOrientationEvent.ORIENTATION_CHANGE
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
beforeOrientation:String (default = null) | |
afterOrientation:String (default = null) |
Method Detail
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
Creates a copy of the StageOrientationEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new StageOrientationEvent 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 2 |
Returns a string that contains all the properties of the StageOrientationEvent object. The string has the following format:
[StageOrientationEvent type=value bubbles=value cancelable=value beforeDisplayState=value afterDisplayState=value]
String — A string that contains all the properties of the StageOrientationEvent object.
|
Constant Detail
ORIENTATION_CHANGE | Constant |
public static const ORIENTATION_CHANGE:String = "orientationChange"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
The ORIENTATION_CHANGE constant defines the value of the type property of
a orientationChange event object.
This event has the following properties:
| Properties | Values |
|---|---|
afterOrientation | The new orientation of the stage. |
beforeOrientation | The old orientation of the stage. |
target | The Stage object that dispatched the orientation change. |
bubbles | true |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | false; it is too late to cancel the change. |
Related API Elements
ORIENTATION_CHANGING | Constant |
public static const ORIENTATION_CHANGING:String = "orientationChanging"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
The ORIENTATION_CHANGING constant defines the value of the type property of
a orientationChanging event object.
Important: ORIENTATION_CHANGING events are not dispatched on Android devices.
This event has the following properties:| Properties | Values |
|---|---|
afterOrientation | The new orientation of the stage. |
beforeOrientation | The old orientation of the stage. |
target | The Stage object that dispatched the orientation change. |
bubbles | true |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | true. |
Mon Nov 28 2011, 06:48 AM -08:00