mx.core.SpriteAsset (Flex™ 2 リファレンスガイド)

パッケージ	mx.core
	public class SpriteAsset
継承	SpriteAsset FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IFlexAsset, IFlexDisplayObject

SpriteAsset は、Flex アプリケーションに埋め込まれたベクターグラフィックイメージを表す Flash Player の Sprite クラスのサブクラスです。これにより IFlexDisplayObject インターフェイスが実装され、埋め込まれたベクターグラフィックイメージを Image コントロールで表示すること、またはコンテナの背景やコンポーネントスキンとして使用することが可能になります。

SVG ファイルのベクターグラフィックイメージを埋め込むことができます。Flash によって作成された SWF ファイルのスプライトシンボルを埋め込むこともできます。いずれのケースでも、MXML コンパイラは、埋め込まれたベクターグラフィックイメージを表すように SpriteAsset を拡張するクラスを自動生成します。

通常は、Flex アプリケーションを作成するときに SpriteAsset クラスを直接使用する必要はありません。たとえば、次のように記述すると、SWF ファイルからスプライトシンボルを埋め込み、Image コントロールに表示することができます。

  <mx:Image id="logo" source="@Embed(source='Assets.swf', symbol='Logo')"/>

または、次のように記述することにより、CSS シンタックスの中でアプリケーションの背景イメージとして使用できます。

  <mx:Style>
      Application
      {
          backgroundImage: Embed(source="Assets.swf", symbol='Logo')
      }
  <mx:Style/>

MXML コンパイラによって BitmapAsset のサブクラスが作成されたことを認識しておく必要はありません。

ただし、ActionScript レベルで何が行われているのかを理解しておくことは有益です。ベクターグラフィックイメージを ActionScript に埋め込むには、Class 型の変数を宣言し、それに [Embed] メタデータを入れます。たとえば、このようにして SWF ファイルからスプライトシンボルを埋め込みます。

  [Bindable]
  [Embed(source="Assets.swf", symbol="Logo")]
  private var logoClass:Class;

MXML コンパイラは、Assets.swf の Logo シンボルがスプライトであることを確認し、それを表す SpriteAsset クラスのサブクラスを自動生成し、この自動生成されたクラスへの参照を変数に設定します。その後、このクラス参照を使用し、new 演算子を使用して SpriteAsset のインスタンスを作成すること、およびそれらに Sprite クラスの API を使用することができます。

  var logo:SpriteAsset = SpriteAsset(new logoClass());
  logo.rotation=45;

ただし、イメージ関連のプロパティおよびスタイルをイメージ生成クラスに設定でき、コンポーネントが必要に応じてイメージインスタンスを作成するため、SpriteAsset インスタンスを自分で作成する必要はほとんどありません。たとえば、このベクターグラフィックイメージを Image コントロールに表示するために、Image の source プロパティを logoClass に設定することができます。MXML では、次のようにします。

  <mx:Image id="logo" source="{logoClass}"/>

パブリックプロパティ

継承されるパブリックプロパティの非表示

