IModuleInfo - Guide de référence de l’API Adobe ActionScript® 3 (AS3 Flex)

Package	mx.modules
Interface	public interface IModuleInfo extends IEventDispatcher

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Interface agissant en tant que descripteur pour un module spécifique. Depuis cette interface, le statut de module peut être interrogé, sa fabrique interne peut être obtenue et il peut être chargé ou déchargé.

Propriétés publiques

	Propriété		Défini par
		data : Object Données utilisateur pouvant être associées au singleton IModuleInfo pour une URL donnée.	IModuleInfo
		error : Boolean [lecture seule] Balise ayant la valeur true si une erreur s’est produite lors du chargement du module.	IModuleInfo
		factory : IFlexModuleFactory [lecture seule] Implémentation IFlexModuleFactory définie dans le module.	IModuleInfo
		loaded : Boolean [lecture seule] Balise comportant la valeur true si la méthode load() a été appelée sur ce module.	IModuleInfo
		ready : Boolean [lecture seule] Balise comportant la valeur true si le module est suffisamment chargé pour obtenir un descripteur de son implémentation IFlexModuleFactory associée et appeler sa méthode create().	IModuleInfo
		setup : Boolean [lecture seule] Balise comportant la valeur true si le module est suffisamment chargé pour obtenir un descripteur de son implémentation IFlexModuleFactory associée et appeler sa méthode info().	IModuleInfo
		url : String [lecture seule] URL associée à ce module (par exemple, « MyImageModule.swf ». ou « http://somedomain.com/modules/MyImageModule.swf ».).	IModuleInfo

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		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.	IEventDispatcher
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	IEventDispatcher
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	IEventDispatcher
		load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null, moduleFactory:IFlexModuleFactory = null):void Demande que le module soit chargé.	IModuleInfo
		publish(factory:IFlexModuleFactory):void Publie une interface dans la classe ModuleManager.	IModuleInfo
		release():void Publie la référence au module actuelle.	IModuleInfo
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	IEventDispatcher
		unload():void Décharge le module.	IModuleInfo
		willTrigger(type:String):Boolean 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é.	IEventDispatcher

Evénements

Cliquez pour plus d’informations sur les événements

	Synthèse	Défini par
error	Distribué par les informations ModuleInfo de supports si une erreur s’est produite lors du chargement du module.	IModuleInfo
progress	Distribué par les informations ModuleInfo de supports à intervalles réguliers pendant que le module est en train d’être chargé.	IModuleInfo
ready	Distribué par les informations ModuleInfo de support une fois que le module est suffisamment chargé pour appeler les méthodes IModuleInfo.factory() et IFlexModuleFactory.create().	IModuleInfo
setup	Distribué par les informations ModuleInfo de support une fois que le module est suffisamment chargé pour appeler les méthodes IModuleInfo.factory() et IFlexModuleFactory.info().	IModuleInfo
unload	Distribué par les informations ModuleInfo de support lorsque les données de module sont déchargées.	IModuleInfo

Détails de la propriété

data

propriété

data:Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Données utilisateur pouvant être associées au singleton IModuleInfo pour une URL donnée.

Implémentation
public function get data():Object
public function set data(value:Object):void

error

propriété

error:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Balise ayant la valeur true si une erreur s’est produite lors du chargement du module.

Cette balise comporte la valeur true lorsque la classe ModuleManager distribue l’événement ModuleEvent.ERROR.

Implémentation
public function get error():Boolean

factory

propriété

