GuidedActivity - Guide de référence de l’API Adobe ActionScript® 3 (AS3 ADEP Guides)

Package	ga.model
Classe	public class GuidedActivity
Héritage	GuidedActivity Section Node ArrayCollection ListCollectionView Proxy

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

The GuidedActivity class contains Guide properties.

Propriété MXML par défautsource

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
		dataRef : String	Section
		designIndex : int	Section
		enforceValidation : String = "onSubmit" Specifies when to check for mantatory fields, either when the user submits a Guide, or when a user navigates to the next panel in the Guide.	GuidedActivity
		filterFunction : Function Fonction que la vue utilisera pour éliminer les éléments qui ne correspondent pas aux critères de la fonction.	ListCollectionView
		helpText : String [bindable] The Guide help text, in rich text format, specified in the Guide Design perspective within Workbench.	GuidedActivity
		helpTitle : String [bindable] The Guide help title specified in the Guide Design perspective within Workbench.	GuidedActivity
		helpVideo : String [bindable] The URL for an FLV file specified in the Guide Design perspective within Workbench.	GuidedActivity
		instance : GuidedActivity [statique] [lecture seule] Returns the singleton instance of this model.	GuidedActivity
		interactivePdfValidate : String = "'false'" Indicates whether to run validation before flipping to the interactive PDF document view.	GuidedActivity
		_itemInstance : Object	Section
		length : int [lecture seule] Nombre d’éléments présents dans cette vue.	ListCollectionView
		list : IList Interface IList enveloppée par cette vue de collection.	ListCollectionView
		name : String	GuidedActivity
		panelTransitionDuration : int = 500 The time, in milliseconds, for the duration of the panel transition.	GuidedActivity
		previewAsset : String When provided will set the containing host HTML PDFURL variable (if it is empty).	GuidedActivity
		previewMode : String = "DOR" Indicates whether DOR or interactive preview document communication is desired.	GuidedActivity
		previewUrl : String When provided will set the containing host HTML PDFURL variable (if it is empty).	GuidedActivity
		previewValidate : String = "'true'" Indicates whether to run validation before flipping to the preview document view.	GuidedActivity
		sectionId : String	Section
		sectionIndex : *	Section
		sectionManager : Boolean	Section
		sectionManagers : Array	Section
		sort : ISort L’objet ISort qui sera appliqué à l’interface ICollectionView.	ListCollectionView
		source : Array Source des données dans l’instance ArrayCollection.	ArrayCollection
		startupEffectDuration : int = 500 The time, in milliseconds, for the duration of the start-up effect.	GuidedActivity
		submitAll : Boolean = true When false, field data in an optional panel is cleared when the panel is made invisible.	GuidedActivity
		submitFrom : String Where the submit button should be clicked.	GuidedActivity
		taskId : String = "null" TaskId passed in as a flashVar.	GuidedActivity

Propriétés protégées

Masquer les propriétés protégées héritées

Afficher les propriétés protégées héritées

	Propriété		Défini par
		localIndex : Array Lorsque la vue est triée ou filtrée, la propriété localIndex contient un tableau d’éléments dans la vue triée ou filtrée (ordonnée ou réduite), dans l’ordre de tri.	ListCollectionView

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		addAll(addList:IList):void Ajoute une liste d’éléments à la liste actuelle, en les plaçant à la fin de la liste, dans l’ordre dans lequel ils sont transmis.	ListCollectionView
		addAllAt(addList:IList, index:int):void Ajoute une liste d’éléments à la liste actuelle, en les plaçant à l’index de position transmis à la fonction.	ListCollectionView
		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.	ListCollectionView
		addItem(item:Object):void Ajoute l’élément spécifié à la fin de la liste.	ListCollectionView
		addItemAt(item:Object, index:int):void Ajoute l’élément à l’index spécifié.	ListCollectionView
		contains(item:Object):Boolean Indique en retour si la vue contient l’objet spécifié.	ListCollectionView
		createCursor():IViewCursor Crée une nouvelle interface IViewCursor fonctionnant avec cette vue.	ListCollectionView
		disableAutoUpdate():void Empêche la vue de distribuer les modifications apportées à la collection et aux éléments de la collection.	ListCollectionView
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	ListCollectionView
		enableAutoUpdate():void Active la mise à jour automatique.	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object Obtient l’élément qui se trouve à l’index spécifié.	ListCollectionView
		getItemIndex(item:Object):int Renvoie l’index de l’élément s’il se trouve dans la liste, de sorte que getItemAt(index) == élément.	ListCollectionView
		getQualifiedDataRef(object:Object):String Returns a fully qualified data reference for the current section's instance.	Section
		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.	ListCollectionView
		initDataProvider():void Sets the instance manager and the data provider for this repeating panel	Section
		initialized(document:Object, id:String):void Appelée automatiquement par le compilateur MXML lorsqu’une instance ListCollectionView est créée en utilisant une balise MXML.	ListCollectionView
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Signale à la vue qu’un élément a été mis à jour.	ListCollectionView
		refresh():Boolean Applique le tri et le filtre à la vue.	ListCollectionView
		removeAll():void Supprime tous les éléments de la liste.	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	ListCollectionView
		removeItemAt(index:int):Object Supprime l’élément qui se trouve à l’index spécifié et le renvoie.	ListCollectionView
		setItemAt(item:Object, index:int):Object Place l’élément à l’index spécifié.	ListCollectionView
		toArray():Array Renvoie un tableau rempli dans le même ordre en tant que qu’implémentation IList.	ListCollectionView
		toString():String Imprime le contenu de cette vue dans une chaîne et la renvoie.	ListCollectionView
		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é.	ListCollectionView

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
		collectionChange	Distribué lorsque l’interface ICollectionView a été mise à jour.	ListCollectionView

