LayoutMetadata

パッケージ	org.osmf.layout
クラス	public class LayoutMetadata
継承	LayoutMetadata Metadata EventDispatcher Object

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

レイアウトレンダラーがそのレイアウト設定でベースにするプロパティが含まれるメタデータオブジェクトを定義します。

例を表示

パブリックプロパティ

継承されるパブリックプロパティを隠す

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

	プロパティ		定義元
		bottom : Number ターゲットの境界ボックスの下側とそのコンテナの下側の間に空けるピクセル数を定義します。	LayoutMetadata
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		height : Number ターゲットの垂直オフセットを定義します。ピクセル単位で表します。	LayoutMetadata
		horizontalAlign : String ターゲットのレイアウトで水平方向に余白を残す場合に、ターゲットに適用する水平方向の配置を定義します。	LayoutMetadata
		includeInLayout : Boolean true（デフォルト）に設定すると、ターゲットはレイアウト処理に加わります。	LayoutMetadata
		index : Number そのコンテキストの表示リストにターゲットの位置を定義します。	LayoutMetadata
		keys : Vector.<String> [読み取り専用] この Metadata オブジェクトに保存されているキーです。	Metadata
		layoutMode : String LayoutMode.HORIZONTAL または LayoutMode.VERTICAL に設定すると、レンダラーはターゲットの配置設定を無視して（影響するのは X か Y のいずれかで、選択された layoutMode によって決まります）、index プロパティで指定されたインデックス付近にエレメントを配置します。	LayoutMetadata
		left : Number ターゲットの水平オフセットをピクセル単位で定義します。	LayoutMetadata
		paddingBottom : Number ターゲットの下側に配置する余白の幅を定義します。	LayoutMetadata
		paddingLeft : Number ターゲットの左側に配置する余白の幅を定義します。	LayoutMetadata
		paddingRight : Number ターゲットの右側に配置する余白の幅を定義します。	LayoutMetadata
		paddingTop : Number ターゲットの上側に配置する余白の幅を定義します。	LayoutMetadata
		percentHeight : Number ターゲットの高さを定義します。そのコンテナの高さのパーセント値で表します。	LayoutMetadata
		percentWidth : Number ターゲットの幅を定義します。そのコンテナの幅のパーセント値で表します。	LayoutMetadata
		percentX : Number ターゲットの水平オフセットを定義します。そのコンテナの幅のパーセント値で表します。	LayoutMetadata
		percentY : Number ターゲットの垂直オフセットを定義します。そのコンテナの高さのパーセント値で表します。	LayoutMetadata
		right : Number ターゲットの境界ボックスの右側とそのコンテナの右側の間に空けるピクセル数を定義します。	LayoutMetadata
		scaleMode : String ターゲットに適用する scaleMode を定義します。	LayoutMetadata
		snapToPixel : Boolean true に設定すると、算出後のターゲットの位置とサイズは四捨五入されます。	LayoutMetadata
		top : Number ターゲットの垂直オフセットをピクセル単位で定義します。	LayoutMetadata
		verticalAlign : String ターゲットのレイアウトで垂直方向に余白を残す場合に、ターゲットに適用する垂直方向の配置を定義します。	LayoutMetadata
		width : Number ターゲットの水平方向のサイズを定義します。ピクセル単位で表します。	LayoutMetadata
		x : Number ターゲットの水平オフセットを定義します。ピクセル単位で表します。	LayoutMetadata
		y : Number ターゲットの垂直オフセットを定義します。ピクセル単位で表します。	LayoutMetadata

パブリックメソッド

継承されるパブリックメソッドを隠す

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

	メソッド		定義元
		LayoutMetadata() コンストラクターです。	LayoutMetadata
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		addValue(key:String, value:Object):void 指定されたキーを使用して、指定された値をこの Metadata オブジェクトに保存します。	Metadata
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getValue(key:String):* 指定されたキーに関連付けられている値を返します。	Metadata
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		removeValue(key:String):* 指定されたキーに関連付けられている値を、この Metadata オブジェクトから削除します。	Metadata
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

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

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
valueAdd	Metadata オブジェクトに新しい値が追加されたときに送出されます。	Metadata
valueChange	Metadata オブジェクト内の値が変更されたときに送出されます。	Metadata
valueRemove	Metadata オブジェクトから値が削除されたときに送出されます。	Metadata

パブリック定数

	定数		定義元
		LAYOUT_NAMESPACE : String = "http://www.osmf.org/layout/1.0" [静的] MediaElement または MediaContainer に追加されるときの LayoutMetadata オブジェクトの名前空間 URL です。	LayoutMetadata

プロパティの詳細

bottom

プロパティ

bottom:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの境界ボックスの下側とそのコンテナの下側の間に空けるピクセル数を定義します。

実装
public function get bottom():Number
public function set bottom(value:Number):void

height

プロパティ

height:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの垂直オフセットを定義します。ピクセル単位で表します。

実装
public function get height():Number
public function set height(value:Number):void

horizontalAlign

プロパティ

horizontalAlign:String

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットのレイアウトで水平方向に余白を残す場合に、ターゲットに適用する水平方向の配置を定義します。

実装
public function get horizontalAlign():String
public function set horizontalAlign(value:String):void

includeInLayout

プロパティ

includeInLayout:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

true（デフォルト）に設定すると、ターゲットはレイアウト処理に加わります。false に設定すると、ターゲットは無視されます。

実装
public function get includeInLayout():Boolean
public function set includeInLayout(value:Boolean):void

