| Пакет | 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 | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
|
Хранит указанное значение в этом объекте Metadata с использованием определенного ключа. | Metadata | |
|
Посылает событие в поток событий. | EventDispatcher | |
|
Возвращает значение, связанное с указанным ключом. | Metadata | |
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
|
Удаляет значение, связанное с указанным ключом из этого объекта Metadata. | Metadata | |
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
События
Общедоступные константы
| Константа | Определено | ||
|---|---|---|---|
| LAYOUT_NAMESPACE : String = "http://www.osmf.org/layout/1.0" [статические]
URL-адрес пространства имен для объектов LayoutMetadata при добавлении в MediaElement или MediaContainer. | 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):voidheight | свойство |
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):voidincludeInLayout | свойство |
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):voidindex | свойство |
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):voidleft | свойство |
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):voidpaddingLeft | свойство |
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):voidpaddingRight | свойство |
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):voidpaddingTop | свойство |
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):voidpercentHeight | свойство |
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):voidpercentWidth | свойство |
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):voidpercentX | свойство |
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):voidpercentY | свойство |
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):voidright | свойство |
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):voidscaleMode | свойство |
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):voidsnapToPixel | свойство |
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):voidtop | свойство |
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):voidwidth | свойство |
x | свойство |
y | свойство |
Сведения о конструкторе
LayoutMetadata | () | Конструктор |
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 |
URL-адрес пространства имен для объектов LayoutMetadata при добавлении в MediaElement или MediaContainer.
Примеры Использование этого примера
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);
}
}
}
Tue Jun 12 2018, 11:34 AM Z