継承されるパブリックプロパティの表示

	プロパティ		定義
		accessibilityProperties : AccessibilityProperties この表示オブジェクトの現在のアクセシビリティオプションです。	DisplayObject
		alpha : Number 指定されたオブジェクトのアルファ透明度値を示します。	DisplayObject
		blendMode : String 使用するブレンドモードを指定する BlendMode クラスの値です。	DisplayObject
		buttonMode : Boolean このスプライトのボタンモードを指定します。	Sprite
		cacheAsBitmap : Boolean `true` に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player にキャッシュされます。	DisplayObject
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		contextMenu : ContextMenu このオブジェクトに関連付けられたコンテキストメニューを指定します。	InteractiveObject
		doubleClickEnabled : Boolean オブジェクトが `doubleClick` イベントを受け取るかどうかを指定します。	InteractiveObject
		dropTarget : DisplayObject スプライトのドラッグ先またはスプライトがドロップされた先の表示オブジェクトを指定します。	Sprite
		filters : Array 表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。	DisplayObject
		focusRect : Object このオブジェクトがフォーカス矩形を表示するかどうかを指定します。	InteractiveObject
		graphics : Graphics ベクターの描画コマンドが発生するこのスプライトに属する Graphics オブジェクトを指定します。	Sprite
		height : Number 表示オブジェクトの高さを示します (ピクセル単位)。	DisplayObject
		hitArea : Sprite スプライトのヒット領域となる別のスプライトを指定します。	Sprite
		loaderInfo : LoaderInfo この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo オブジェクトを返します。	DisplayObject
		mask : DisplayObject 呼び出し元の表示オブジェクトは、指定された `mask` オブジェクトによってマスクされます。	DisplayObject
		measuredHeight : Number [read-only] このオブジェクトの測定した高さです。	SpriteAsset
		measuredWidth : Number [read-only] このオブジェクトの測定した幅です。	SpriteAsset
		mouseChildren : Boolean オブジェクトの子に対してマウスが有効かどうかを調べます。	DisplayObjectContainer
		mouseEnabled : Boolean このオブジェクトがマウスメッセージを受け取るかどうかを指定します。	InteractiveObject
		mouseX : Number マウス位置の x 座標を示します (ピクセル単位)。	DisplayObject
		mouseY : Number マウス位置の y 座標を示します (ピクセル単位)。	DisplayObject
		name : String DisplayObject のインスタンス名を示します。	DisplayObject
		numChildren : int このオブジェクトの子の数を返します。	DisplayObjectContainer
		opaqueBackground : Object 表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。	DisplayObject
		parent : DisplayObjectContainer この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。	DisplayObject
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		root : DisplayObject ロードされた SWF ファイル内の表示オブジェクトの場合、`root` プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。	DisplayObject
		rotation : Number DisplayObject インスタンスの元の位置からの回転角を度単位で示します。	DisplayObject
		scale9Grid : Rectangle 現在有効な拡大 / 縮小グリッドです。	DisplayObject
		scaleX : Number 基準点から適用されるオブジェクトの水平スケール (`percentage`) を示します。	DisplayObject
		scaleY : Number オブジェクトの基準点から適用されるオブジェクトの垂直スケール (`percentage`) を示します。	DisplayObject
		scrollRect : Rectangle 表示オブジェクトのスクロール矩形の境界。	DisplayObject
		soundTransform : SoundTransform このスプライト内のサウンドを制御します。	Sprite
		stage : Stage 表示オブジェクトのステージ。	DisplayObject
		tabChildren : Boolean オブジェクトの子に対してタブが有効かどうかを調べます。	DisplayObjectContainer
		tabEnabled : Boolean このオブジェクトがタブ順序序に含まれるかどうかを指定します。	InteractiveObject
		tabIndex : int SWF ファイル内のオブジェクトのタブ順を指定します。	InteractiveObject
		textSnapshot : TextSnapshot この DisplayObjectContainer インスタンスの TextSnapshot オブジェクトを返します。	DisplayObjectContainer
		transform : Transform 表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクト。	DisplayObject
		useHandCursor : Boolean `buttonMode` プロパティが `true` に設定されたスプライト上にマウスが移動したときに、指差しハンドポインタ (ハンドカーソル) を表示するかどうかを示すブール値です。	Sprite
		visible : Boolean 表示オブジェクトが可視かどうかを示します。	DisplayObject
		width : Number 表示オブジェクトの幅を示します (ピクセル単位)。	DisplayObject
		x : Number 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。	DisplayObject
		y : Number 親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。	DisplayObject

パブリック Methods

継承されるパブリックメソッドの非表示

継承されるパブリックメソッドの表示

	メソッド		定義
		SpriteAsset() コンストラクタです。	SpriteAsset
		addChild(child:DisplayObject):DisplayObject この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void リスナーがイベントの通知を受け取るように、イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録します。	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean 特定の `point` ポイントを指定して呼び出した `DisplayObjectContainer.getObjectsUnderPoint()` メソッドから返されたリストに、セキュリティ上の制約のために省略される表示オブジェクトがあるかどうかを示します。	DisplayObjectContainer
		contains(child:DisplayObject):Boolean 指定された表示オブジェクトが、DisplayObjectContainer インスタンスの子であるか、インスタンス自体であるかを指定します。	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle `targetCoordinateSpace` オブジェクトの座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。	DisplayObject
		getChildAt(index:int):DisplayObject 指定のインデックス位置にある子表示オブジェクトインスタンスを返します。	DisplayObjectContainer
		getChildByName(name:String):DisplayObject 指定された名前に一致する子表示オブジェクトを返します。	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int `child` DisplayObject インスタンスのインデックス位置を返します。	DisplayObjectContainer
		getObjectsUnderPoint(point:Point):Array 指定されたポイントの下にあり、この DisplayObjectContainer インスタンスの子 (または孫など) であるオブジェクトの配列を返します。	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle シェイプ上の線を除き、`targetCoordinateSpace` パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。	DisplayObject
		globalToLocal(point:Point):Point `point` オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。	DisplayObject
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指定されたプロパティがオブジェクトに定義されているかどうかを示します。	Object
		hitTestObject(obj:DisplayObject):Boolean 表示オブジェクトを評価して、`obj` 表示オブジェクトと重複または交差するかどうかを調べます。	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean 表示オブジェクトを評価して、`x` および `y` パラメータで指定されたポイントと重複または交差するかどうかを調べます。	DisplayObject
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		localToGlobal(point:Point):Point `point` オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。	DisplayObject
		move(x:Number, y:Number):void このオブジェクトを指定の x および y 座標に移動します。	SpriteAsset
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeChild(child:DisplayObject):DisplayObject DisplayObjectContainer インスタンスの子リストから指定の `child` DisplayObject インスタンスを削除します。	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject DisplayObjectContainer の子リストの指定された `index` 位置から子 DisplayObject を削除します。	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setActualSize(newWidth:Number, newHeight:Number):void このオブジェクトの実際のサイズを設定します。	SpriteAsset
		setChildIndex(child:DisplayObject, index:int):void 表示オブジェクトコンテナの既存の子の位置を変更します。	DisplayObjectContainer
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void 指定されたスプライトをユーザーがドラッグできるようにします。	Sprite
		stopDrag():void `startDrag()` メソッドを終了します。	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void 指定された 2 つの子オブジェクトの z 順序 (重ね順) を入れ替えます。	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void 子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序 (重ね順) を入れ替えます。	DisplayObjectContainer
		toString():String アプリケーションの DisplayObject の階層内部でのこのオブジェクトの位置を示すストリングを返します。	FlexSprite
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

