| Package | org.osmf.layout |
| Classe | public class LayoutMetadata |
| Héritage | LayoutMetadata  Metadata EventDispatcher Object |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Propriétés publiques
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
| bottom : Number
Définit le nombre de pixels obligatoire entre le bas du cadre de sélection de la cible et le bas de son conteneur. | LayoutMetadata | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| height : Number
Définit le décalage vertical désiré d’une cible exprimé en pixels. | LayoutMetadata | ||
| horizontalAlign : String
Définit l’alignement horizontal désiré à appliquer à la cible lorsque la mise en forme de la cible laisse un espace horizontal vide en trop. | LayoutMetadata | ||
| includeInLayout : Boolean
Lorsqu’elle est définie sur true (par défaut), la cible doit participer au processus de mise en forme. | LayoutMetadata | ||
| index : Number
Définit la position souhaitée de la cible dans la liste d’affichage de son contexte. | LayoutMetadata | ||
| keys : Vector.<String> [lecture seule]
Les clés stockées dans cet objet Metadata. | Metadata | |
| layoutMode : String
Lorsqu’il est défini sur LayoutMode.HORIZONTAL ou LayoutMode.VERTICAL, la fonction de rendu ignore les paramètres de positionnement de la cible (influençant X ou Y, en fonction du layoutMode choisi), agençant ses éléments adjacents dans l’index indiqué par la propriété ’index’. | LayoutMetadata | ||
| left : Number
Définit le décalage horizontal désiré de la cible en pixels. | LayoutMetadata | ||
| paddingBottom : Number
Définit l’épaisseur de l’espace vide à placer dans la partie inférieure de la cible. | LayoutMetadata | ||
| paddingLeft : Number
Définit l’épaisseur de l’espace vide à placer dans la partie gauche de la cible. | LayoutMetadata | ||
| paddingRight : Number
Définit l’épaisseur de l’espace vide à placer dans la partie droite de la cible. | LayoutMetadata | ||
| paddingTop : Number
Définit l’épaisseur de l’espace vide à placer dans la partie supérieure de la cible. | LayoutMetadata | ||
| percentHeight : Number
Définit la hauteur désirée d’une cible exprimée en pourcentage de la hauteur de son conteneur. | LayoutMetadata | ||
| percentWidth : Number
Définit la largeur désirée d’une cible exprimée en pourcentage de la largeur de son conteneur. | LayoutMetadata | ||
| percentX : Number
Définit le décalage horizontal désiré d’une cible exprimé en pourcentage de la largeur de son conteneur. | LayoutMetadata | ||
| percentY : Number
Définit le décalage vertical désiré d’une cible exprimé en pourcentage de la hauteur de son conteneur. | LayoutMetadata | ||
| right : Number
Définit le nombre de pixels obligatoire entre la partie droite du cadre de sélection de la cible et la partie droite de son conteneur. | LayoutMetadata | ||
| scaleMode : String
Définit le scaleMode désiré à appliquer à la cible. | LayoutMetadata | ||
| snapToPixel : Boolean
Lorsque la cible est définie sur true, sa position et sa taille calculées seront arrondies. | LayoutMetadata | ||
| top : Number
Définit le décalage vertical désiré de la cible en pixels. | LayoutMetadata | ||
| verticalAlign : String
Définit l’alignement vertical désiré à appliquer à la cible lorsque la mise en forme de la cible laisse un espace vertical vide en trop. | LayoutMetadata | ||
| width : Number
Définit la taille horizontale désirée d’une cible exprimée en pixels. | LayoutMetadata | ||
| x : Number
Définit le décalage horizontal désiré d’une cible exprimé en pixels. | LayoutMetadata | ||
| y : Number
Définit le décalage vertical désiré d’une cible exprimé en pixels. | LayoutMetadata | ||
Méthodes publiques
| Méthode | Défini par | ||
|---|---|---|---|
Constructeur. | LayoutMetadata | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
|
Stocke la valeur indiquée dans cet objet Metadata à l’aide de la clé spécifiée. | Metadata | |
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Renvoie la valeur associée à la clé spécifiée. | Metadata | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
|
Supprime la valeur associée à la clé indiquée de cet objet Metadata. | Metadata | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
Evénements
Constantes publiques
| Constante | Défini par | ||
|---|---|---|---|
| LAYOUT_NAMESPACE : String = "http://www.osmf.org/layout/1.0" [statique]
URL d’espace de noms pour les objets LayoutMetadata lorsqu’ils sont ajoutés à un MediaElement ou un MediaContainer. | LayoutMetadata | ||
Détails de la propriété
bottom | propriété |
bottom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit le nombre de pixels obligatoire entre le bas du cadre de sélection de la cible et le bas de son conteneur.
Implémentation
public function get bottom():Number public function set bottom(value:Number):voidheight | propriété |
horizontalAlign | propriété |
horizontalAlign:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit l’alignement horizontal désiré à appliquer à la cible lorsque la mise en forme de la cible laisse un espace horizontal vide en trop.
Implémentation
public function get horizontalAlign():String public function set horizontalAlign(value:String):voidincludeInLayout | propriété |
includeInLayout:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Lorsqu’elle est définie sur true (par défaut), la cible doit participer au processus de mise en forme. Si défini sur false, il est ignoré.
Implémentation
public function get includeInLayout():Boolean public function set includeInLayout(value:Boolean):voidindex | propriété |
index:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit la position souhaitée de la cible dans la liste d’affichage de son contexte.
Implémentation
public function get index():Number public function set index(value:Number):voidlayoutMode | propriété |
layoutMode:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Lorsqu’il est défini sur LayoutMode.HORIZONTAL ou LayoutMode.VERTICAL, la fonction de rendu ignore les paramètres de positionnement de la cible (influençant X ou Y, en fonction du layoutMode choisi), agençant ses éléments adjacents dans l’index indiqué par la propriété ’index’.
Implémentation
public function get layoutMode():String public function set layoutMode(value:String):voidleft | propriété |
paddingBottom | propriété |
paddingBottom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit l’épaisseur de l’espace vide à placer dans la partie inférieure de la cible.
Implémentation
public function get paddingBottom():Number public function set paddingBottom(value:Number):voidpaddingLeft | propriété |
paddingLeft:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit l’épaisseur de l’espace vide à placer dans la partie gauche de la cible.
Implémentation
public function get paddingLeft():Number public function set paddingLeft(value:Number):voidpaddingRight | propriété |
paddingRight:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit l’épaisseur de l’espace vide à placer dans la partie droite de la cible.
Implémentation
public function get paddingRight():Number public function set paddingRight(value:Number):voidpaddingTop | propriété |
paddingTop:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit l’épaisseur de l’espace vide à placer dans la partie supérieure de la cible.
Implémentation
public function get paddingTop():Number public function set paddingTop(value:Number):voidpercentHeight | propriété |
percentHeight:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit la hauteur désirée d’une cible exprimée en pourcentage de la hauteur de son conteneur.
Implémentation
public function get percentHeight():Number public function set percentHeight(value:Number):voidpercentWidth | propriété |
percentWidth:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit la largeur désirée d’une cible exprimée en pourcentage de la largeur de son conteneur.
Implémentation
public function get percentWidth():Number public function set percentWidth(value:Number):voidpercentX | propriété |
percentX:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit le décalage horizontal désiré d’une cible exprimé en pourcentage de la largeur de son conteneur.
Implémentation
public function get percentX():Number public function set percentX(value:Number):voidpercentY | propriété |
percentY:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit le décalage vertical désiré d’une cible exprimé en pourcentage de la hauteur de son conteneur.
Implémentation
public function get percentY():Number public function set percentY(value:Number):voidright | propriété |
right:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit le nombre de pixels obligatoire entre la partie droite du cadre de sélection de la cible et la partie droite de son conteneur.
Implémentation
public function get right():Number public function set right(value:Number):voidscaleMode | propriété |
scaleMode:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit le scaleMode désiré à appliquer à la cible. Les valeurs possibles sont sur org.osmf.layout.ScaleMode.
Implémentation
public function get scaleMode():String public function set scaleMode(value:String):voidsnapToPixel | propriété |
snapToPixel:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Lorsque la cible est définie sur true, sa position et sa taille calculées seront arrondies.
Implémentation
public function get snapToPixel():Boolean public function set snapToPixel(value:Boolean):voidtop | propriété |
verticalAlign | propriété |
verticalAlign:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Définit l’alignement vertical désiré à appliquer à la cible lorsque la mise en forme de la cible laisse un espace vertical vide en trop.
Implémentation
public function get verticalAlign():String public function set verticalAlign(value:String):voidwidth | propriété |
x | propriété |
y | propriété |
Détails du constructeur
LayoutMetadata | () | Constructeur |
public function LayoutMetadata()| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Constructeur.
Détails de la constante
LAYOUT_NAMESPACE | Constante |
public static const LAYOUT_NAMESPACE:String = "http://www.osmf.org/layout/1.0"| Version du langage: | ActionScript 3.0 |
| Version du produit: | OSMF 1.0 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
URL d’espace de noms pour les objets LayoutMetadata lorsqu’ils sont ajoutés à un MediaElement ou un MediaContainer.
Exemples Comment utiliser cet exemple
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, 09:30 AM Z