LayoutMetadata

包	org.osmf.layout
类	public class LayoutMetadata
继承	LayoutMetadata Metadata EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

定义包含属性的 Metadata 对象，布局呈示器以这些属性为基础的构建其布局。

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		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），将其元素的布局构建为与“索引”属性指定的索引相邻。	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），将其元素的布局构建为与“索引”属性指定的索引相邻。

实现
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