(Preview)
| Package | mx.rpc.events |
| Class | public class HeaderEvent |
| Inheritance | HeaderEvent  AbstractEvent MessageEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| header : Object [read-only]
Header that the RPC call returned in the response. | HeaderEvent | ||
| message : IMessage
The Message associated with this event. | MessageEvent | |
| target : Object [read-only]
The event target. | Event | |
| token : mx.rpc:AsyncToken [read-only]
The token that represents the call to the method. | AbstractEvent | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
HeaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, header:Object = null, token:mx.rpc:AsyncToken = null, message:IMessage = null)
Creates a new HeaderEvent. | HeaderEvent | ||
| [override]
Clones the MessageEvent. | MessageEvent | |
[static]
Utility method to create a new HeaderEvent that doesn't bubble and is cancelable. | HeaderEvent | ||
|
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 representation of the HeaderEvent. | HeaderEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| HEADER : String = "header" [static]
The HEADER event type. | HeaderEvent | ||
Property Detail
header | property |
Constructor Detail
HeaderEvent | () | Constructor |
public function HeaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, header:Object = null, token:mx.rpc:AsyncToken = null, message:IMessage = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new HeaderEvent.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = true)true, but the preventDefault() method has no effect.
| |
header:Object (default = null) | |
token:mx.rpc:AsyncToken (default = null) | |
message:IMessage (default = null) |
Method Detail
createEvent | () | method |
public static function createEvent(header:Object, token:mx.rpc:AsyncToken, message:IMessage):HeaderEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Utility method to create a new HeaderEvent that doesn't bubble and is cancelable.
Parameters
header:Object — Object that holds the header of the call.
| |
token:mx.rpc:AsyncToken — AsyncToken that represents the call to the method. Used in the asynchronous completion token pattern.
| |
message:IMessage — Source Message header.
|
HeaderEvent — Returns a new HeaderEvent that doesn't bubble and is cancelable.
|
toString | () | method |
Constant Detail
HEADER | Constant |
public static const HEADER:String = "header"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The HEADER event type.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
token | The token that represents the call to the method. Used in the asynchronous completion token pattern. |
cancelable | true, but the preventDefault() method has no effect. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
header | Header that the RPC call returns in the response. |
message | The Message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Wed Nov 21 2018, 06:34 AM -08:00