index

プロパティ

index:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

そのコンテキストの表示リストにターゲットの位置を定義します。

実装
public function get index():Number
public function set index(value:Number):void

layoutMode

プロパティ

layoutMode:String

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

LayoutMode.HORIZONTAL または LayoutMode.VERTICAL に設定すると、レンダラーはターゲットの配置設定を無視して（影響するのは X か Y のいずれかで、選択された layoutMode によって決まります）、index プロパティで指定されたインデックス付近にエレメントを配置します。

実装
public function get layoutMode():String
public function set layoutMode(value:String):void

left

プロパティ

left:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの水平オフセットをピクセル単位で定義します。

実装
public function get left():Number
public function set left(value:Number):void

paddingBottom

プロパティ

paddingBottom:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの下側に配置する余白の幅を定義します。

実装
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void

paddingLeft

プロパティ

paddingLeft:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの左側に配置する余白の幅を定義します。

実装
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void

paddingRight

プロパティ

paddingRight:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの右側に配置する余白の幅を定義します。

実装
public function get paddingRight():Number
public function set paddingRight(value:Number):void

paddingTop

プロパティ

paddingTop:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの上側に配置する余白の幅を定義します。

実装
public function get paddingTop():Number
public function set paddingTop(value:Number):void

percentHeight

プロパティ

percentHeight:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの高さを定義します。そのコンテナの高さのパーセント値で表します。

実装
public function get percentHeight():Number
public function set percentHeight(value:Number):void

percentWidth

プロパティ

percentWidth:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの幅を定義します。そのコンテナの幅のパーセント値で表します。

実装
public function get percentWidth():Number
public function set percentWidth(value:Number):void

percentX

プロパティ

percentX:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの水平オフセットを定義します。そのコンテナの幅のパーセント値で表します。

実装
public function get percentX():Number
public function set percentX(value:Number):void

percentY

プロパティ

percentY:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの垂直オフセットを定義します。そのコンテナの高さのパーセント値で表します。

実装
public function get percentY():Number
public function set percentY(value:Number):void

right

プロパティ

right:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの境界ボックスの右側とそのコンテナの右側の間に空けるピクセル数を定義します。

実装
public function get right():Number
public function set right(value:Number):void

scaleMode

プロパティ

scaleMode:String

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットに適用する scaleMode を定義します。有効な値は、org.osmf.layout.ScaleMode にあります。

実装
public function get scaleMode():String
public function set scaleMode(value:String):void

snapToPixel

プロパティ

snapToPixel:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

true に設定すると、算出後のターゲットの位置とサイズは四捨五入されます。

実装
public function get snapToPixel():Boolean
public function set snapToPixel(value:Boolean):void

top

プロパティ

top:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの垂直オフセットをピクセル単位で定義します。

実装
public function get top():Number
public function set top(value:Number):void

verticalAlign

プロパティ

verticalAlign:String

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットのレイアウトで垂直方向に余白を残す場合に、ターゲットに適用する垂直方向の配置を定義します。

実装
public function get verticalAlign():String
public function set verticalAlign(value:String):void

width

プロパティ

width:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの水平方向のサイズを定義します。ピクセル単位で表します。

実装
public function get width():Number
public function set width(value:Number):void

x

プロパティ

x:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの水平オフセットを定義します。ピクセル単位で表します。

実装
public function get x():Number
public function set x(value:Number):void

y

プロパティ

y:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ターゲットの垂直オフセットを定義します。ピクセル単位で表します。

実装
public function get y():Number
public function set y(value:Number):void

コンストラクターの詳細

()

コンストラクター

public function LayoutMetadata()

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクターです。

定数の詳細

LAYOUT_NAMESPACE

定数

public static const LAYOUT_NAMESPACE:String = "http://www.osmf.org/layout/1.0"

言語バージョン:

ActionScript 3.0

製品バージョン:

OSMF 1.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

MediaElement または MediaContainer に追加されるときの LayoutMetadata オブジェクトの名前空間 URL です。

例この例の使用方法

LayoutMetadataExample.as

package org.osmf.layout
{
    import flash.display.Sprite;
    
    import org.osmf.media.MediaPlayerSprite;
    import org.osmf.media.URLResource;

    public class LayoutMetadataExample extends Sprite
    {
        public function LayoutMetadataExample()
        {
            var sprite:MediaPlayerSprite = new MediaPlayerSprite();
            addChild(sprite);
            
            sprite.resource = new URLResource("http://mediapm.edgesuite.net/strobe/content/test/AFaerysTale_sylviaApostol_640_500_short.flv");
            
            // Construct a metadata instance, and set an absolute width and height of 
            // 100 pixels:
            var layoutMetadata:LayoutMetadata = new LayoutMetadata();
            layoutMetadata.width = 100;
            layoutMetadata.height = 100;
            
            // Apply the layout metadata to the media element at hand, resulting
            // in the video to be shown at 100x100 pixels:
            sprite.media.addMetadata(LayoutMetadata.LAYOUT_NAMESPACE, layoutMetadata);
        }
        
    }
}

法律上の注意 | プライバシーポリシー

LayoutMetadata - AS3 OSMF

クラス x

bottom

height

horizontalAlign

includeInLayout

index

layoutMode

left

paddingBottom

paddingLeft

paddingRight

paddingTop

percentHeight

percentWidth

percentX

percentY

right

scaleMode

snapToPixel

top

verticalAlign

width

x

y

LayoutMetadata

LAYOUT_NAMESPACE