ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

FullScreenEvent  - AS3

Packageflash.events
Classpublic class FullScreenEvent
InheritanceFullScreenEvent Inheritance ActivityEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9.0.28.0, Flash Lite 4

The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode. There are two types of fullScreen events: FullScreenEvent.FULL_SCREEN and FullScreenEvent.FULL_SCREEN_INTERACTIVE_ACCEPTED.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedactivating : Boolean
Indicates whether the device is activating (true) or deactivating (false).
ActivityEvent
 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
  fullScreen : Boolean
[read-only] Indicates whether the Stage object is in full-screen mode (true) or not (false).
FullScreenEvent
  interactive : Boolean
[read-only] Indicates whether the Stage object is in full-screen interactive mode (true) or not (false).
FullScreenEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
FullScreenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, fullScreen:Boolean = false, interactive:Boolean = false)
Creates an event object that contains information about fullScreen events.
FullScreenEvent
  
[override] Creates a copy of a FullScreenEvent object and sets the value of each property to match that of the original.
FullScreenEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
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 FullScreenEvent object.
FullScreenEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FULL_SCREEN : String = "fullScreen"
[static] The FullScreenEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
FullScreenEvent
  FULL_SCREEN_INTERACTIVE_ACCEPTED : String = "fullScreenInteractiveAccepted"
[static] The FULL_SCREEN_INTERACTIVE_ACCEPTED:String constant defines the value of the type property of a fullScreenInteractiveAccepted event object.
FullScreenEvent
Property Detail

fullScreen

property
fullScreen:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9.0.28.0, Flash Lite 4

Indicates whether the Stage object is in full-screen mode (true) or not (false).



Implementation
    public function get fullScreen():Boolean

interactive

property 
interactive:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.3

Indicates whether the Stage object is in full-screen interactive mode (true) or not (false).



Implementation
    public function get interactive():Boolean
Constructor Detail

FullScreenEvent

()Constructor
public function FullScreenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, fullScreen:Boolean = false, interactive:Boolean = false)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9.0.28.0, Flash Lite 4

Creates an event object that contains information about fullScreen events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
fullScreen:Boolean (default = false) — Indicates whether the device is activating (true) or deactivating (false). Event listeners can access this information through the activating property.
 
interactive:Boolean (default = false)

Related API Elements

Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9.0.28.0, Flash Lite 4

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

Returns
Event — A new FullScreenEvent 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, Flash Player 9.0.28.0, Flash Lite 4

Returns a string that contains all the properties of the FullScreenEvent object. The following format is used:

[FullScreenEvent type=value bubbles=value cancelable=value activating=value]

Returns
String — A string that contains all the properties of the FullScreenEvent object.
Constant Detail

FULL_SCREEN

Constant
public static const FULL_SCREEN:String = "fullScreen"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9.0.28.0, Flash Lite 4

The FullScreenEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.

This event has the following properties:

PropertyValue
fullScreentrue if the display state is full screen or false if it is normal.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe Stage object.

Related API Elements

FULL_SCREEN_INTERACTIVE_ACCEPTED

Constant 
public static const FULL_SCREEN_INTERACTIVE_ACCEPTED:String = "fullScreenInteractiveAccepted"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.3, Flash Lite 4

The FULL_SCREEN_INTERACTIVE_ACCEPTED:String constant defines the value of the type property of a fullScreenInteractiveAccepted event object.

This event has the following properties:

PropertyValue
fullScreentrue if the display state is full screen or false if it is normal.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe Stage object.

Related API Elements