MouseEvent  - AS3

Alt キーがアクティブになっているか（true）非アクティブになっているか（false）を示します。Windows でのみサポートされます。他のオペレーティングシステムでは、このプロパティは常に false に設定されます。

マウスの主ボタンが押されているか（true）押されていないか（false）を示します。

マウスダウンイベントがマルチクリックシーケンスの一部かどうかを示します。 このパラメーターは、MouseEvent.mouseDown、MouseEvent.mouseUp、MouseEvent.middleMouseDown、MouseEvent.middleMouseUp、MouseEvent.rightMouseDown および MouseEvent.rightMouseUp 以外のマウスイベントでは 0 になります。 シングルクリック、ダブルクリックまたは任意のマルチクリックシーケンスを監視するには、clickCount パラメーターを使用します。 例えば、最初の MouseEvent.mouseDown と MouseEvent.mouseUp の clickCount は 1 で、ダブルクリックシーケンスでの 2 番目の MouseEvent.mouseDown と MouseEvent.mouseUp の clickCount は 2 になります。 マウスが十分に移動した場合、または何らかの理由でマルチクリックシーケンスが妨げられた場合、次の MouseEvent.mouseDown の clickCount は 1 になります。 doubleClick イベントは引き続き期待どおりに発生します。

command キーがアクティブになっているかどうかを示します（Macintosh のみ）。

Macintish では、commandKey プロパティの値は ctrlKey プロパティの値と同じです。 Windows または Linux では常に false です。

Mac で Control キーがアクティブになっているか、および Windows や Linux で Ctrl キーがアクティブになっているかどうかを示します。

Windows または Linux で、Ctrl キーがアクティブ（true）か非アクティブ（false）かを示します。Macintosh では、Control キーと Command キーのいずれがアクティブになっているかどうかを示します。

ユーザーがマウスホイールを 1 目盛り回すごとにスクロールする行数を示します。正の delta 値は上方向へのスクロールを表します。負の値は下方向へのスクロールを表します。一般的な値は 1 ～ 3 の範囲ですが、ホイールの回転が速くなると、delta の値は大きくなります。この設定は、デバイスやオペレーティングシステムによって異なります。通常はユーザーが構成できます。このプロパティは、MouseEvent.mouseWheel イベントにのみ適用されます。

true の場合、relatedObject プロパティは、セキュリティサンドボックスに関連する理由により、null に設定されます。relatedObject の公称値が別のサンドボックスにある DisplayObject への参照である場合、このサンドボックスの境界をまたいで両方向に権限がある場合を除いては、relatedObject は null に設定されます。権限を確立するには、SWF ファイルから Security.allowDomain() を呼び出すか、イメージファイルのサーバーからポリシーファイルを提供し、LoaderContext.checkPolicyFile プロパティを設定してイメージを読み込みます。

関連する API エレメント

マウスロックが無効になっているときにイベントが発生する位置の、スプライトを基準とする水平座標です。マウスロックを無効にするには、Stage.mouseLock を false に設定します。

マウスロックが有効になっているとき、localX および localY は 0 です。マウスロックが有効になっているときマウス位置の移動量を調べるには、movementX および movementY を使用します。

関連する API エレメント

マウスロックが無効になっているときにイベントが発生する位置の、スプライトを基準とする垂直座標です。マウスロックを無効にするには、Stage.mouseLock を false に設定します。

マウスロックが有効になっているとき、localX および localY は 0 です。マウスロックが有効になっているときマウス位置の移動量を調べるには、movementX および movementY を使用します。

関連する API エレメント

マウスロックが有効になっているときに、マウス位置の X 方向について、前回のマウスイベント時点からの移動量を示します。マウスロックを有効にするには、Stage.mouseLock を true に設定します。

マウスロックが有効になっているとき、各種のプロパティは次のようになります。

• localX および localY には 0 が設定されます。
• movementX および movementY には変化量の値が設定されます。
• ステージの変換に基づいて movementX および movementY が変換されることは、決してありません。つまり、これらの値は常にスクリーン座標に基づきます。

Stage.mouseLock が false の場合、movementX および movementY は 0 です。

関連する API エレメント

マウスロックが有効になっているときに、マウス位置の Y 方向について、前回のマウスイベント時点からの移動量を示します。マウスロックを有効にするには、Stage.mouseLock を true に設定します。

マウスロックが有効になっているとき、各種のプロパティは次のようになります。

