mx.messaging.events.ChannelEvent (Livecycle)

	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
		channel : Channel The Channel that generated this event.	ChannelEvent
		connected : Boolean Indicates whether the Channel that generated this event is already connected.	ChannelEvent
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

	Method	Defined 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 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
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in your custom Event class.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether preventDefault() has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toString():String Returns a string representation of the ChannelEvent.	ChannelEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] Defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] Defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] Defines the value of the type property of a change event object.	Event
		CLOSE : String = "close" [static] Defines the value of the type property of a close event object.	Event
		COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object.	Event
		CONNECT : String = "channelConnect" [static] The CONNECT event type; indicates that the Channel connected to its endpoint.	ChannelEvent
		DEACTIVATE : String = "deactivate" [static] Defines the value of the type property of a deactivate event object.	Event
		DISCONNECT : String = "channelDisconnect" [static] The DISCONNECT event type; indicates that the Channel disconnected from its endpoint.	ChannelEvent
		ENTER_FRAME : String = "enterFrame" [static] Defines the value of the type property of an enterFrame event object.	Event
		FULLSCREEN : String = "fullScreen" [static] Defines the value of the type property of a fullScreen event object.	Event
		ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] Defines the value of the type property of an init event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the type property of a mouseLeave event object.	Event
		OPEN : String = "open" [static] Defines the value of the type property of an open event object.	Event
		REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] Defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object.	Event
		SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] Defines the value of the type property of a select event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the type property of a soundComplete event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object.	Event

Property Detail

channel

property

public var channel:Channel

The Channel that generated this event.

connected

property

public var connected:Boolean

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

reconnecting

property

public var reconnecting:Boolean

Indicates whether the Channel that generated this event is reconnecting.

rejected

property

public var rejected:Boolean

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)

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

public override function clone():Event

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

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

public override function toString():String

Returns a string representation of the ChannelEvent.

Returns

String — String representation of the ChannelEvent.

Constant Detail

CONNECT

Constant

public static const CONNECT:String = "channelConnect"

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:

Property	Value
`bubbles`	false
`cancelable`	false
`channel`	The channel that generated this event.
`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`.
`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.
`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"

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:

Property	Value
`bubbles`	false
`cancelable`	false
`channel`	The channel that generated this event.
`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`.
`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.
`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.

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/mx/messaging/events/ChannelEvent.html

Livecycle ES API Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
ChannelEvent	Properties \| Methods \| Constants

Package	mx.messaging.events
Class	public class ChannelEvent
Inheritance	ChannelEvent Event Object
Subclasses	ChannelFaultEvent