jp.progression.casts.mx.CastUIButton

	Property	Defined by
		accessKey : String ボタンの機能をキーボードから使用するためのアクセスキーを取得または設定します。設定できるキーはアルファベットの A ～ Z までの値です。	CastUIButton
		activatedButtons : Array [static][read-only] 現在、ステージ上に設置されているボタンを含む配列を取得します。	CastUIButton
		contextMenu : ContextMenu	CastUIButton
		executor : ExecutorObject [read-only] 関連付けられている ExecutorObject インスタンスを取得します。	CastUIButton
		group : String インスタンスのグループ名を取得または設定します。 Indicates the instance group of the IExDisplayObject.	CastUIButton
		href : String ボタンがクリックされた時の移動先の URL を取得または設定します。 sceneId プロパティと href プロパティが両方とも設定されている場合には、href プロパティの設定が優先されます。	CastUIButton
		id : String インスタンスの識別子を取得または設定します。 Indicates the instance id of the IExDisplayObject.	CastUIButton
		isMouseDown : Boolean [read-only] CastUIButton インスタンスでポインティングデバイスのボタンを押されているかどうかを取得します。	CastUIButton
		isRollOver : Boolean [read-only] CastUIButton インスタンスにポインティングデバイスが合わされているかどうかを取得します。	CastUIButton
		manager : Progression [read-only] 関連付けられている Progression インスタンスを取得します。	CastUIButton
		mouseEventEnabled : Boolean マウス状態に応じて Executor を使用した処理を行うかどうかを取得または設定します。	CastUIButton
		onCastAdded : Function キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		onCastMouseDown : Function キャストオブジェクトが CastMouseEvent.CAST_MOUSE_DOWN イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		onCastMouseUp : Function キャストオブジェクトが CastMouseEvent.CAST_MOUSE_UP イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		onCastRemoved : Function キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		onCastRollOut : Function キャストオブジェクトが CastMouseEvent.CAST_ROLL_OUT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		onCastRollOver : Function キャストオブジェクトが CastMouseEvent.CAST_ROLL_OVER イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		sceneId : SceneId ボタンがクリックされた時の移動先を示すシーン識別子を取得または設定します。 sceneId プロパティと href プロパティが両方とも設定されている場合には、href プロパティの設定が優先されます。	CastUIButton
		self : CastUIButton [read-only] 自身の参照を取得します。	CastUIButton
		state : int [read-only] ボタンの状態を取得します。	CastUIButton
		windowTarget : String ボタンがクリックされた時の移動先を開くウィンドウ名を取得または設定します。	CastUIButton

	Method	Defined by
		CastUIButton() 新しい CastUIButton インスタンスを作成します。 Creates a new CastUIButton object.	CastUIButton
		addCommand(... commands):void 特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。	CastUIButton
		clearCommand(completely:Boolean = false):void 登録されている Command インスタンスを削除します。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。	CastUIButton
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。 Dispatches an event into the event flow.	CastUIButton
		dispose():void 保持しているデータを解放します。	CastUIButton
		insertCommand(... commands):void 特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。	CastUIButton
		navigateTo(location:*, window:String = null):void 指定されたシーン識別子、または URL の示す先に移動します。引数が省略された場合には、あらかじめ CastUIButton インスタンスに指定されている sceneId プロパティ、 href プロパティが示す先に移動します。	CastUIButton
		setProperties(parameters:Object):DisplayObject インスタンスに対して、複数のプロパティを一括設定します。 Setup the several instance properties.	CastUIButton
		toString():String 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.	CastUIButton
		updateManager():Boolean マネージャーオブジェクトとの関連付けを更新します。	CastUIButton

	Method	Defined by
		atCastAdded():void キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		atCastMouseDown():void キャストオブジェクトが CastMouseEvent.CAST_MOUSE_DOWN イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドで。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		atCastMouseUp():void キャストオブジェクトが CastMouseEvent.CAST_MOUSE_UP イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		atCastRemoved():void キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		atCastRollOut():void キャストオブジェクトが CastMouseEvent.CAST_ROLL_OUT イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
		atCastRollOver():void キャストオブジェクトが CastMouseEvent.CAST_ROLL_OVER イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton

