Packagejp.nium.display
Classpublic class ExDocument
InheritanceExDocument Inheritance ExMovieClip Inheritance flash.display.MovieClip
Subclasses CastDocument, CastPreloader

ExDocument クラスは、ExMovieClip クラスに対してドキュメントクラスとしての機能拡張を追加した表示オブジェクトクラスです。 The ExDocument class is a display object class that added the functionality expansion as the document class, to the ExMovieClip class.

View the examples


Public Properties
 PropertyDefined By
  align : String
[static] Flash Player またはブラウザでのステージの配置を指定する StageAlign クラスの値です。 A value from the StageAlign class that specifies the alignment of the stage in Flash Player or the browser.
ExDocument
  bottom : int
[static] [read-only] ステージ下の Y 座標を取得します。 Get the bottom Y coordinate of the stage.
ExDocument
  centeringX : Boolean
ExDocument インスタンスの画面上の表示 X 座標を常に SWF ファイルエリアの中央とするかどうかを取得または設定します。 Acquire or set if the X coordinate of the ExDocument instance to display, will be at the center of the SWF file area.
ExDocument
  centeringY : Boolean
ExDocument インスタンスの画面上の表示 Y 座標を常に SWF ファイルエリアの中央とするかどうかを取得または設定します。 Acquire or set if the Y coordinate of the ExDocument instance to display, will be at the center of the SWF file area.
ExDocument
  centerX : int
[static] [read-only] ステージ中央の X 座標を取得します。 Get the center X coordinate of the stage.
ExDocument
  centerY : int
[static] [read-only] ステージ中央の Y 座標を取得します。 Get the center Y coordinate of the stage.
ExDocument
 Inheritedchildren : Array
[read-only] 子ディスプレイオブジェクトが保存されている配列です。 インデックス値が断続的に指定可能である為、getChildAt() ではなくこのプロパティを使用して子ディスプレイオブジェクト走査を行います。 この配列を操作することで元の配列を変更することはできません。 The array that saves child display objects.
ExMovieClip
 InheritedclassName : String
[read-only] インスタンスのクラス名を取得します。 Indicates the instance className of the IExDisplayObject.
ExMovieClip
  contentHeight : int
[static] [read-only] ロードされたファイルの規格高さです。 The height of the contents which loaded.
ExDocument
  contentWidth : int
[static] [read-only] ロードされたコンテンツの規格幅です。 The width of the contents which loaded.
ExDocument
  displayState : String
[static] 使用する表示状態を指定する StageDisplayState クラスの値です。 A value from the StageDisplayState class that specifies which display state to use.
ExDocument
  frameRate : Number
[static] ステージのフレームレートを取得または設定します。 Gets and sets the frame rate of the stage.
ExDocument
 Inheritedgroup : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the IExDisplayObject.
ExMovieClip
 Inheritedid : String
インスタンスの識別子を取得または設定します。 Indicates the instance id of the IExDisplayObject.
ExMovieClip
 InheritedisDragging : Boolean
[read-only] startDrag() メソッドを使用したドラッグ処理を行っている最中かどうかを取得します。 Returns if the drag process which uses startDrag() method is executing.
ExMovieClip
  isOnline : Boolean
[static] [read-only] SWF ファイルがオンライン上で実行されているかどうかを取得します。 Acquire if the SWF file is executed at online.
ExDocument
 InheritedisPlaying : Boolean
[read-only] ムービークリップのタイムライン内で再生ヘッドの移動処理が行われているかどうかを取得します。 Returns if the movement processing of the playback head is executing in the timeline of the MovieClip.
ExMovieClip
  left : int
[static] [read-only] ステージ左の X 座標を取得します。 Get the left X coordinate of the stage.
ExDocument
  loaderInfo : LoaderInfo
[static] [read-only] この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo インスタンスを返します。 Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
ExDocument
  quality : String
[static] Flash Player が使用するレンダリング品質を指定する StageQuality クラスの値です。 A value from the StageQuality class that specifies which rendering quality is used.
ExDocument
 Inheritedrepeat : Boolean
ムービークリップの再生ヘッドが最後のフレームに移動された後に、最初のフレームに戻って再生を続けるかどうかを取得または設定します。 Get or set if it returns to the first frame and continue playback when the playback head reach to the last frame.
ExMovieClip
  right : int
