Package | flash.events |
Class | public class StageOrientationEvent |
Inheritance | StageOrientationEvent Event Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 2 |
There are two types of StageOrientationEvent events:
-
orientationChanging
(StageOrientationEvent.ORIENTATION_CHANGING
)—Dispatched as the orientation of the screen is changing. -
orientationChange
(StageOrientationEvent.ORIENTATION_CHANGE
)—Dispatched when the screen changes into a new orientation.
See also
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 |
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 |
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 efines 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 | ||
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 | ||
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 | ||
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 |
afterOrientation | property |
afterOrientation:String
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 2 |
The orientation of the stage after the change.
If the event is orientationChanging
, the
bounds have not yet changed; afterOrientation
indicates the new orientation
if the event is not canceled. If the event is
orientationChange
,
afterOrientation
indicates the current orientation.
Implementation
public function get afterOrientation():String
beforeOrientation | property |
beforeOrientation:String
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 2 |
The orientation of the stage before the change.
If the event is orientationChanging
, the
bounds have not yet changed; beforeOrientation
reflects the current orientation. If the event is
orientationChange
,
beforeOrientation
indicates the original value.
Implementation
public function get beforeOrientation():String
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. Possible values are:
| |
bubbles:Boolean (default = false ) — Indicates whether the Event object participates in the bubbling stage of the event flow.
| |
cancelable:Boolean (default = false ) — Indicates whether the Event object can be canceled.
| |
beforeOrientation:String (default = null ) — Indicates the bounds before the most recent change or the pending change.
| |
afterOrientation:String (default = null ) — Indicates the bounds after the most recent change or the pending change.
|
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 previousDisplayState=value currentDisplayState=value]
String — A string that contains all the properties of the StageOrientationEvent object.
|
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 |
---|---|
afterBounds | The new bounds of the stage. |
beforeBounds | The old bounds of the stage. |
target | The Stage object that has just changed orientation. |
bubbles | true |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | false ; there is no default behavior to cancel. |
See also
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.
This event has the following properties:
Properties | Values |
---|---|
afterBounds | The bounds of the stage after the pending change. |
beforeBounds | The bounds of the stage before the pending change. |
target | The Stage object that is changing orientation. |
bubbles | No. |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | true ; calling preventDefault() prevents
the re-orientation to take place. |
See also
orientationChange
event objects), the application does two things:
- It displays information about the stage orientation in the text field.
- It resizes the text field based on the new size of the stage.
package { import flash.events.*; import flash.display.*; import flash.text.*; public class ScreenOrientationTest extends Sprite { public var logField:TextField; public function ScreenOrientationTest():void { logField = new TextField(); resizeLogField(); try { logField.text = stage.orientation; stage.addEventListener("orientationChange", orientationChangeListener); } catch(e:Error) { log("Stage orientation not supported."); } } public function orientationChangeListener(event:Event):void { resizeLogField(); log("beforeOrientation:" + event["beforeOrientation"].toString() + "\nafterOrientation:" + event["afterOrientation"].toString()); } public function setUpLogField():void { logField.defaultTextFormat = new TextFormat("_sans", 25); logField.type = TextFieldType.INPUT; logField.x = 10; logField.y = 10; logField.border = true; logField.wordWrap = true; logField.multiline = true; addChild(logField); } public function resizeLogField():void { logField.width = stage.stageWidth - 20; logField.height = stage.stageHeight - 20; } public function log(obj:Object):void { var date:Date = new Date(); var time:String = date.hours.toString() + ":" + date.minutes.toString() + ":" + date.seconds.toString(); logField.text = time + ": " + obj.toString() +"\n"; } } }
Thu May 20 2010, 02:19 AM -07:00