パッケージflash.display
public class SimpleButton
継承SimpleButton Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
SubclassesFlexSimpleButton

SimpleButton クラスを使用すると、SWF ファイル内のボタンシンボルのすべてのインスタンスを制御することができます。オーサリングツール内のボタンのインスタンスを作成した後は、SimpleButton クラスのメソッドとプロパティを使用して、ActionScript でボタンを操作できます。

プロパティインスペクタでもボタンにインスタンス名を付けることができます。SimpleButton インスタンスの名前は、ムービーエクスプローラに表示されます。[アクション] パネルの [ターゲットパスの挿入] ダイアログボックスにも表示されます。

ActionScript 3.0 では、new SimpleButton() コンストラクタを使用して次のように SimpleButton インスタンスを作成することもできます。

 var myButton:SimpleButton = new SimpleButton();
 var downSprite:Sprite = new Sprite();
 downSprite.graphics.lineStyle(2, 0x202020);
 downSprite.graphics.beginFill(0x00FF00);
 downSprite.graphics.drawRect(10, 10, 50, 50);
 
 var upSprite:Sprite = new Sprite();
 upSprite.graphics.lineStyle(2, 0x202020);
 upSprite.graphics.beginFill(0xFFFF00);
 upSprite.graphics.drawRect(10, 10, 50, 50);
 
 myButton.upState = upSprite;
 myButton.overState = upSprite;
 myButton.downState = downSprite;
 myButton.useHandCursor = true;
 myButton.hitTestState = upSprite;
 
 this.addChild(myButton);
 

SimpleButton クラスは、InteractiveObject クラスから継承します。

例の表示

関連項目

InteractiveObject class
表示アーキテクチャについて
SimpleButton オブジェクトの操作


パブリックプロパティ
 プロパティ定義
 InheritedaccessibilityProperties : AccessibilityProperties
この表示オブジェクトの現在のアクセシビリティオプションです。
DisplayObject
 Inheritedalpha : Number
指定されたオブジェクトのアルファ透明度値を示します。
DisplayObject
 InheritedblendMode : String
使用するブレンドモードを指定する BlendMode クラスの値です。
DisplayObject
 InheritedcacheAsBitmap : Boolean
true に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player にキャッシュされます。
DisplayObject
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcontextMenu : ContextMenu
このオブジェクトに関連付けられたコンテキストメニューを指定します。
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
オブジェクトが doubleClick イベントを受け取るかどうかを指定します。
InteractiveObject
  downState : DisplayObject
ボタンの "ダウン" 状態用のビジュアルオブジェクトとして使用される表示オブジェクトを指定します。ダウン状態とは、ユーザーが hitTestState オブジェクトをクリックしたときのボタンの状態です。
SimpleButton
  enabled : Boolean
ボタンが有効であるか無効であるかを指定するブール値です。
SimpleButton
 Inheritedfilters : Array
表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。
DisplayObject
 InheritedfocusRect : Object
このオブジェクトがフォーカス矩形を表示するかどうかを指定します。
InteractiveObject
 Inheritedheight : Number
表示オブジェクトの高さを示します (ピクセル単位)。
DisplayObject
  hitTestState : DisplayObject
ボタンのヒットテストオブジェクトとして使用する表示オブジェクトを指定します。
SimpleButton
 InheritedloaderInfo : LoaderInfo
この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo オブジェクトを返します。
DisplayObject
 Inheritedmask : DisplayObject
呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
DisplayObject
 InheritedmouseEnabled : Boolean
このオブジェクトがマウスメッセージを受け取るかどうかを指定します。
InteractiveObject
 InheritedmouseX : Number
マウス位置の x 座標を示します (ピクセル単位)。
DisplayObject
 InheritedmouseY : Number
マウス位置の y 座標を示します (ピクセル単位)。
DisplayObject
 Inheritedname : String
DisplayObject のインスタンス名を示します。
DisplayObject
 InheritedopaqueBackground : Object
表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。
DisplayObject
  overState : DisplayObject
ボタンのオーバー状態用のビジュアルオブジェクトとして使用される表示オブジェクトを指定します。オーバー状態とは、ボタンの上にマウスポインタが置かれている状態のことです。
SimpleButton
 Inheritedparent : DisplayObjectContainer
この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
DisplayObject
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedroot : DisplayObject
ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。
DisplayObject
 Inheritedrotation : Number