Summary	Defined by
castAdded	IExecutable オブジェクトが AddChild コマンド、または AddChildAt コマンド経由で表示リストに追加された場合に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
castAddedComplete	CastEvent.CAST_ADDED イベント中に実行された非同期処理が完了した場合に送出されます。	CastUIButton
castMouseDown	Flash Player ウィンドウの CastUIButton インスタンスの上でユーザーがポインティングデバイスのボタンを押すと送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
castMouseDownComplete	CastMouseEvent.CAST_MOUSE_DOWN イベント中に実行された非同期処理が完了した場合に送出されます。	CastUIButton
castMouseUp	ユーザーが CastUIButton インスタンスからポインティングデバイスを離したときに送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
castMouseUpComplete	CastMouseEvent.CAST_MOUSE_UP イベント中に実行された非同期処理が完了した場合に送出されます。	CastUIButton
castNavigateBefore	ボタンが移動処理を開始する直前に送出されます。	CastUIButton
castRemoved	IExecutable オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由で表示リストから削除された場合に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
castRemovedComplete	CastEvent.CAST_REMOVED イベント中に実行された非同期処理が完了した場合に送出されます。	CastUIButton
castRollOut	ユーザーが CastUIButton インスタンスからポインティングデバイスを離したときに送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
castRollOutComplete	CastMouseEvent.CAST_ROLL_OUT イベント中に実行された非同期処理が完了した場合に送出されます。	CastUIButton
castRollOver	ユーザーが CastUIButton インスタンスにポインティングデバイスを合わせたときに送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。	CastUIButton
castRollOverComplete	CastMouseEvent.CAST_ROLL_OVER イベント中に実行された非同期処理が完了した場合に送出されます。	CastUIButton
castStateChange	ボタンの状態が変更された場合に送出されます。	CastUIButton
executeError	非同期処理中にエラーが発生した場合に送出されます。	CastUIButton
managerActivate	Progression インスタンスとの関連付けがアクティブになったときに送出されます。	CastUIButton
managerDeactivate	Progression インスタンスとの関連付けが非アクティブになったときに送出されます。	CastUIButton

Property detail

accessKey

property

accessKey:String [read-write]

ボタンの機能をキーボードから使用するためのアクセスキーを取得または設定します。設定できるキーはアルファベットの A ～ Z までの値です。

Implementation
public function get accessKey():String
public function set accessKey(value:String):void

See also

sceneId
href
windowTarget
navigateTo()

activatedButtons

property

activatedButtons:Array [read-only]

現在、ステージ上に設置されているボタンを含む配列を取得します。

Implementation
public static function get activatedButtons():Array

contextMenu

property

contextMenu:ContextMenu  [read-write]Implementation
    public function get contextMenu():ContextMenu
    public function set contextMenu(value:ContextMenu):void

executor

property

executor:ExecutorObject [read-only]

関連付けられている ExecutorObject インスタンスを取得します。

Implementation
public function get executor():ExecutorObject

group

property

group:String [read-write]

インスタンスのグループ名を取得または設定します。 Indicates the instance group of the IExDisplayObject.

Implementation
public function get group():String
public function set group(value:String):void

See also

jp.nium.display.getInstancesByGroup()

href

property

href:String [read-write]

ボタンがクリックされた時の移動先の URL を取得または設定します。 sceneId プロパティと href プロパティが両方とも設定されている場合には、href プロパティの設定が優先されます。

Implementation
public function get href():String
public function set href(value:String):void

See also

sceneId
windowTarget
navigateTo()

property

id:String [read-write]

インスタンスの識別子を取得または設定します。 Indicates the instance id of the IExDisplayObject.

Implementation
public function get id():String
public function set id(value:String):void

See also

jp.nium.display.getInstanceById()

isMouseDown

property

isMouseDown:Boolean [read-only]

CastUIButton インスタンスでポインティングデバイスのボタンを押されているかどうかを取得します。

Implementation
public function get isMouseDown():Boolean

isRollOver

property

isRollOver:Boolean [read-only]

CastUIButton インスタンスにポインティングデバイスが合わされているかどうかを取得します。

Implementation
public function get isRollOver():Boolean

manager

