(Flex Data Services のみ)
パッケージmx.messaging.events
public class ChannelEvent
継承ChannelEvent Inheritance Event Inheritance Object
SubclassesChannelFaultEvent

ChannelEvent クラスは、メッセージングシステム内でチャンネルイベントを伝達するときに使用されます。



パブリックプロパティ
 プロパティ定義
 Inheritedbubbles : Boolean
イベントがバブリングイベントかどうかを示します。
Event
 Inheritedcancelable : Boolean
イベントに関連付けられたビヘイビアを回避できるかどうかを示します。
Event
  channel : Channel
このイベントを生成したチャンネル。
ChannelEvent
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcurrentTarget : Object
イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
 InheritedeventPhase : uint
イベントフローの現在の段階です。
Event
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  reconnecting : Boolean
このイベントを生成したチャンネルが再接続中であるかどうかを示します。
ChannelEvent
  rejected : Boolean
このイベントを生成したチャンネルが拒否されたかどうかを示します。
ChannelEvent
 Inheritedtarget : Object
イベントターゲットです。
Event
 Inheritedtype : String
イベントの型です。
Event
パブリックメソッド
 メソッド定義
  ChannelEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false)
指定されたタイプとチャンネルインスタンスでこのイベントのインスタンスを作成します。
ChannelEvent
  clone():Event
ChannelEvent のクローンを作成します。
ChannelEvent
  createEvent(type:String, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false):ChannelEvent
[static] バブリングされずキャンセルできない新しい ChannelEvent を作成するためのユーティリティメソッドです。
ChannelEvent
 InheritedformatToString(className:String, ... arguments):String
カスタム Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisDefaultPrevented():Boolean
イベントで preventDefault() が呼び出されたかどうかをチェックします。
Event
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpreventDefault():void
イベントのデフォルトビヘイビアをキャンセルできる場合に、そのビヘイビアをキャンセルします。
Event
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedstopImmediatePropagation():void
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 InheritedstopPropagation():void
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
  toString():String
ChannelEvent のストリング表現を返します。
ChannelEvent
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
パブリック定数
 定数定義
 InheritedACTIVATE : String = "activate"
[static] activate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedADDED : String = "added"
[static] added イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCANCEL : String = "cancel"
[static] cancelイベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCHANGE : String = "change"
[static] change イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCLOSE : String = "close"
[static] close イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCOMPLETE : String = "complete"
[static] complete イベントオブジェクトの type プロパティの値を定義します。
Event
  CONNECT : String = "channelConnect"
[static] CONNECT イベント型。チャンネルがエンドポイントに接続されたことを示します。
ChannelEvent
 InheritedDEACTIVATE : String = "deactivate"
[static] deactivate イベントオブジェクトの type プロパティの値を定義します。
Event
  DISCONNECT : String = "channelDisconnect"
[static] DISCONNECT イベント型。チャンネルがエンドポイントから切断されたことを示します。
ChannelEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] enterFrame イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedID3 : String = "id3"
[static] id3 イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedINIT : String = "init"
[static] init イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] mouseLeave イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedOPEN : String = "open"
[static] open イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedREMOVED : String = "removed"
[static] removed イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRENDER : String = "render"
[static] render イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRESIZE : String = "resize"
[static] resize イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSCROLL : String = "scroll"
[static] scroll イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSELECT : String = "select"
[static] select イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] soundComplete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] tabChildrenChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] tabEnabledChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] tabIndexChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedUNLOAD : String = "unload"
[static] unload イベントオブジェクトの type プロパティの値を定義します。
Event
プロパティの詳細
channelプロパティ
public var channel:Channel

このイベントを生成したチャンネル。

reconnectingプロパティ 
public var reconnecting:Boolean

このイベントを生成したチャンネルが再接続中であるかどうかを示します。

rejectedプロパティ 
public var rejected:Boolean

このイベントを生成したチャンネルが拒否されたかどうかを示します。アクティビティがないことによりチャンネルが切断された場合は、これが true になり、フェイルオーバーが行われず、代替チャンネルへの接続も行われません。

コンストラクタの詳細
ChannelEvent()コンストラクタ
public 関数 ChannelEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false)

指定されたタイプとチャンネルインスタンスでこのイベントのインスタンスを作成します。

パラメータ
type:String — ChannelEvent タイプ。
 
bubbles:Boolean (default = false) — イベントが表示リスト階層を上方にバブルできるかどうかを指定します。
 
cancelable:Boolean (default = false) — イベントに関連付けられた動作を回避できるかどうかを示します。RPC サブクラスで使用されます。
 
channel:Channel (default = null) — イベントを生成したチャンネル。
 
reconnecting:Boolean (default = false) — チャンネルの再接続を処理中であるかどうかを示します。
 
rejected:Boolean (default = false) — チャンネルの接続が拒否されたかどうかを示します。拒否された場合は、自動再接続が抑制されます。
メソッドの詳細
clone()メソッド
public override function clone():Event

ChannelEvent のクローンを作成します。

戻り値
Event — この ChannelEvent のコピーです。
createEvent()メソッド 
public static function createEvent(type:String, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false):ChannelEvent

バブリングされずキャンセルできない新しい ChannelEvent を作成するためのユーティリティメソッドです。

パラメータ
type:String — ChannelEvent タイプ。
 
channel:Channel (default = null) — イベントを生成したチャンネル。
 
reconnecting:Boolean (default = false) — チャンネルの再接続を処理中であるかどうかを示します。
 
rejected:Boolean (default = false) — チャンネルの接続が拒否されたかどうかを示します。拒否された場合は、自動再接続が抑制されます。

戻り値
ChannelEvent — 新しい ChannelEvent。
toString()メソッド 
public override function toString():String

ChannelEvent のストリング表現を返します。

戻り値
String — ChannelEvent のストリング表現です。
定数の詳細
CONNECT定数
public static const CONNECT:String = "channelConnect"

CONNECT イベント型。チャンネルがエンドポイントに接続されたことを示します。

この定数の値は "channelConnect" です。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelablefalse
channelこのイベントがトリガされたチャンネルです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
reconnecting このイベントを生成したチャンネルが再接続中かどうかを示します。
rejected このイベントを生成したチャンネルが拒否されたかどうかを示します。アクティビティがないことによりチャンネルが切断された場合は、これが true になり、フェイルオーバーが行われず、代替チャンネルへの接続も行われません。
DISCONNECT定数 
public static const DISCONNECT:String = "channelDisconnect"

DISCONNECT イベント型。チャンネルがエンドポイントから切断されたことを示します。

この定数の値は "channelDisconnect" です。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelablefalse
channelこのイベントがトリガされたチャンネルです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
reconnecting このイベントを生成したチャンネルが再接続中かどうかを示します。
rejected このイベントを生成したチャンネルが拒否されたかどうかを示します。アクティビティがないことによりチャンネルが切断された場合は、これが true になり、フェイルオーバーが行われず、代替チャンネルへの接続も行われません。