DisplayObject インスタンスの元の位置からの回転角を度単位で示します。
DisplayObject
 Inheritedscale9Grid : Rectangle
現在有効な拡大 / 縮小グリッドです。
DisplayObject
 InheritedscaleX : Number
基準点から適用されるオブジェクトの水平スケール (percentage) を示します。
DisplayObject
 InheritedscaleY : Number
オブジェクトの基準点から適用されるオブジェクトの垂直スケール (percentage) を示します。
DisplayObject
 InheritedscrollRect : Rectangle
表示オブジェクトのスクロール矩形の境界。
DisplayObject
  soundTransform : SoundTransform
このボタンに割り当てられた SoundTransform オブジェクト。
SimpleButton
 Inheritedstage : Stage
表示オブジェクトのステージ。
DisplayObject
 InheritedtabEnabled : Boolean
このオブジェクトがタブ順序序に含まれるかどうかを指定します。
InteractiveObject
 InheritedtabIndex : int
SWF ファイル内のオブジェクトのタブ順序を指定します。
InteractiveObject
  trackAsMenu : Boolean
SimpleButton または MovieClip オブジェクトである他の表示オブジェクトがマウス解放イベントを受け取ることができるかどうかを示します。
SimpleButton
 Inheritedtransform : Transform
表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクトです。
DisplayObject
  upState : DisplayObject
ボタンのアップ状態用のビジュアルオブジェクトとして使用される表示オブジェクトを指定します。アップ状態とは、ボタンの上にマウスポインタが置かれていない状態のことです。
SimpleButton
  useHandCursor : Boolean
マウスがボタン上に移動したときに、ハンドカーソルを表示するかどうかを示すブール値です。true に設定されると、ハンドカーソルを表示します。
SimpleButton
 Inheritedvisible : Boolean
表示オブジェクトが可視かどうかを示します。
DisplayObject
 Inheritedwidth : Number
表示オブジェクトの幅を示します (ピクセル単位)。
DisplayObject
 Inheritedx : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。
DisplayObject
 Inheritedy : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。
DisplayObject
パブリックメソッド
 メソッド定義
  SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
新しい SimpleButton インスタンスを作成します。
SimpleButton
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 InheritedgetBounds(targetCoordinateSpace:DisplayObject):Rectangle
targetCoordinateSpace オブジェクトの座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。
DisplayObject
 InheritedgetRect(targetCoordinateSpace:DisplayObject):Rectangle
シェイプ上の線を除き、targetCoordinateSpace パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。
DisplayObject
 InheritedglobalToLocal(point:Point):Point
point オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。
DisplayObject
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedhitTestObject(obj:DisplayObject):Boolean
表示オブジェクトを評価して、obj 表示オブジェクトと重複または交差するかどうかを調べます。
DisplayObject
 InheritedhitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。
DisplayObject
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedlocalToGlobal(point:Point):Point
point オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。
DisplayObject
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント一覧定義
 Inheritedactivate Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。DisplayObject
 Inheritedadded 表示オブジェクトが表示リストに追加されたときに送出されます。DisplayObject
 Inheritedclick ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを押して離すと送出されます。InteractiveObject
 Inheriteddeactivate Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。DisplayObject
 InheriteddoubleClick オブジェクトの doubleClickEnabled フラグが true に設定されている場合には、ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを 2 回続けてすばやく押して離すと送出されます。InteractiveObject
 InheritedenterFrame 再生ヘッドが新しいフレームに入るときに送出されます。DisplayObject
 InheritedfocusIn 表示オブジェクトがフォーカスを取得した後に送出されます。InteractiveObject
 InheritedfocusOut 表示オブジェクトがフォーカスを失った後に送出されます。InteractiveObject
 InheritedkeyDown ユーザーがキーを押したときに送出されます。InteractiveObject
 InheritedkeyFocusChange ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。InteractiveObject
 InheritedkeyUp ユーザーがキーを離したときに送出されます。InteractiveObject
 InheritedmouseDown Flash Player ウィンドウの InteractiveObject インスタンスの上で、ユーザーがポインティングデバイスのボタンを押したときに送出されます。InteractiveObject
 InheritedmouseFocusChange ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。InteractiveObject
 InheritedmouseMove InteractiveObject の上で、ユーザーがポインティングデバイスを動かしたときに送出されます。InteractiveObject
 InheritedmouseOut ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 InheritedmouseOver ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスに、ポインティングデバイスを合わせたときに送出されます。InteractiveObject
 InheritedmouseUp ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスの上でポインティングデバイスのボタンを離したときに送出されます。InteractiveObject
 InheritedmouseWheel Flash Player ウィンドウの InteractiveObject インスタンスの上で、マウスホイールを回転させたときに送出されます。InteractiveObject
 Inheritedremoved 表示オブジェクトが表示リストから削除されようとしているときに送出されます。DisplayObject
 Inheritedrender 表示リストが更新およびレンダリングされようとしているときに送出されます。DisplayObject
 InheritedrollOut ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 InheritedrollOver ユーザーが InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。InteractiveObject
 InheritedtabChildrenChange オブジェクトの tabChildren フラグの値が変更されたときに送出されます。InteractiveObject
 InheritedtabEnabledChange オブジェクトの tabEnabled フラグが変更されたときに送出されます。InteractiveObject
 InheritedtabIndexChange オブジェクトの tabIndex プロパティの値が変更されたときに送出されます。InteractiveObject