Constantes publiques

	Constante		Défini par
		SUBMIT_FROM_GUIDE : String = "guide" [statique] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_HOST : String = "host" [statique] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_PDF : String = "pdf" [statique] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_PRINT : String = "print" [statique] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_USER_BUTTON : String = "userButton" [statique] A value for the submitFrom property.	GuidedActivity
		VALIDATE_ON_PANEL_EXIT : String = "onPanelExit" [statique] A value for the enforceValidation property.	GuidedActivity
		VALIDATE_ON_SUBMIT : String = "onSubmit" [statique] A value for the enforceValidation property.	GuidedActivity

Détails de la propriété

enforceValidation

propriété

public var enforceValidation:String = "onSubmit"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

Specifies when to check for mantatory fields, either when the user submits a Guide, or when a user navigates to the next panel in the Guide. The value of this property is set using either the VALIDATE_ON_SUBMIT or VALIDATE_ON_PANEL_EXIT constant.

helpText

propriété

helpText:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

[bindable] The Guide help text, in rich text format, specified in the Guide Design perspective within Workbench.

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 helpText():String
public function set helpText(value:String):void

helpTitle

propriété

helpTitle:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

[bindable] The Guide help title specified in the Guide Design perspective within Workbench.

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 helpTitle():String
public function set helpTitle(value:String):void

helpVideo

propriété

helpVideo:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

[bindable] The URL for an FLV file specified in the Guide Design perspective within Workbench.

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 helpVideo():String
public function set helpVideo(value:String):void

instance

propriété

instance:GuidedActivity [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

Returns the singleton instance of this model.

Implémentation
public static function get instance():GuidedActivity

interactivePdfValidate

propriété

public var interactivePdfValidate:String = "'false'"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9.0.0.1

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

Indicates whether to run validation before flipping to the interactive PDF document view.

name

propriété

name:String

Implémentation
public function get name():String
public function set name(value:String):void

panelTransitionDuration

propriété

public var panelTransitionDuration:int = 500

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

The time, in milliseconds, for the duration of the panel transition.

previewAsset

propriété

public var previewAsset:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

When provided will set the containing host HTML PDFURL variable (if it is empty). When PDFURL has a value in it

previewMode

propriété

public var previewMode:String = "DOR"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

Indicates whether DOR or interactive preview document communication is desired. When PDFURL has a value in it

previewUrl

propriété

public var previewUrl:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

When provided will set the containing host HTML PDFURL variable (if it is empty). When PDFURL has a value in it

previewValidate

propriété

public var previewValidate:String = "'true'"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

Indicates whether to run validation before flipping to the preview document view. When previewUrl has a value in it

startupEffectDuration

propriété

public var startupEffectDuration:int = 500

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

The time, in milliseconds, for the duration of the start-up effect.

submitAll

propriété

public var submitAll:Boolean = true

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

When false, field data in an optional panel is cleared when the panel is made invisible.

submitFrom

propriété

public var submitFrom:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

Where the submit button should be clicked.

The value of this property is set using one of the following constants:

SUBMIT_FROM_GUIDE
SUBMIT_FROM_HOST
SUBMIT_FROM_USER_BUTTON
SUBMIT_FROM_PDF
SUBMIT_FROM_PRINT

taskId

propriété

public var taskId:String = "null"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 10

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

TaskId passed in as a flashVar. If present is included as a custom header during submit.

Détails de la constante

SUBMIT_FROM_GUIDE

Constante

public static const SUBMIT_FROM_GUIDE:String = "guide"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that data submission is performed by the Guide.

SUBMIT_FROM_HOST

Constante

public static const SUBMIT_FROM_HOST:String = "host"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the submitFrom property. This value is set by the Submit From option in the Guide Design perspective within Workbench, and indicates that the data submission handling is performed by a hosted application, therefore no submit button will appear in the Guide.

SUBMIT_FROM_PDF

Constante

public static const SUBMIT_FROM_PDF:String = "pdf"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that data submission handling is performed by the PDF. If no PDF is available, then the data sumission is performed by the Guide.

SUBMIT_FROM_PRINT

Constante

public static const SUBMIT_FROM_PRINT:String = "print"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that the data submission will be in the form of a printed copy of the PDF.

SUBMIT_FROM_USER_BUTTON

Constante

public static const SUBMIT_FROM_USER_BUTTON:String = "userButton"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the submitFrom property. This value is set by the Submit From option in Guide Builder and indicates that data submission is performed by the Guide.

VALIDATE_ON_PANEL_EXIT

Constante

public static const VALIDATE_ON_PANEL_EXIT:String = "onPanelExit"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the enforceValidation property. This value is set by the Enforce Validation option in the Guide Design perspective within Workbench, and indicates that validation is performed before navigating to another panel.

VALIDATE_ON_SUBMIT

Constante

public static const VALIDATE_ON_SUBMIT:String = "onSubmit"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Guides 9

Versions du moteur d’exécution:

AIR 1.0, Flash Player 10.2

A value for the enforceValidation property. This value is set by the Enforce Validation option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0, and indicates that validation is performed when the submit button is clicked.

Informations juridiques | Politique de confidentialité en ligne

GuidedActivity - AS3 ADEP Guides

Classes x

enforceValidation

helpText

helpTitle

helpVideo

instance

interactivePdfValidate

name

panelTransitionDuration

previewAsset

previewMode

previewUrl

previewValidate

startupEffectDuration

submitAll

submitFrom

taskId

SUBMIT_FROM_GUIDE

SUBMIT_FROM_HOST

SUBMIT_FROM_PDF

SUBMIT_FROM_PRINT

SUBMIT_FROM_USER_BUTTON

VALIDATE_ON_PANEL_EXIT

VALIDATE_ON_SUBMIT