property

manager:Progression [read-only]

関連付けられている Progression インスタンスを取得します。

Implementation
public function get manager():Progression

mouseEventEnabled

property

mouseEventEnabled:Boolean [read-write]

マウス状態に応じて Executor を使用した処理を行うかどうかを取得または設定します。

Implementation
public function get mouseEventEnabled():Boolean
public function set mouseEventEnabled(value:Boolean):void

onCastAdded

property

onCastAdded:Function [read-write]

キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onCastAdded():Function
public function set onCastAdded(value:Function):void

onCastMouseDown

property

onCastMouseDown:Function [read-write]

キャストオブジェクトが CastMouseEvent.CAST_MOUSE_DOWN イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onCastMouseDown():Function
public function set onCastMouseDown(value:Function):void

onCastMouseUp

property

onCastMouseUp:Function [read-write]

キャストオブジェクトが CastMouseEvent.CAST_MOUSE_UP イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onCastMouseUp():Function
public function set onCastMouseUp(value:Function):void

onCastRemoved

property

onCastRemoved:Function [read-write]

キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onCastRemoved():Function
public function set onCastRemoved(value:Function):void

onCastRollOut

property

onCastRollOut:Function [read-write]

キャストオブジェクトが CastMouseEvent.CAST_ROLL_OUT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onCastRollOut():Function
public function set onCastRollOut(value:Function):void

onCastRollOver

property

onCastRollOver:Function [read-write]

キャストオブジェクトが CastMouseEvent.CAST_ROLL_OVER イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

Implementation
public function get onCastRollOver():Function
public function set onCastRollOver(value:Function):void

sceneId

property

sceneId:SceneId [read-write]

ボタンがクリックされた時の移動先を示すシーン識別子を取得または設定します。 sceneId プロパティと href プロパティが両方とも設定されている場合には、href プロパティの設定が優先されます。

Implementation
public function get sceneId():SceneId
public function set sceneId(value:SceneId):void

See also

href
windowTarget
navigateTo()

self

property

self:CastUIButton [read-only]

自身の参照を取得します。

Implementation
public function get self():CastUIButton

state

property

state:int [read-only]

ボタンの状態を取得します。

Implementation
public function get state():int

See also

sceneId
jp.progression.casts.CastUIButtonState

windowTarget

property

windowTarget:String [read-write]

ボタンがクリックされた時の移動先を開くウィンドウ名を取得または設定します。

Implementation
public function get windowTarget():String
public function set windowTarget(value:String):void

See also

sceneId
href
navigateTo()
jp.progression.casts.CastUIButtonWindowTarget

Constructor detail

CastUIButton

()

constructor

public function CastUIButton()

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

Method detail

addCommand

()

method

public function addCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

Parameters

... commands — 登録したいコマンドを含む配列です。

atCastAdded

()

method

protected function atCastAdded():void

キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atCastMouseDown

()

method

protected function atCastMouseDown():void

キャストオブジェクトが CastMouseEvent.CAST_MOUSE_DOWN イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドで。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atCastMouseUp

()

method

protected function atCastMouseUp():void

キャストオブジェクトが CastMouseEvent.CAST_MOUSE_UP イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atCastRemoved

()

method

protected function atCastRemoved():void

キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atCastRollOut

()

method

protected function atCastRollOut():void

キャストオブジェクトが CastMouseEvent.CAST_ROLL_OUT イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

atCastRollOver

()

method

protected function atCastRollOver():void

キャストオブジェクトが CastMouseEvent.CAST_ROLL_OVER イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

clearCommand

()

method

public function clearCommand(completely:Boolean = false):void

登録されている Command インスタンスを削除します。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

Parameters

completely:Boolean (default = false) — true が設定されている場合は登録されている全てのコマンド登録を解除し、false の場合には現在処理中のコマンド以降の登録を解除します。

dispatchEvent

()

method

public override 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.

dispose

()

method

public function dispose():void

保持しているデータを解放します。

insertCommand

()

method

public function insertCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

Parameters

... commands — 登録したいコマンドを含む配列です。

navigateTo

()

method

public function navigateTo(location:*, window:String = null):void