プロパティの詳細
downStateプロパティ
downState:DisplayObject  [read-write]

ボタンの "ダウン" 状態用のビジュアルオブジェクトとして使用される表示オブジェクトを指定します。ダウン状態とは、ユーザーが hitTestState オブジェクトをクリックしたときのボタンの状態です。

実装
    public function get downState():DisplayObject
    public function set downState(value:DisplayObject):void

関連項目

enabledプロパティ 
enabled:Boolean  [read-write]

ボタンが有効であるか無効であるかを指定するブール値です。ボタンが無効になっているとき (enabled プロパティが false に設定されているとき)、ボタンは表示されますが、クリックできません。デフォルト値は true です。このプロパティは、ナビゲーションの一部を無効にする場合に便利です。たとえば、現在表示されているページのボタンを無効にしてクリックできないようにすることで、ページのリロードを禁止できます。

実装
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
hitTestStateプロパティ 
hitTestState:DisplayObject  [read-write]

ボタンのヒットテストオブジェクトとして使用する表示オブジェクトを指定します。基本的なボタンでは、hitTestState プロパティを overState プロパティと同じ表示オブジェクトに設定します。hitTestState プロパティを設定しない場合、SimpleButton は非アクティブになります。つまり、マウスイベントやキーボードイベントに反応しません。

実装
    public function get hitTestState():DisplayObject
    public function set hitTestState(value:DisplayObject):void

関連項目

overStateプロパティ 
overState:DisplayObject  [read-write]

ボタンのオーバー状態用のビジュアルオブジェクトとして使用される表示オブジェクトを指定します。オーバー状態とは、ボタンの上にマウスポインタが置かれている状態のことです。

実装
    public function get overState():DisplayObject
    public function set overState(value:DisplayObject):void

関連項目

soundTransformプロパティ 
soundTransform:SoundTransform  [read-write]

このボタンに割り当てられた SoundTransform オブジェクト。SoundTransform オブジェクトには、ボリューム、パン、左スピーカーの割り当て、および右スピーカーの割り当てを設定するプロパティが含まれます。この SoundTransform オブジェクトはボタンのすべての状態に適用されます。この SoundTransform オブジェクトは埋め込みサウンドのみに影響します。

実装
    public function get soundTransform():SoundTransform
    public function set soundTransform(value:SoundTransform):void

関連項目

trackAsMenuプロパティ 
trackAsMenu:Boolean  [read-write]

SimpleButton または MovieClip オブジェクトである他の表示オブジェクトがマウス解放イベントを受け取ることができるかどうかを示します。trackAsMenu プロパティを使用してメニューを作成できます。trackAsMenu プロパティは、任意の SimpleButton または MovieClip オブジェクトに対して設定できます。trackAsMenu プロパティがない場合、デフォルトの動作は false です。

trackAsMenu プロパティは必要に応じていつでも変更できます。変更は即座に反映されます。

実装
    public function get trackAsMenu():Boolean
    public function set trackAsMenu(value:Boolean):void
upStateプロパティ 
upState:DisplayObject  [read-write]

ボタンのアップ状態用のビジュアルオブジェクトとして使用される表示オブジェクトを指定します。アップ状態とは、ボタンの上にマウスポインタが置かれていない状態のことです。

実装
    public function get upState():DisplayObject
    public function set upState(value:DisplayObject):void

