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

HeaderEvent  - AS3 Flex
Packagemx.rpc.events
Classpublic class HeaderEvent
InheritanceHeaderEvent Inheritance AbstractEvent Inheritance MessageEvent Inheritance Event Inheritance Object

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
 PropertyDefined By
 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
  header : Object
[read-only] Header that the RPC call returned in the response.
HeaderEvent
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtoken : mx.rpc:AsyncToken
[read-only] The token that represents the call to the method.
AbstractEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
 Inherited
clone():Event
[override] Clones the MessageEvent.
MessageEvent
  
createEvent(header:Object, token:mx.rpc:AsyncToken, message:IMessage):HeaderEvent
[static] Utility method to create a new HeaderEvent that doesn't bubble and is cancelable.
HeaderEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString():String
[override] Returns a string representation of the HeaderEvent.
HeaderEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  HEADER : String = "header"
[static] The HEADER event type.
HeaderEvent
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: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.

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:mx.rpc: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: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.

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:

PropertyValue
bubblesfalse
tokenThe token that represents the call to the method. Used in the asynchronous completion token pattern.
cancelabletrue, but the preventDefault() method has no effect.
currentTargetThe 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.
headerHeader that the RPC call returns in the response.
messageThe Message associated with this event.
targetThe 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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy