(Beta)
| Package | flash.events |
| Class | public class DataEvent |
| Inheritance | DataEvent  TextEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
-
DataEvent.DATA: dispatched for data sent or received. -
DataEvent.UPLOAD_COMPLETE_DATA: dispatched when data is sent and the server has responded.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | 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 | |
| data : String
The raw data loaded into Flash Player or Adobe AIR. | DataEvent | ||
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| target : Object [read-only]
The event target. | Event | |
| text : String
For a textInput event, the character or sequence of characters
entered by the user. | TextEvent | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Creates an event object that contains information about data events. | DataEvent | ||
[override]
Creates a copy of the DataEvent object and sets the value of each property to match that of the
original. | DataEvent | ||
|
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 DataEvent object. | DataEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| DATA : String = "data" [static]
Defines the value of the type property of a data event object. | DataEvent | ||
| UPLOAD_COMPLETE_DATA : String = "uploadCompleteData" [static]
Defines the value of the type property of an uploadCompleteData event object. | DataEvent | ||
Property Detail
data | property |
Constructor Detail
DataEvent | () | Constructor |
public function DataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:String = "")| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Creates an event object that contains information about data 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 data event:
DataEvent.DATA.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
data:String (default = "data 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, Flash Lite 4 |
Creates a copy of the DataEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new DataEvent 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, Flash Lite 4 |
Returns a string that contains all the properties of the DataEvent object. The string is in the following format:
[DataEvent type=value bubbles=value cancelable=value
data=value]
String — A string that contains all the properties of the DataEvent object.
|
Constant Detail
DATA | Constant |
public static const DATA:String = "data"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Defines the value of the type property of a data event object.
This event has the following properties:
| Property | Value |
|---|---|
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. |
data | The raw data loaded into Flash Player or Adobe AIR. |
target | The XMLSocket object receiving data. |
Related API Elements
UPLOAD_COMPLETE_DATA | Constant |
public static const UPLOAD_COMPLETE_DATA:String = "uploadCompleteData"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9.0.28.0, Flash Lite 4 |
Defines the value of the type property of an uploadCompleteData event object.
This event has the following properties:
| Property | Value |
|---|---|
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. |
data | The raw data returned from the server after a successful file upload. |
target | The FileReference object receiving data after a successful upload. |
Related API Elements
Examples How to use this example
DataEventExample.as
The following example creates an XMLSocket and connects it to a socket server
running on port 8080 of
yourDomain. An event listener is attached to the XMLSocket
object that listens for data events, which are dispatched whenever raw data
is received.
Notes:
- To generate a
securityErrorevent in this example, you need to compile the SWF file with "Local playback security" set to "Access network only". - You need a server running on [
yourDomain] using port 8080.
package {
import flash.display.Sprite;
import flash.events.DataEvent;
import flash.net.XMLSocket;
public class DataEventExample extends Sprite {
private var hostName:String = "[yourDomain]";
private var port:uint = 8080;
private var socket:XMLSocket;
public function DataEventExample() {
socket = new XMLSocket();
socket.addEventListener(DataEvent.DATA, dataHandler);
socket.connect(hostName, port);
}
private function dataHandler(event:DataEvent):void {
trace("dataHandler: " + event.data);
}
}
}
Wed Nov 21 2018, 06:34 AM -08:00