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

ChannelEvent  - AS3 BlazeDS LCDS
Packagemx.messaging.events
Classpublic class ChannelEvent
InheritanceChannelEvent Inheritance Event Inheritance Object
Subclasses ChannelFaultEvent

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The ChannelEvent is used to propagate channel events within the messaging system.


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
  channel : Channel
The Channel that generated this event.
ChannelEvent
  connected : Boolean
Indicates whether the Channel that generated this event is already connected.
ChannelEvent
 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
  reconnecting : Boolean
Indicates whether the Channel that generated this event is reconnecting.
ChannelEvent
  rejected : Boolean
Indicates whether the Channel that generated this event was rejected.
ChannelEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ChannelEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false)
Constructs an instance of this event with the specified type and Channel instance.
ChannelEvent
  
clone():Event
[override] Clones the ChannelEvent.
ChannelEvent
  
createEvent(type:String, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false):ChannelEvent
[static] Utility method to create a new ChannelEvent that doesn't bubble and is not cancelable.
ChannelEvent
 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 ChannelEvent.
ChannelEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CONNECT : String = "channelConnect"
[static] The CONNECT event type; indicates that the Channel connected to its endpoint.
ChannelEvent
  DISCONNECT : String = "channelDisconnect"
[static] The DISCONNECT event type; indicates that the Channel disconnected from its endpoint.
ChannelEvent
Property Detail

channel

property
public var channel:Channel

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The Channel that generated this event.

connected

property 
public var connected:Boolean

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether the Channel that generated this event is already connected.

reconnecting

property 
public var reconnecting:Boolean

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether the Channel that generated this event is reconnecting.

rejected

property 
public var rejected:Boolean

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether the Channel that generated this event was rejected. This would be true in the event that the channel has been disconnected due to inactivity and should not attempt to failover or connect on an alternate channel.

Constructor Detail

ChannelEvent

()Constructor
public function ChannelEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false)

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructs an instance of this event with the specified type and Channel instance.

Parameters
type:String — The ChannelEvent type.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented; used by the RPC subclasses.
 
channel:Channel (default = null) — The Channel generating the event.
 
reconnecting:Boolean (default = false) — Indicates whether the Channel is in the process of reconnecting or not.
 
rejected:Boolean (default = false) — Indicates whether the Channel's connection has been rejected, which suppresses automatic reconnection.
 
connected:Boolean (default = false) — Indicates whether the Channel that generated this event is already connected.
Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Clones the ChannelEvent.

Returns
Event — Copy of this ChannelEvent.

createEvent

()method 
public static function createEvent(type:String, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false):ChannelEvent

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Utility method to create a new ChannelEvent that doesn't bubble and is not cancelable.

Parameters

type:String — The ChannelEvent type.
 
channel:Channel (default = null) — The Channel generating the event.
 
reconnecting:Boolean (default = false) — Indicates whether the Channel is in the process of reconnecting or not.
 
rejected:Boolean (default = false) — Indicates whether the Channel's connection has been rejected, which suppresses automatic reconnection.
 
connected:Boolean (default = false) — Indicates whether the Channel that generated this event is already connected.

Returns
ChannelEvent — New ChannelEvent.

toString

()method 
override public function toString():String

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns a string representation of the ChannelEvent.

Returns
String — String representation of the ChannelEvent.
Constant Detail

CONNECT

Constant
public static const CONNECT:String = "channelConnect"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The CONNECT event type; indicates that the Channel connected to its endpoint.

The value of this constant is "channelConnect".

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
channelThe channel that generated this event.
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.
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.
reconnecting Indicates whether the channel that generated this event is reconnecting.
rejected Indicates whether the channel that generated this event was rejected. This would be true in the event that the channel has been disconnected due to inactivity and should not attempt to failover or connect on an alternate channel.

DISCONNECT

Constant 
public static const DISCONNECT:String = "channelDisconnect"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The DISCONNECT event type; indicates that the Channel disconnected from its endpoint.

The value of this constant is "channelDisconnect".

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
channelThe channel that generated this event.
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.
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.
reconnecting Indicates whether the channel that generated this event is reconnecting.
rejected Indicates whether the channel that generated this event was rejected. This would be true in the event that the channel has been disconnected due to inactivity and should not attempt to failover or connect on an alternate channel.



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

 

Legal Notices | Online Privacy Policy