• localX および localY には 0 が設定されます。
• movementX および movementY には変化量の値が設定されます。
• ステージの変換に基づいて movementX および movementY が変換されることは、決してありません。つまり、これらの値は常にスクリーン座標に基づきます。

Stage.mouseLock が false の場合、movementX および movementY は 0 です。

関連する API エレメント

イベントに関連する表示リストオブジェクトへの参照です。例えば、mouseOut イベントが発生した場合、relatedObject はポインティングデバイスが現在指している表示リストオブジェクトを表します。このプロパティは、mouseOut、mouseOver、rollOut および rollOver の各イベントにのみ適用されます。

このプロパティの値は、関連オブジェクトがない場合、または関連オブジェクトはあるがアクセスできないセキュリティサンドボックスの中にある場合の 2 つの状況の場合に、null になる可能性があります。isRelatedObjectInaccessible() プロパティを使用して、どの理由が適用されるかを判別します。

関連する API エレメント

Shift キーがアクティブになっているか（true）非アクティブになっているか（false）を示します。

グローバルステージ座標を基準とするイベント発生位置の水平座標です。このプロパティは、localX プロパティが設定されている場合に計算されます。

グローバルステージ座標を基準とするイベント発生位置の垂直座標です。このプロパティは、localY プロパティが設定されている場合に計算されます。

マウスイベントに関する情報を含む Event オブジェクトを作成します。イベントリスナーには Event オブジェクトがパラメーターとして渡されます。

MouseEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。

MouseEvent オブジェクトのすべてのプロパティを含むストリングを返します。ストリングは次の形式です。

[MouseEvent type= value bubbles= value cancelable= value ... delta= value ]

表示リストが変更されている場合、このイベントの処理が終了した後にレンダリングするよう Flash Player または Adobe AIR に指示します。

type プロパティ（click イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

MouseEvent.CONTEXT_MENU 定数は、type プロパティ（contextMenu イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

type プロパティ（doubleClick イベントオブジェクト）の値を定義します。doubleClickEnabled プロパティは、true である必要があります（オブジェクトで doubleClick イベントを生成する場合）。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（middleClick イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（middleMouseDown イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（middleMouseUp イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（mouseDown イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（mouseMove イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

package {
    import flash.display.Sprite;
    import flash.display.Graphics;
    import flash.events.MouseEvent;

    public class MouseEvent_MOUSE_MOVEExample extends Sprite {
        private var innerRect:Sprite = new Sprite();
        
        public function MouseEvent_MOUSE_MOVEExample() {

            graphics.lineStyle(3, 0xFF0000, 1);
            stage.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
            stage.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);

            innerRect.graphics.lineStyle(1, 0x00FF00, 1);
            innerRect.graphics.beginFill(0xFFFFFF);
            innerRect.graphics.drawRect(10, 10, 200, 200);
            innerRect.graphics.endFill();
            innerRect.addEventListener(MouseEvent.MOUSE_DOWN, innerRectMouseDownHandler);
            innerRect.addEventListener(MouseEvent.MOUSE_UP, innerRectMouseUpHandler);
            addChild(innerRect);
        }

        private function mouseDownHandler(event:MouseEvent):void {
            graphics.moveTo(event.stageX, event.stageY);
            stage.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        }
    
        private function mouseMoveHandler(event:MouseEvent):void {
            graphics.lineTo(event.stageX, event.stageY);
        }    
    
        private function mouseUpHandler(event:MouseEvent):void {
            stage.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        }

        private function innerRectMouseDownHandler(event:MouseEvent):void {
            innerRect.graphics.moveTo(event.localX, event.localY);
            innerRect.addEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
        }
    
        private function innerRectMouseMoveHandler(event:MouseEvent):void {
            innerRect.graphics.lineTo(event.localX, event.localY);
        }    
    
        private function innerRectMouseUpHandler(event:MouseEvent):void {
            innerRect.removeEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
        }
    }
}

type プロパティ（mouseOut イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（mouseOver イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（mouseUp イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（mouseWheel イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

releaseOutside イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（rightClick イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（rightMouseDown イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（rightMouseUp イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（rollOut イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

type プロパティ（rollOver イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

関連する API エレメント