[static] [read-only] ステージ右の X 座標を取得します。 Get the right X coordinate of the stage.
ExDocument
  root : ExDocument
[static] [read-only] ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。 For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
ExDocument
  scaleMode : String
[static] 使用する拡大 / 縮小モードを指定する StageScaleMode クラスの値です。 A value from the StageScaleMode class that specifies which scale mode to use.
ExDocument
  stage : Stage
[static] [read-only] 表示オブジェクトのステージです。 The Stage of the display object.
ExDocument
  stageHeight : int
[static] ステージの現在の高さをピクセル単位で指定します。 The current height, in pixels, of the Stage.
ExDocument
  stageMinHeight : int
[static] ステージの最小高さをピクセル単位で指定します。 Specify the minimum height of the stage in pixels.
ExDocument
  stageMinWidth : int
[static] ステージの最小幅をピクセル単位で指定します。 Specify the minimum width of the stage in pixels.
ExDocument
  stageWidth : int
[static] ステージの現在の幅をピクセル単位で指定します。 Specifies the current width, in pixels, of the Stage.
ExDocument
  top : int
[static] [read-only] ステージ上の Y 座標を取得します。 Get the top Y coordinate of the stage.
ExDocument
  x : Number
[override] 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。 この値は centering プロパティが true に設定されている場合には変更できません。 Indicates the x coordinate of the DisplayObject instance based on the local coordinate of the parent DisplayObjectContainer.
ExDocument
  y : Number
[override] 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。 この値は centering プロパティが true に設定されている場合には変更できません。 Indicates the y coordinate of the DisplayObject instance based on the local coordinate of the parent DisplayObjectContainer.
ExDocument
Public Methods
 MethodDefined By
  
ExDocument()
新しい ExDocument インスタンスを作成します。 Creates a new ExDocument object.
ExDocument
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。 Adds a child DisplayObject instance to this DisplayObjectContainer instance.
ExMovieClip
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] この DisplayObjectContainer インスタンスの指定されたインデックス位置に子 DisplayObject インスタンスを追加します。 Adds a child DisplayObject instance to this DisplayObjectContainer instance.
ExMovieClip
 Inherited
addChildAtAbove(child:DisplayObject, index:int):DisplayObject
この DisplayObjectContainer インスタンスの指定されたインデックス位置に子 DisplayObject インスタンスを追加します。 Adds a child DisplayObject instance to this DisplayObjectContainer instance.
ExMovieClip
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification.
ExDocument
  
addExclusivelyEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーは、IEventIntegrator インスタンスの管理外となるため、removeEventListener() メソッドで削除した場合にも、restoreRemovedListeners() メソッドで再登録させることができません。 Register the event listener object into the EventIntegrator instance to get the event notification.
ExDocument
  
completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[static] EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。 Remove the listener from EventIntegrator instance.
ExDocument
 Inherited
contains(child:DisplayObject):Boolean
[override] 指定された表示オブジェクトが DisplayObjectContainer インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
ExMovieClip
  
dispatchEvent(event:Event):Boolean
[static] イベントをイベントフローに送出します。 Dispatches an event into the event flow.
ExDocument
 Inherited
getChildAt(index:int):DisplayObject
[override] 指定のインデックス位置にある子表示オブジェクトオブジェクトを返します。 Returns the child display object instance that exists at the specified index.
ExMovieClip
 Inherited
getChildByName(name:String):DisplayObject
[override] 指定された名前に一致する子表示オブジェクトを返します。 Returns the child display object that exists with the specified name.
ExMovieClip
 Inherited
getChildIndex(child:DisplayObject):int
[override] 子 DisplayObject インスタンスのインデックス位置を返します。 Returns the index position of a child DisplayObject instance.
ExMovieClip
 Inherited
getInstanceById(id:String):DisplayObject
指定された id と同じ値が設定されている IExDisplayObject インターフェイスを実装したインスタンスを返します。 Returns the instance implements the IExDisplayObject interface which is set the same value of the specified id.
ExMovieClip
 Inherited
getInstancesByGroup(group:String, sort:Boolean = false):Array
指定された group と同じ値を持つ IExDisplayObject インターフェイスを実装したインスタンスを含む配列を返します。 Returns the array contains the instance which implements the IExDisplayObject interface that has the same value of the specified group.
ExMovieClip
 Inherited