指定されたシーン識別子、または URL の示す先に移動します。引数が省略された場合には、あらかじめ CastUIButton インスタンスに指定されている sceneId プロパティ、 href プロパティが示す先に移動します。

Parameters

	`location:*` — 移動先を示すシーン識別子、または URL です。

	`window:String` (default = `null`) — location パラメータで指定されたドキュメントを表示するブラウザウィンドウまたは HTML フレームです。

See also

sceneId
href
windowTarget

setProperties

()

method

public function setProperties(parameters:Object):DisplayObject

インスタンスに対して、複数のプロパティを一括設定します。 Setup the several instance properties.

Parameters

parameters:Object — 設定したいプロパティを含んだオブジェクトです。 The object that contains the property to setup.

Returns

DisplayObject — 自身の参照です。

toString

()

method

public override function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns

String — オブジェクトのストリング表現です。 A string representation of the object.

updateManager

()

method

public function updateManager():Boolean

マネージャーオブジェクトとの関連付けを更新します。

Returns

Boolean — 関連付けが成功したら true を、それ以外は false を返します。

See also

manager
jp.progression.Progression

Event detail

castAdded

event

Event object type: jp.progression.events.CastEvent

IExecutable オブジェクトが AddChild コマンド、または AddChildAt コマンド経由で表示リストに追加された場合に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castAddedComplete

event

Event object type: jp.progression.events.CastEvent

CastEvent.CAST_ADDED イベント中に実行された非同期処理が完了した場合に送出されます。

castMouseDown

event

Event object type: jp.progression.events.CastMouseEvent

Flash Player ウィンドウの CastUIButton インスタンスの上でユーザーがポインティングデバイスのボタンを押すと送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castMouseDownComplete

event

Event object type: jp.progression.events.CastMouseEvent

CastMouseEvent.CAST_MOUSE_DOWN イベント中に実行された非同期処理が完了した場合に送出されます。

castMouseUp

event

Event object type: jp.progression.events.CastMouseEvent

ユーザーが CastUIButton インスタンスからポインティングデバイスを離したときに送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castMouseUpComplete

event

Event object type: jp.progression.events.CastMouseEvent

CastMouseEvent.CAST_MOUSE_UP イベント中に実行された非同期処理が完了した場合に送出されます。

castNavigateBefore

event

Event object type: jp.progression.events.CastMouseEvent

ボタンが移動処理を開始する直前に送出されます。

castRemoved

event

Event object type: jp.progression.events.CastEvent

IExecutable オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由で表示リストから削除された場合に送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castRemovedComplete

event

Event object type: jp.progression.events.CastEvent

CastEvent.CAST_REMOVED イベント中に実行された非同期処理が完了した場合に送出されます。

castRollOut

event

Event object type: jp.progression.events.CastMouseEvent

castRollOutComplete

event

Event object type: jp.progression.events.CastMouseEvent

CastMouseEvent.CAST_ROLL_OUT イベント中に実行された非同期処理が完了した場合に送出されます。

castRollOver

event

Event object type: jp.progression.events.CastMouseEvent

ユーザーが CastUIButton インスタンスにポインティングデバイスを合わせたときに送出されます。このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castRollOverComplete

event

Event object type: jp.progression.events.CastMouseEvent

CastMouseEvent.CAST_ROLL_OVER イベント中に実行された非同期処理が完了した場合に送出されます。

castStateChange

event

Event object type: jp.progression.events.CastMouseEvent

ボタンの状態が変更された場合に送出されます。

executeError

event

Event object type: jp.progression.events.ExecuteErrorEvent

非同期処理中にエラーが発生した場合に送出されます。

managerActivate

event

Event object type: jp.progression.events.ManagerEvent

Progression インスタンスとの関連付けがアクティブになったときに送出されます。

managerDeactivate

event

Event object type: jp.progression.events.ManagerEvent

Progression インスタンスとの関連付けが非アクティブになったときに送出されます。

Progression 4.0 for MXML API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class CastUIButton	Properties \| Methods \| Events

Package	jp.progression.casts.mx
Class	public class CastUIButton
Inheritance	CastUIButton mx.controls.Button
Implements	jp.progression.core.impls.ICastButton, jp.progression.core.impls.IManageable