1. 後で四角形の描画に使用するサイズ（100 × 100 ピクセル）と背景色（オレンジ色）のプロパティを宣言します。
2. コンストラクターが新しい ChildSprite オブジェクト child を作成します。コンストラクターは、draw() メソッドを呼び出して、オレンジ色の 100 × 100 ピクセルの四角形を (0,0) の座標に描画し、次に 7 つのイベントリスナーとサブスクライバを追加します。
   • click/clickHandler()：四角形の上で左マウスボタンがクリックされたときに送出されます。
   • doubleClick/doubleClickHandler()：四角形の上で左マウスボタンがダブルクリックされたときに送出されます。
   • mouseDown/mouseDownHandler()：ChildSprite オブジェクト（オレンジ色の四角形）がクリックされると、trace() メッセージが画面に表示されます。次に、ChildSprite.draw() が呼び出されて、mouseOverHandler() で描画された明るい青色の四角形の位置に暗い黄色の四角形を描画します。また、mouseDownHandler() メソッドによって mouseMove イベントリスナーと mouseMoveHandler() サブスクライバ（後で説明）が追加されます。これによって、マウスの移動が処理されます。次に startDrag() メソッドが呼び出されます。これによって Sprite オブジェクトのドラッグが可能になります。
   • mouseOut/mouseOutHandler()：ポインターが四角形の領域を離れると送出されます。draw() メソッドによって、四角形のサイズとカラーを通常の状態に戻します。
   • mouseOver/mouseOverHandler()：マウスポインターが四角形に重なると送出されます。このメソッドは、暗い黄色の背景色で四角形を大きく再描画します。
   • mouseUp/mouseUpHandler()：ユーザーがマウスボタンを離すと、mouseMove イベントリスナーが削除され、stopDrag が呼び出されます。これによって、四角形の位置が固定されます。
   • mouseMove/mouseMoveHandler()：mouseDownHandler() 関数の一部として呼び出され、ユーザーがマウス左ボタンを押しながら四角形をドラッグすると送出されます。
   • mouseWheel/mouseWheelHandler()：四角形の上でマウスホイールを回転させるたびに送出されます。
3. ChildSprite インスタンス child が、addChild() を使用して表示リストに追加され、オレンジ色の四角形が直ちに描画されます。

注意：

• MouseEventExample クラスは、ドキュメントルートにあることが必要です。
• 前述したイベントメソッドの中には、ローカル変数 sprite を宣言するものがあります。この変数には、Sprite 型への event.target のキャストが割り当てられます。

package {
    import flash.display.Sprite;

    public class MouseEventExample extends Sprite {
        private var size:uint = 100;
        private var bgColor:uint = 0xFFCC00;

        public function MouseEventExample() {
            var child:ChildSprite = new ChildSprite();
            addChild(child);
        }
    }
}

import flash.display.Sprite;
import flash.events.MouseEvent;

class ChildSprite extends Sprite {
    private var size:uint = 50;
    private var overSize:uint = 60;
    private var backgroundColor:uint = 0xFFCC00;
    private var overColor:uint = 0xCCFF00;
    private var downColor:uint = 0x00CCFF;

    public function ChildSprite() {
        draw(size, size, backgroundColor);
            doubleClickEnabled = true;
        addEventListener(MouseEvent.CLICK, clickHandler);
        addEventListener(MouseEvent.DOUBLE_CLICK, doubleClickHandler);
        addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
        addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
        addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
        addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
        addEventListener(MouseEvent.MOUSE_WHEEL, mouseWheelHandler);
    }

    private function draw(w:uint, h:uint, bgColor:uint):void {
        graphics.clear();
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, w, h);
        graphics.endFill();
    }

    private function clickHandler(event:MouseEvent):void {
        trace("clickHandler");
    }

    private function doubleClickHandler(event:MouseEvent):void {
        trace("doubleClickHandler");
    }

    private function mouseDownHandler(event:MouseEvent):void {
        trace("mouseDownHandler");
        draw(overSize, overSize, downColor);

        var sprite:Sprite = Sprite(event.target);
        sprite.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        sprite.startDrag();
    }

    private function mouseMoveHandler(event:MouseEvent):void {
        trace("mouseMoveHandler");
        event.updateAfterEvent();
    }

    private function mouseOutHandler(event:MouseEvent):void {
        trace("mouseOutHandler");
        draw(size, size, backgroundColor);
    }

    private function mouseOverHandler(event:MouseEvent):void {
        trace("mouseOverHandler");
        draw(overSize, overSize, overColor);
    }

    private function mouseWheelHandler(event:MouseEvent):void {
        trace("mouseWheelHandler delta: " + event.delta);
    }

    private function mouseUpHandler(event:MouseEvent):void {
        trace("mouseUpHandler");
        var sprite:Sprite = Sprite(event.target);
        sprite.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        sprite.stopDrag();
        draw(overSize, overSize, overColor);
    }
}