Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
HeaderEvent

Package | mx.rpc.events
Class | public class HeaderEvent
Inheritance | HeaderEvent AbstractEvent MessageEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The event that indicates an RPC operation, such as a WebService SOAP request, returned a header in the response. A new header event is dispatched for each service header.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | header : Object [read-only] Header that the RPC call returned in the response. | HeaderEvent
|  | message : IMessage The Message associated with this event. | MessageEvent
|  | token : AsyncToken [read-only] The token that represents the call to the method. | AbstractEvent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | HeaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, header:Object = null, token:AsyncToken = null, message:IMessage = null) Creates a new HeaderEvent. | HeaderEvent
|  | clone():Event [override] Clones the MessageEvent. | MessageEvent
|  | createEvent(header:Object, token:AsyncToken, message:IMessage):HeaderEvent [static] Utility method to create a new HeaderEvent that doesn't bubble and is cancelable. | HeaderEvent
|  | toString():String [override] Returns a string representation of the HeaderEvent. | HeaderEvent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | HEADER : String = header [static] The HEADER event type. | HeaderEvent
|  | MESSAGE : String = message [static] The MESSAGE event type; dispatched upon receipt of a message. | MessageEvent
|  | RESULT : String = result [static] The RESULT event type; dispatched when an RPC agent receives a result from a remote service destination. | MessageEvent

Property Detail

header | property

`header:Object` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Header that the RPC call returned in the response.

Implementation
`public function get header():Object`
Constructor Detail

HeaderEvent | () | Constructor

`public function HeaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, header:Object = null, token: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.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `true`)`` — Specifies whether the behavior associated with the event can be prevented. The dfault is `true`, but the `preventDefault()` method has no effect.
| `header:Object` (default = `null`)`` — Object that holds the header of the call.
| `token:AsyncToken` (default = `null`)`` — AsyncToken that represents the call to the method. Used in the asynchronous completion token pattern.
| `message:IMessage` (default = `null`)`` — Source Message of the header.

Method Detail

createEvent | () | method

`public static function createEvent(header:Object, token: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:AsyncToken` — AsyncToken that represents the call to the method. Used in the asynchronous completion token pattern.
| `message:IMessage` — Source Message header.

Returns

| `HeaderEvent` — Returns a new HeaderEvent that doesn't bubble and is cancelable.

toString | () | method |

`override public function toString():String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a string representation of the HeaderEvent.

Returns

| `String` — String representation of the HeaderEvent.

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 15 2017, 09:50 AM +01:00