getInstancesByRegExp(fieldName:String, pattern:RegExp, sort:Boolean = false):Array
指定された fieldName が条件と一致する IExDisplayObject インターフェイスを実装したインスタンスを含む配列を返します。 Returns the array contains the instance which implements the IExDisplayObject interface that match the condition to the specified fieldName.
ExMovieClip
 Inherited
gotoAndPlay(frame:Object, scenes:String = null):void
[override] 指定されたフレームで SWF ファイルの再生を開始します。 Start the playback of the SWF file with the specified frame.
ExMovieClip
 Inherited
gotoAndStop(frame:Object, scenes:String = null):void
[override] このムービークリップの指定されたフレームに再生ヘッドを送り、そこで停止させます。 Set the palyback head to the specified frame of the MovieClip and stop at that point.
ExMovieClip
  
hasEventListener(type:String):Boolean
[static] EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
ExDocument
 Inherited
hasFrame(frame:*):Boolean
指定したフレームが存在しているかどうかを返します。 Returns if the specified frame exists.
ExMovieClip
 Inherited
nextFrame():void
[override] 次のフレームに再生ヘッドを送り、停止します。 Move the playback head to the next frame and stop at that point.
ExMovieClip
 Inherited
play():void
[override] ムービークリップのタイムライン内で再生ヘッドを移動します。 Moves the playback head in the timeline of the MovieClip.
ExMovieClip
 Inherited
prevFrame():void
[override] 直前のフレームに再生ヘッドを戻し、停止します。 Move the playback head to the previous frame and stop at that point.
ExMovieClip
 Inherited
removeAllChildren():void
DisplayObjectContainer に追加されている全ての子 DisplayObject インスタンスを削除します。 Removes the whole child DisplayObject instance added to the DisplayObjectContainer.
ExMovieClip
  
removeAllListeners(completely:Boolean = false):void
[static] addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。 完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。 Remove the whole event listener registered via addEventListener() method.
ExDocument
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] DisplayObjectContainer インスタンスの子リストから指定の DisplayObject インスタンスを削除します。 Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
ExMovieClip
 Inherited
removeChildAt(index:int):DisplayObject
[override] DisplayObjectContainer の子リストの指定されたインデックス位置から子 DisplayObject インスタンスを削除します。 Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
ExMovieClip
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[static] EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.
ExDocument
  
restoreRemovedListeners():void
[static] removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。 Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.
ExDocument
 Inherited
setChildIndex(child:DisplayObject, index:int):void
[override] 表示オブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing child in the display object container.
ExMovieClip
 Inherited
setChildIndexAbove(child:DisplayObject, index:int):void
表示オブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing child in the display object container.
ExMovieClip
 Inherited
setProperties(props:Object):DisplayObject
インスタンスに対して、複数のプロパティを一括設定します。 Setup the several instance properties.
ExMovieClip
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
[override] 指定されたスプライトをユーザーがドラッグできるようにします。 Allow the user to drag the specified sprite.
ExMovieClip
 Inherited
stop():void
[override] ムービークリップ内の再生ヘッドを停止します。 Stops the playback head in the MovieClip.
ExMovieClip
 Inherited
stopDrag():void
[override] startDrag() メソッドを終了します。 Ends the startDrag() method.
ExMovieClip
 Inherited
swapChildren(child1:DisplayObject, child2:DisplayObject):void
[override] 指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the two specified child objects.
ExMovieClip
 Inherited
swapChildrenAt(index1:int, index2:int):void
[override] 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
ExMovieClip
 Inherited
switchAtPlaying():void
ムービークリップの再生状態に応じて、再生もしくは停止します。 Playback or stops according to the playback state of the MovieClip.
ExMovieClip
 Inherited
toBitmapData(transparent:Boolean = true, fillColor:uint = 0xFFFFFFFF):BitmapData
指定されたオブジェクトの BitmapData 表現を返します。 Returns the BitmapData representation of the specified object.
ExMovieClip
 Inherited
toString():String
[override] 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
ExMovieClip
  
toSWFBasePath(url:String):String
[static] 指定された URL ストリングを SWF ファイルの設置されているフォルダを基準とした URL に変換して返します。 絶対パスが指定された場合には、そのまま返します。 Translate the specified URL string to the URL based on the folder where the SWF file is setting.
ExDocument
  
