(Beta)
| Package | flash.events |
| Class | public class ActivityEvent |
| Inheritance | ActivityEvent  Event Object |
| Subclasses | FullScreenEvent |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9 |
ActivityEvent.ACTIVITY.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| activating : Boolean
Indicates whether the device is activating (true) or deactivating
(false). | ActivityEvent | ||
 | 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 | ||
|---|---|---|---|
ActivityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, activating:Boolean = false)
Creates an event object that contains information about activity events. | ActivityEvent | ||
[override]
Creates a copy of an ActivityEvent object and sets the value of each property to match that of
the original. | ActivityEvent | ||
|
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 ActivityEvent object. | ActivityEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVITY : String = "activity" [static]
The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object. | ActivityEvent | ||
Property Detail
activating | property |
Constructor Detail
ActivityEvent | () | Constructor |
public function ActivityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, activating:Boolean = false)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9 |
Creates an event object that contains information about activity events. Event objects are passed as parameters to Event listeners.
Parameterstype:String — The type of the event. Event listeners can access this information through the
inherited type property. There is only one type of activity event:
ActivityEvent.ACTIVITY.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
activating:Boolean (default = false)true) or
deactivating (false). Event listeners can access this information through the
activating property.
|
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 |
Creates a copy of an ActivityEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new ActivityEvent 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 |
Returns a string that contains all the properties of the ActivityEvent object. The following format is used:
[ActivityEvent type=value bubbles=value cancelable=value
activating=value]
String — A string that contains all the properties of the ActivityEvent object.
|
Constant Detail
ACTIVITY | Constant |
public static const ACTIVITY:String = "activity"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9 |
The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object.
This event has the following properties:
| Property | Value |
|---|---|
activating | true if the device is activating or false if it is deactivating. |
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object beginning or ending a session, such as a Camera or Microphone object. |
Related API Elements
Examples How to use this example
ActivityEventExample.as
The following example demonstrates the use of the ActivityEvent class by
attaching an event listener method named
activityHandler() to the microphone and
generating text information every time the microphone generates an activity event.
package {
import flash.display.Sprite;
import flash.events.ActivityEvent;
import flash.media.Microphone;
public class ActivityEventExample extends Sprite {
public function ActivityEventExample() {
var mic:Microphone = Microphone.getMicrophone();
mic.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
}
private function activityHandler(event:ActivityEvent):void {
trace("event: " + event);
trace("event.activating: " + event.activating);
}
}
}
Wed Nov 21 2018, 06:34 AM -08:00