factory:IFlexModuleFactory [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Implémentation IFlexModuleFactory définie dans le module. Cela est uniquement non-null une fois que l’événement ModuleEvent.SETUP a été distribué (ou que la méthode IModuleInfo.setup() renvoie true). A ce stade, la méthode IFlexModuleFactory.info() peut être appelée. Une fois qu’un événement ModuleEvent.READY est distribué (ou que la méthode IModuleInfo.ready() renvoie true), il est possible d’appeler la méthode IFlexModuleFactory.create().

Implémentation
public function get factory():IFlexModuleFactory

loaded

propriété

loaded:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Balise comportant la valeur true si la méthode load() a été appelée sur ce module.

Implémentation
public function get loaded():Boolean

ready

propriété

ready:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Balise comportant la valeur true si le module est suffisamment chargé pour obtenir un descripteur de son implémentation IFlexModuleFactory associée et appeler sa méthode create().

Cette balise comporte la valeur true lorsque la classe ModuleManager distribue l’événement ModuleEvent.READY.

Implémentation
public function get ready():Boolean

setup

propriété

setup:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Balise comportant la valeur true si le module est suffisamment chargé pour obtenir un descripteur de son implémentation IFlexModuleFactory associée et appeler sa méthode info().

Cette balise comporte la valeur true lorsque la classe ModuleManager distribue l’événement ModuleEvent.SETUP.

Implémentation
public function get setup():Boolean

url

propriété

url:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

URL associée à ce module (par exemple, « MyImageModule.swf ». ou « http://somedomain.com/modules/MyImageModule.swf ».). L’URL peut être locale ou distante, mais si elle est distante, vous devez établir une confiance entre le domaine du module et l’application qui le charge.

Implémentation
public function get url():String

Détails de la méthode

load

()

méthode

 public function load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null, moduleFactory:IFlexModuleFactory = null):void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Demande que le module soit chargé. Si le module est déjà chargé, l’appel ne fait rien. Dans le cas contraire, le module commence à se charger et distribue des événements progress tout au long du chargement.

Paramètres

	`applicationDomain:ApplicationDomain` (default = `null`) — Domaine d’application actuel dans lequel votre code s’exécute.

	`securityDomain:SecurityDomain` (default = `null`) — « sandbox » de sécurité actuel.

	`bytes:ByteArray` (default = `null`) — Objet ByteArray. L’objet ByteArray est supposé contenir les octets d’un fichier SWF représentant un module compilé. L’objet ByteArray peut être obtenu via l’utilisation de la classe URLLoader. Si ce paramètre est spécifié, le module est chargé depuis l’objet ByteArray. Si ce paramètre est nul, le module est chargé depuis l’URL spécifiée dans la propriété url.

	`moduleFactory:IFlexModuleFactory` (default = `null`) — moduleFactory de l’appelant. Une utilisation de la propriété moduleFactory consiste à déterminer le gestionnaire de style parent du module chargé.

publish

()

méthode

public function publish(factory:IFlexModuleFactory):void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Publie une interface dans la classe ModuleManager. Cela permet des abonnements tardifs (ou découplés) à des fabriques avec un descripteur de chaîne. Utilisez une URL qui commence par publish:// pour référencer les fabriques publiées de cette manière.

Paramètres

factory:IFlexModuleFactory — Classe qui implémente l’interface IFlexModuleFactory du module.

Eléments de l’API associés

mx.modules.ModuleManager

release

()

méthode

public function release():void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Publie la référence au module actuelle. Cela ne décharge pas le module, sauf s’il n’existe aucune autre référence ouverte au module et que la classe ModuleManager est configurée de manière à ne comporter qu’un nombre limité de modules chargés.

Eléments de l’API associés

mx.modules.ModuleManager

unload

()

méthode

public function unload():void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Décharge le module. Flash Player et AIR ne déchargeront pas et ne nettoieront pas entièrement ce module s’il existe des références à des définitions en attente dans le module.

Détails de l’événement

error

Evénement

Type d’objet d’événement: mx.events.ModuleEvent
propriété ModuleEvent.type = mx.events.ModuleEvent.ERROR

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué par les informations ModuleInfo de supports si une erreur s’est produite lors du chargement du module.

Distribué lorsqu’une erreur se produit lors du téléchargement du module. La constante ModuleEvent.ERROR définit la valeur de la propriété type de l’objet d’événement d’un événement error.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`bytesLoaded`	Vide
`bytesTotal`	Vide
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`errorText`	Message d’erreur.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

progress

Evénement

Type d’objet d’événement: mx.events.ModuleEvent
propriété ModuleEvent.type = mx.events.ModuleEvent.PROGRESS

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué par les informations ModuleInfo de supports à intervalles réguliers pendant que le module est en train d’être chargé.

Distribué lorsque le module est en cours de téléchargement. Le module est distribué à intervalle régulier pendant le processus de téléchargement. La constante ModuleEvent.PROGRESS définit la valeur de la propriété type de l’objet d’événement d’un événement progress.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`bytesLoaded`	Nombre d’octets chargés.
`bytesTotal`	Nombre total d’octets à charger.
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`errorText`	Vide
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

ready

Evénement

Type d’objet d’événement: mx.events.ModuleEvent
propriété ModuleEvent.type = mx.events.ModuleEvent.READY

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué par les informations ModuleInfo de support une fois que le module est suffisamment chargé pour appeler les méthodes IModuleInfo.factory() et IFlexModuleFactory.create().

Distribué lorsque le téléchargement du module est terminé. La constante ModuleEvent.READY définit la valeur de la propriété type de l’objet d’événement d’un événement complete.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`bytesLoaded`	Nombre d’octets chargés.
`bytesTotal`	Nombre total d’octets à charger.
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`errorText`	Vide
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

setup

Evénement

Type d’objet d’événement: mx.events.ModuleEvent
propriété ModuleEvent.type = mx.events.ModuleEvent.SETUP

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué par les informations ModuleInfo de support une fois que le module est suffisamment chargé pour appeler les méthodes IModuleInfo.factory() et IFlexModuleFactory.info().

Distribué lorsque le téléchargement d’un module est suffisamment avancé qu’il est possible d’obtenir des informations sur le module. Pour ce faire, appelez la méthode IFlexModuleFactory.info() sur le module. La constante ModuleEvent.SETUP définit la valeur de la propriété type de l’objet d’événement d’un événement setup.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`bytesLoaded`	Vide
`bytesTotal`	Vide
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`errorText`	Message d’erreur.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

unload

Evénement

Type d’objet d’événement: mx.events.ModuleEvent
propriété ModuleEvent.type = mx.events.ModuleEvent.UNLOAD

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué par les informations ModuleInfo de support lorsque les données de module sont déchargées.

Distribué lorsque le module est déchargé. La constante ModuleEvent.UNLOAD définit la valeur de la propriété type de l’objet d’événement d’un événement unload.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`bytesLoaded`	Vide
`bytesTotal`	Vide
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`errorText`	Message d’erreur.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

Informations juridiques | Politique de confidentialité en ligne

IModuleInfo - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.modules

data

error

factory

loaded

ready

setup

url

load

publish

release

unload

error

progress

ready

setup

unload