willTrigger(type:String):Boolean
[static] 指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
ExDocument
Events
 Event Summary Defined By
  
init
SWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に送出されます。 Dispatch when the SWF file completes to read and the stage and the loaderInfo becomes able to access.ExDocument
  
resizeComplete
ステージのリサイズを終了した場合に送出されます。 Dispatch when stage finish to resize.ExDocument
  
resizeProgress
ステージがリサイズ処理をしている場合に送出されます。 Dispatch if the stage is processing the resize operation.ExDocument
  
resizeStart
ステージのリサイズを開始した場合に送出されます。 Dispatch when start to resize the stage.ExDocument
Property Detail
alignproperty
align:String

Flash Player またはブラウザでのステージの配置を指定する StageAlign クラスの値です。 A value from the StageAlign class that specifies the alignment of the stage in Flash Player or the browser.


Implementation
    public static function get align():String
    public static function set align(value:String):void
bottomproperty 
bottom:int  [read-only]

ステージ下の Y 座標を取得します。 Get the bottom Y coordinate of the stage.


Implementation
    public static function get bottom():int
centeringXproperty 
centeringX:Boolean

ExDocument インスタンスの画面上の表示 X 座標を常に SWF ファイルエリアの中央とするかどうかを取得または設定します。 Acquire or set if the X coordinate of the ExDocument instance to display, will be at the center of the SWF file area.


Implementation
    public function get centeringX():Boolean
    public function set centeringX(value:Boolean):void
centeringYproperty 
centeringY:Boolean

ExDocument インスタンスの画面上の表示 Y 座標を常に SWF ファイルエリアの中央とするかどうかを取得または設定します。 Acquire or set if the Y coordinate of the ExDocument instance to display, will be at the center of the SWF file area.


Implementation
    public function get centeringY():Boolean
    public function set centeringY(value:Boolean):void
centerXproperty 
centerX:int  [read-only]

ステージ中央の X 座標を取得します。 Get the center X coordinate of the stage.


Implementation
    public static function get centerX():int
centerYproperty 
centerY:int  [read-only]

ステージ中央の Y 座標を取得します。 Get the center Y coordinate of the stage.


Implementation
    public static function get centerY():int
contentHeightproperty 
contentHeight:int  [read-only]

ロードされたファイルの規格高さです。 The height of the contents which loaded.


Implementation
    public static function get contentHeight():int
contentWidthproperty 
contentWidth:int  [read-only]

ロードされたコンテンツの規格幅です。 The width of the contents which loaded.


Implementation
    public static function get contentWidth():int
displayStateproperty 
displayState:String

使用する表示状態を指定する StageDisplayState クラスの値です。 A value from the StageDisplayState class that specifies which display state to use.


Implementation
    public static function get displayState():String
    public static function set displayState(value:String):void
frameRateproperty 
frameRate:Number

ステージのフレームレートを取得または設定します。 Gets and sets the frame rate of the stage.


Implementation
    public static function get frameRate():Number
    public static function set frameRate(value:Number):void
isOnlineproperty 
isOnline:Boolean  [read-only]

SWF ファイルがオンライン上で実行されているかどうかを取得します。 Acquire if the SWF file is executed at online.


Implementation
    public static function get isOnline():Boolean
leftproperty 
left:int  [read-only]

ステージ左の X 座標を取得します。 Get the left X coordinate of the stage.


Implementation
    public static function get left():int
loaderInfoproperty 
loaderInfo:LoaderInfo  [read-only]

この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo インスタンスを返します。 Returns a LoaderInfo object containing information about loading the file to which this display object belongs.


Implementation
    public static function get loaderInfo():LoaderInfo
qualityproperty 
quality:String

Flash Player が使用するレンダリング品質を指定する StageQuality クラスの値です。 A value from the StageQuality class that specifies which rendering quality is used.


Implementation
    public static function get quality():String
    public static function set quality(value:String):void
rightproperty 
right:int  [read-only]

ステージ右の X 座標を取得します。 Get the right X coordinate of the stage.


Implementation
    public static function get right():int
rootproperty 
root:ExDocument  [read-only]

ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。 For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.


Implementation
    public static function get root():ExDocument
scaleModeproperty 
scaleMode:String