関連項目

useHandCursorプロパティ 
useHandCursor:Boolean  [read-write]

マウスがボタン上に移動したときに、ハンドカーソルを表示するかどうかを示すブール値です。true に設定されると、ハンドカーソルを表示します。このプロパティを false に設定すると、代わりに矢印カーソルが表示されます。デフォルト値は true です。

useHandCursor プロパティは必要に応じていつでも変更できます。変更されたボタンでは新しいカーソルの動作が即座に使用されます。

実装
    public function get useHandCursor():Boolean
    public function set useHandCursor(value:Boolean):void
コンストラクタの詳細
SimpleButton()コンストラクタ
public 関数 SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)

新しい SimpleButton インスタンスを作成します。さまざまなボタンの状態を表す表示オブジェクトのいずれかまたはすべてを、コンストラクタ内のパラメータとして設定することができます。

パラメータ
upState:DisplayObject (default = null) — SimpleButton のアップ状態用の初期値です。
 
overState:DisplayObject (default = null) — SimpleButton のオーバー状態用の初期値です。
 
downState:DisplayObject (default = null) — SimpleButton のダウン状態用の初期値です。
 
hitTestState:DisplayObject (default = null) — SimpleButton の hitTest 状態用の初期値です。

次の例では、SimpleButtonExample クラスを使用します。 これは、CustomSimpleButton クラスを使用し、次にこのクラスは 4 つの ButtonDisplayState オブジェクトをインスタンス化します。その結果として作成されるボタンは、 形状が四角形で、背景色がマウスの状態に応じて変わります。これは、 SimpleButton クラスのプロパティをオーバーライドすることによって行われます。ここでは以下の手順を実行します。
  1. SimpleButtonExample() コンストラクタで、button という タイプ SimpleButton の CustomSimpleButton オブジェクトが作成されます。これは、CustomSimpleButton コンストラクタ メソッドを呼び出します。button オブジェクトが表示リストに追加されます。ボタンの色とサイズは 次の手順で決定されます。
  2. CustomSimpleButton クラスで、インスタンスのプロパティが宣言されます。これらは、後に button のサイズと背景色を制御するために使われます。その制御は、ボタンの状態に基づいて行われ、 通常の状態ではオレンジ、マウスポインタが置かれた状態では暗い黄色、マウスボタンが押された状態では明るい青色になります。 button がどの状態にあるときでも、四角形のサイズは 80 ピクセルに設定されます。この設定は、 size プロパティを使用して行われます。
  3. CustomSimpleButton クラスのコンストラクタ関数では、 downState, overState, upState, hitTestState、および useHandCursor のプロパティに、 ButtonDisplayState クラスの 4 つのインスタンスを設定します。
  4. ButtonDisplayState クラスのコンストラクタでは、四角形のサイズと 背景色の値を設定し、draw() メソッドを呼び出します。
  5. draw() メソッドは、ボタンの状態に基づき、コンストラクタで設定された サイズと背景色で四角形を再描画します。
package {
    import flash.display.Sprite;

    public class SimpleButtonExample extends Sprite {
        public function SimpleButtonExample() {
            var button:CustomSimpleButton = new CustomSimpleButton();
            addChild(button);
        }
    }
}

import flash.display.DisplayObject;
import flash.display.Shape;
import flash.display.SimpleButton;

class CustomSimpleButton extends SimpleButton {
    private var upColor:uint   = 0xFFCC00;
    private var overColor:uint = 0xCCFF00;
    private var downColor:uint = 0x00CCFF;
    private var size:uint      = 80;

    public function CustomSimpleButton() {
        downState      = new ButtonDisplayState(downColor, size);
        overState      = new ButtonDisplayState(overColor, size);
        upState        = new ButtonDisplayState(upColor, size);
        hitTestState   = new ButtonDisplayState(upColor, size * 2);
        hitTestState.x = -(size / 4);
        hitTestState.y = hitTestState.x;
        useHandCursor  = true;
    }
}

class ButtonDisplayState extends Shape {
    private var bgColor:uint;
    private var size:uint;

    public function ButtonDisplayState(bgColor:uint, size:uint) {
        this.bgColor = bgColor;
        this.size    = size;
        draw();
    }

    private function draw():void {
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, size, size);
        graphics.endFill();
    }
}




 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/2_jp/langref/flash/display/SimpleButton.html