View source

class StageOrientationEvent

package openfl.events

extends Event

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on all platforms

A Stage object dispatches a StageOrientationEvent object when the orientation of the stage changes. This can occur when the device is rotated, when the user opens a slide-out keyboard, or when the 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 Stage.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 Stage.autoOrients is true.

See also:

Static variables

@:value("orientationChange")staticinlineread onlyORIENTATION_CHANGE:EventType<StageOrientationEvent> = "orientationChange"

The ORIENTATION_CHANGE constant defines the value of the type property of a orientationChange event object. This event has the following properties:

PropertyValue
afterOrientationThe new orientation of the stage.
beforeOrientationThe old orientation of the stage.
targetThe Stage object that dispatched the orientation change.
bubblestrue
currentTargetThe object that is actively processing the Event object with an event listener.
cancelablefalse; it is too late to cancel the change.

See also:

@:value("orientationChanging")staticinlineread onlyORIENTATION_CHANGING:EventType<StageOrientationEvent> = "orientationChanging"

The ORIENTATION_CHANGING constant defines the value of the type property of a orientationChanging event object. This event has the following properties:

PropertyValue
afterOrientationThe new orientation of the stage.
beforeOrientationThe old orientation of the stage.
targetThe Stage object that dispatched the orientation change.
bubblestrue
currentTargetThe object that is actively processing the Event object with an event listener.
cancelabletrue

See also:

Constructor

@:value({ afterOrientation : UNKNOWN, beforeOrientation : UNKNOWN, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, beforeOrientation:StageOrientation = UNKNOWN, afterOrientation:StageOrientation = UNKNOWN)

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.

Parameters:

type

The type of the event. Event listeners can access this information through the inherited type property.

bubbles

Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property.

cancelable

Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.

beforeOrientation

Indicates the orientation before the change.

afterOrientation

Indicates the orientation after the change.

Variables

afterOrientation:StageOrientation

The orientation of the stage after the change.

See also:

beforeOrientation:StageOrientation

The orientation of the stage before the change.

See also:

Methods

Inherited Variables

Defined by Event

read onlybubbles:Bool

Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list hierarchy to the node just before the target node; the target phase, which comprises the target node; and the bubbling phase, which flows from the node subsequent to the target node back up the display list hierarchy.

Some events, such as the activate and unload events, do not have a bubbling phase. The bubbles property has a value of false for events that do not have a bubbling phase.

read onlycancelable:Bool

Indicates whether the behavior associated with the event can be prevented. If the behavior can be canceled, this value is true; otherwise it is false.

read onlycurrentTarget:Object

The object that is actively processing the Event object with an event listener. For example, if a user clicks an OK button, the current target could be the node containing that button or one of its ancestors that has registered an event listener for that event.

read onlyeventPhase:EventPhase

The current phase in the event flow. This property can contain the following numeric values:

read onlytarget:Object

The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

read onlytype:String

The type of event. The type is case-sensitive.

Inherited Methods

Defined by Event

@:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

A utility function for implementing the toString() method in custom OpenFL Event classes. Overriding the toString() method is recommended, but not required.

class PingEvent extends Event {
	var URL:String;

	public function new() {
		super();
	}

	public override function toString():String {
		return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL");
	}
}

Parameters:

className

The name of your custom Event class. In the previous example, the className parameter is PingEvent.

Returns:

The name of your custom Event class and the String value of your ...arguments parameter.

isDefaultPrevented():Bool

Checks whether the preventDefault() method has been called on the event. If the preventDefault() method has been called, returns true; otherwise, returns false.

Returns:

If preventDefault() has been called, returns true; otherwise, returns false.

preventDefault():Void

Cancels an event's default behavior if that behavior can be canceled. Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the TextEvent.TEXT_INPUT event's default behavior can be canceled, you can use the preventDefault() method to prevent the character from appearing. An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the preventDefault() method has no effect on this default behavior. You can use the Event.cancelable property to check whether you can prevent the default behavior associated with a particular event. If the value of Event.cancelable is true, then preventDefault() can be used to cancel the event; otherwise, preventDefault() has no effect.

stopImmediatePropagation():Void

Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the stopPropagation() method doesn't take effect until all the event listeners in the current node finish processing.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

stopPropagation():Void

Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.