使用する拡大 / 縮小モードを指定する StageScaleMode クラスの値です。 A value from the StageScaleMode class that specifies which scale mode to use.


Implementation
    public static function get scaleMode():String
    public static function set scaleMode(value:String):void
stageproperty 
stage:Stage  [read-only]

表示オブジェクトのステージです。 The Stage of the display object.


Implementation
    public static function get stage():Stage
stageHeightproperty 
stageHeight:int

ステージの現在の高さをピクセル単位で指定します。 The current height, in pixels, of the Stage.


Implementation
    public static function get stageHeight():int
    public static function set stageHeight(value:int):void
stageMinHeightproperty 
stageMinHeight:int

ステージの最小高さをピクセル単位で指定します。 Specify the minimum height of the stage in pixels.


Implementation
    public static function get stageMinHeight():int
    public static function set stageMinHeight(value:int):void
stageMinWidthproperty 
stageMinWidth:int

ステージの最小幅をピクセル単位で指定します。 Specify the minimum width of the stage in pixels.


Implementation
    public static function get stageMinWidth():int
    public static function set stageMinWidth(value:int):void
stageWidthproperty 
stageWidth:int

ステージの現在の幅をピクセル単位で指定します。 Specifies the current width, in pixels, of the Stage.


Implementation
    public static function get stageWidth():int
    public static function set stageWidth(value:int):void
topproperty 
top:int  [read-only]

ステージ上の Y 座標を取得します。 Get the top Y coordinate of the stage.


Implementation
    public static function get top():int
xproperty 
x:Number[override]

親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。 この値は centering プロパティが true に設定されている場合には変更できません。 Indicates the x coordinate of the DisplayObject instance based on the local coordinate of the parent DisplayObjectContainer. This value can not change in case the centering property is set to true.


Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number[override]

親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。 この値は centering プロパティが true に設定されている場合には変更できません。 Indicates the y coordinate of the DisplayObject instance based on the local coordinate of the parent DisplayObjectContainer. This value can not change in case the centering property is set to true.


Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor Detail
ExDocument()Constructor
public function ExDocument()

新しい ExDocument インスタンスを作成します。 Creates a new ExDocument object.

Method Detail
addEventListener()method
public static function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification. If the registered listener by this method removed by using removeEventListener() method, it can re-register using restoreRemovedListeners() method.

Parameters

type:String — イベントのタイプです。 The type of event.
 
listener:Function — イベントを処理するリスナー関数です。この関数は Event インスタンスを唯一のパラメータとして受け取り、何も返さないものである必要があります。関数は任意の名前を持つことができます。 The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing. The function can have any name.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。useCapture を true に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。useCapture を false に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、addEventListener を 2 回呼び出します。useCapture を true に設定して 1 度呼び出し、useCapture を false に設定してもう一度呼び出します。 Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。優先度は、符号付き 32 ビット整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n -1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。 The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。 Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

addExclusivelyEventListener()method 
public static function addExclusivelyEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーは、IEventIntegrator インスタンスの管理外となるため、removeEventListener() メソッドで削除した場合にも、restoreRemovedListeners() メソッドで再登録させることができません。 Register the event listener object into the EventIntegrator instance to get the event notification. The listener registered by this method can not re-registered by using restoreRemovedListeners() method in case it is removed by using removeEventListener() method, because it is not managed by IEventIntegrator instance

Parameters

type:String — イベントのタイプです。 The type of event.
 
listener:Function — イベントを処理するリスナー関数です。この関数は Event インスタンスを唯一のパラメータとして受け取り、何も返さないものである必要があります。関数は任意の名前を持つことができます。 The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing. The function can have any name.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。useCapture を true に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。useCapture を false に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、addEventListener を 2 回呼び出します。useCapture を true に設定して 1 度呼び出し、useCapture を false に設定してもう一度呼び出します。 Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。優先度は、符号付き 32 ビット整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n -1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。 The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。 Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

completelyRemoveEventListener()method 
public static function completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void

EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。 Remove the listener from EventIntegrator instance. The listener removed by using this method can not re-register by restoreRemovedListeners() method.

Parameters

type:String — イベントのタイプです。 The type of event.
 
listener:Function — 削除するリスナーオブジェクトです。 The listener object to remove.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、removeEventListener() を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は useCapture() を true に設定し、もう 1 回は useCapture() を false に設定する必要があります。 Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.