継承されるイベントの非表示

継承されるイベントの表示

	一覧	定義
activate	Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
added	表示オブジェクトが表示リストに追加されたときに送出されます。	DisplayObject
addedToStage	表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの追加により、ステージ上の表示リストに追加されたときに送出されます。	DisplayObject
click	ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを押して離すと送出されます。	InteractiveObject
deactivate	Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
doubleClick	オブジェクトの `doubleClickEnabled` フラグが `true` に設定されている場合には、ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを 2 回続けてすばやく押して離すと送出されます。	InteractiveObject
enterFrame	再生ヘッドが新しいフレームに入るときに送出されます。	DisplayObject
focusIn	表示オブジェクトがフォーカスを取得した後に送出されます。	InteractiveObject
focusOut	表示オブジェクトがフォーカスを失った後に送出されます。	InteractiveObject
keyDown	ユーザーがキーを押したときに送出されます。	InteractiveObject
keyFocusChange	ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。	InteractiveObject
keyUp	ユーザーがキーを離したときに送出されます。	InteractiveObject
mouseDown	Flash Player ウィンドウの InteractiveObject インスタンスの上で、ユーザーがポインティングデバイスのボタンを押したときに送出されます。	InteractiveObject
mouseFocusChange	ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。	InteractiveObject
mouseMove	InteractiveObject の上で、ユーザーがポインティングデバイスを移動させたときに送出されます。	InteractiveObject
mouseOut	ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。	InteractiveObject
mouseOver	ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスに、ポインティングデバイスを合わせたときに送出されます。	InteractiveObject
mouseUp	ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスの上でポインティングデバイスのボタンを離したときに送出されます。	InteractiveObject
mouseWheel	Flash Player ウィンドウの InteractiveObject インスタンスの上で、マウスホイールを回転させたときに送出されます。	InteractiveObject
removed	表示オブジェクトが表示リストから削除されようとしているときに送出されます。	DisplayObject
removedFromStage	表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの削除により、表示リストから削除されようとしているときに送出されます。	DisplayObject
render	表示リストが更新およびレンダリングされようとしているときに送出されます。	DisplayObject
rollOut	ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。	InteractiveObject
rollOver	ユーザーが InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。	InteractiveObject
tabChildrenChange	オブジェクトの `tabChildren` フラグの値が変更されたときに送出されます。	InteractiveObject
tabEnabledChange	オブジェクトの `tabEnabled` フラグが変更されたときに送出されます。	InteractiveObject
tabIndexChange	オブジェクトの `tabIndex` プロパティの値が変更されたときに送出されます。	InteractiveObject

プロパティの詳細

measuredHeight

プロパティ

measuredHeight:Number [read-only]

このオブジェクトの測定した高さです。

この数字は単なるグラフィックのピクセル数であるため、グラフィカルスキンの場合、これは通常ハードコードになります。コードスキンの場合も、一定のサイズで描画する場合はハードコードにできます。プロパティに応じてサイズが変わる場合は、ILayoutManagerClient により、適切なタイミングで measure() メソッドを呼び出して、measuredHeight を計算することもできます。

実装
public function get measuredHeight():Number

measuredWidth

プロパティ

measuredWidth:Number [read-only]

このオブジェクトの測定した幅です。

実装
public function get measuredWidth():Number

コンストラクタの詳細

SpriteAsset

()

コンストラクタ

public 関数 SpriteAsset()

コンストラクタです。

メソッドの詳細

move

()

メソッド

public function move(x:Number, y:Number):void

このオブジェクトを指定の x および y 座標に移動します。

パラメータ

	`x:Number` — このオブジェクトの新しい x 位置です。

	`y:Number` — このオブジェクトの新しい y 位置です。

setActualSize

()

メソッド

public function setActualSize(newWidth:Number, newHeight:Number):void

このオブジェクトの実際のサイズを設定します。

このメタデータは主に updateDisplayList() メソッドの実装に使用されます。ここでオブジェクトの実際のサイズを、その明示的サイズ、親との相対 (％) サイズ、および測定されたサイズに基づいて計算します。次に setActualSize() を呼び出してこの実際のサイズをオブジェクトに適用します。

その他の状況では、このメソッドを呼び出す代わりに、width、height、percentWidth、percentHeight などのプロパティを設定することになります。

パラメータ

	`newWidth:Number` — このオブジェクトの新しい幅です。

	`newHeight:Number` — このオブジェクトの新しい高さです。

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class SpriteAsset	プロパティ \| メソッド \| イベント