LetterInstance

Package	com.adobe.icc.dc.domain
Classe	public class LetterInstance
Héritage	LetterInstance EventDispatcher Object
Implémente	IValidation

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

This class is the runtime representation of the letter.

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
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		data : String [lecture seule] Bindable/Read-only.	LetterInstance
		dataDictionaryRef : String [lecture seule] Returns name of the data dictionary used in this letter instance.	LetterInstance
		description : String [lecture seule] Description of the underlying object.	LetterInstance
		fieldInstances : IList [lecture seule] Collection of FieldInstance objects that represent the domain model for Letter fields	LetterInstance
		formName : String [lecture seule] Returns name of the form associated with this letter instance.	LetterInstance
		id : String [lecture seule] Unique identification of this instance of letter.	LetterInstance
		letter : Letter [lecture seule] The letter loaded and being filled.	LetterInstance
		name : String [lecture seule] Name of the underlying object.	LetterInstance
		state : int [lecture seule] Returns state of this letter instance.	LetterInstance
		targetInstances : IList [lecture seule] Collection of TargetInstance objects that represent the current state of content selection as well as optional content for each content target in the current letter.	LetterInstance
		useLatest : Boolean [lecture seule] True if the letter uses latest asset while reload of the letter.	LetterInstance
		valid : Boolean [lecture seule] Boolean indicating whether the content is valid	LetterInstance
		variableInstances : IList [lecture seule] Collection of VariableInstance objects that represent Variables used in currently Selected Content.	LetterInstance
		version : int [lecture seule] Returns version of this letter instance.	LetterInstance
		xmlData : XML [lecture seule] Bindable/Read-only.	LetterInstance

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		LetterInstance(letter:Letter, ddi:DataDictionaryInstanceModel, initialXmlData:XML, params:Map = null) Constructor.	LetterInstance
		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
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		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.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		initialize():void The function that performs the initialization of the Letter instance.This should be called after form bridge has connected.	LetterInstance
		isPrototypeOf(theClass:Object):Boolean 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
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		refresh():void Refresh should be called when item is selected.	LetterInstance
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		validate():void Function which checks if any of the target area or field instance associated with this Letter instance are invalid.	LetterInstance
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		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é.	EventDispatcher

Evénements

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

Masquer les événements hérités

Afficher les événements hérités

	Evénement		Synthèse	Défini par
		activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
		deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher

Constantes publiques

	Constante		Défini par
		EVENT_LETTER_INITIALIZATION_COMPLETE : String = "letterInitializationComplete" [statique] The constant defining the letter initialization complete event.	LetterInstance
		EVENT_LETTER_INITIALIZATION_ERROR : String = "letterInitializationError" [statique] The constant defining the letter initialization error event.	LetterInstance
		PARAM_USELATEST : * = useLatest [statique] The constant indicating that letter uses latest asset on previewing the letter.	LetterInstance

Détails de la propriété

data

propriété

data:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Bindable/Read-only. Get the raw ICC Data to merge with a letter.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get data():String

Eléments de l’API associés

muted

dataDictionaryRef

propriété

dataDictionaryRef:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Returns name of the data dictionary used in this letter instance.

Implémentation
public function get dataDictionaryRef():String

description

propriété

description:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Description of the underlying object.

Implémentation
public function get description():String

fieldInstances

propriété

fieldInstances:IList [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Collection of FieldInstance objects that represent the domain model for Letter fields

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get fieldInstances():IList

formName

propriété

formName:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Returns name of the form associated with this letter instance.

Implémentation
public function get formName():String

id

propriété

id:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Unique identification of this instance of letter.

Implémentation
public function get id():String

letter

propriété

letter:Letter [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

The letter loaded and being filled.

Implémentation
public function get letter():Letter

name

propriété

name:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Name of the underlying object.

Implémentation
public function get name():String

state

propriété

state:int [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Returns state of this letter instance.

Implémentation
public function get state():int

targetInstances

propriété

targetInstances:IList [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Collection of TargetInstance objects that represent the current state of content selection as well as optional content for each content target in the current letter.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get targetInstances():IList

useLatest

propriété

useLatest:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

True if the letter uses latest asset while reload of the letter.

Implémentation
public function get useLatest():Boolean

valid

propriété

valid:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Boolean indicating whether the content is valid

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get valid():Boolean

variableInstances

propriété

variableInstances:IList [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Collection of VariableInstance objects that represent Variables used in currently Selected Content.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get variableInstances():IList

version

propriété

version:int [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Returns version of this letter instance.

Implémentation
public function get version():int

xmlData

propriété

xmlData:XML [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Bindable/Read-only. Get the ICC Data to merge with a letter.

Warning: Be careful when serializing this to a string as XML.toXMLString() will not respect XFA's use of space runs in XHTML.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get xmlData():XML

Eléments de l’API associés

muted

Détails du constructeur

()

Constructeur

public function LetterInstance(letter:Letter, ddi:DataDictionaryInstanceModel, initialXmlData:XML, params:Map = null)

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Constructor.

Paramètres

	`letter:Letter` — Fully populated Letter object

	`ddi:DataDictionaryInstanceModel` — data Dictionary Instance

	`initialXmlData:XML` — initialXml Data containing Icc Control Data if any. This XML is owned by LetterInstance

	`params:Map` (default = `null`) — A Map of parameters to be passed to this Letter instance. This can be any set of key/value pairs that is relevant to the Letter instance.

Détails de la méthode

initialize

()

méthode

public function initialize():void

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

The function that performs the initialization of the Letter instance.This should be called after form bridge has connected.

refresh

()

méthode

public function refresh():void

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Refresh should be called when item is selected. This is useful in case when the the item is deselcted. In that case, if there is any change in variable value/ field value etc., those changes may not be propagated to module.

validate

()

méthode

public function validate():void

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

Function which checks if any of the target area or field instance associated with this Letter instance are invalid.

Détails de la constante

EVENT_LETTER_INITIALIZATION_COMPLETE

Constante

public static const EVENT_LETTER_INITIALIZATION_COMPLETE:String = "letterInitializationComplete"

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

The constant defining the letter initialization complete event.

EVENT_LETTER_INITIALIZATION_ERROR

Constante

public static const EVENT_LETTER_INITIALIZATION_ERROR:String = "letterInitializationError"

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

The constant defining the letter initialization error event.

PARAM_USELATEST

Constante

public static const PARAM_USELATEST:* = useLatest

Version du langage:

ActionScript 3.0

Version du produit:

Bloc de création Asset Composer 10.0

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 10.2

The constant indicating that letter uses latest asset on previewing the letter.

Informations juridiques | Politique de confidentialité en ligne

LetterInstance - AS3 Asset Composer

Classes x

data

dataDictionaryRef

description

fieldInstances

formName

id

letter

name

state

targetInstances

useLatest

valid

variableInstances

version

xmlData

LetterInstance

initialize

refresh

validate

EVENT_LETTER_INITIALIZATION_COMPLETE

EVENT_LETTER_INITIALIZATION_ERROR

PARAM_USELATEST