dispatchEvent()method 
public static function dispatchEvent(event:Event):Boolean

イベントをイベントフローに送出します。 Dispatches an event into the event flow.

Parameters

event:Event — イベントフローに送出されるイベントオブジェクトです。イベントが再度送出されると、イベントのクローンが自動的に作成されます。イベントが送出された後にそのイベントの target プロパティは変更できないため、再送出処理のためにはイベントの新しいコピーを作成する必要があります。 The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns
Boolean — 値が true の場合、イベントは正常に送出されました。値が false の場合、イベントの送出に失敗したか、イベントで preventDefault() が呼び出されたことを示しています。 A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.
hasEventListener()method 
public static function hasEventListener(type:String):Boolean

EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.

Parameters

type:String — イベントのタイプです。 The type of event.

Returns
Boolean — 指定したタイプのリスナーが登録されている場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type is registered; false otherwise.
removeAllListeners()method 
public static function removeAllListeners(completely:Boolean = false):void

addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。 完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。 Remove the whole event listener registered via addEventListener() method. If do not remove completely, removed event listener can restore by restoreRemovedListeners() method.

Parameters

completely:Boolean (default = false) — 情報を完全に削除するかどうかです。

removeEventListener()method 
public static function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance. The listener removed by using this method can re-register by restoreRemovedListeners() method.

Parameters

type:String — イベントのタイプです。 The type of event.
 
listener:Function — 削除するリスナーオブジェクトです。 The listener object to remove.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、removeEventListener() を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は useCapture() を true に設定し、もう 1 回は useCapture() を false に設定する必要があります。 Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.

restoreRemovedListeners()method 
public static function restoreRemovedListeners():void

removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。 Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.

toSWFBasePath()method 
public static function toSWFBasePath(url:String):String

指定された URL ストリングを SWF ファイルの設置されているフォルダを基準とした URL に変換して返します。 絶対パスが指定された場合には、そのまま返します。 Translate the specified URL string to the URL based on the folder where the SWF file is setting. In case it specified the absolute path, it will return as is.

Parameters

url:String — 変換したい URL のストリング表現です。 The URL string representation to translate.

Returns
String — 変換された URL のストリング表現です。 The URL string representation which translated.
willTrigger()method 
public static function willTrigger(type:String):Boolean

指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.

Parameters

type:String — イベントのタイプです。 The type of event.

Returns
Boolean — 指定したタイプのリスナーがトリガされた場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type will be triggered; false otherwise.
Event Detail
init Event
Event Object Type: jp.nium.events.DocumentEvent
DocumentEvent.type property = jp.nium.events.DocumentEvent.INIT

SWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に送出されます。 Dispatch when the SWF file completes to read and the stage and the loaderInfo becomes able to access.

init イベントオブジェクトの type プロパティ値を定義します。 The DocumentEvent.INIT constant defines the value of the type property of an init event object.
resizeComplete Event  
Event Object Type: jp.nium.events.DocumentEvent
DocumentEvent.type property = jp.nium.events.DocumentEvent.RESIZE_COMPLETE

ステージのリサイズを終了した場合に送出されます。 Dispatch when stage finish to resize.

resizeComplete イベントオブジェクトの type プロパティ値を定義します。 The DocumentEvent.RESIZE_COMPLETE constant defines the value of the type property of an resizeComplete event object.
resizeProgress Event  
Event Object Type: jp.nium.events.DocumentEvent
DocumentEvent.type property = jp.nium.events.DocumentEvent.RESIZE_PROGRESS

ステージがリサイズ処理をしている場合に送出されます。 Dispatch if the stage is processing the resize operation.

resizeProgress イベントオブジェクトの type プロパティ値を定義します。 The DocumentEvent.RESIZE_PROGRESS constant defines the value of the type property of an resizeProgress event object.
resizeStart Event  
Event Object Type: jp.nium.events.DocumentEvent
DocumentEvent.type property = jp.nium.events.DocumentEvent.RESIZE_START

ステージのリサイズを開始した場合に送出されます。 Dispatch when start to resize the stage.

resizeStart イベントオブジェクトの type プロパティ値を定義します。 The DocumentEvent.RESIZE_START constant defines the value of the type property of an resizeStart event object.
Examples



Copyright (C) 2007-2010 taka:nium.jp