| Package | ga.model |
| Class | public class GuidedActivity |
| Inheritance | GuidedActivity  Section Node ArrayCollection ListCollectionView Proxy |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
GuidedActivity class contains Guide properties.
Default MXML Propertysource
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | 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
A function that the view will use to eliminate items that do not
match the function's criteria. | 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 [static] [read-only]
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 [read-only]
The number of items in this view. | ListCollectionView | |
| list : IList
The IList that this collection view wraps. | 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
The ISort that will be applied to the ICollectionView. | ListCollectionView | |
| source : Array
The source of data in the 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 | ||
| Constant | Defined By | ||
|---|---|---|---|
| SUBMIT_FROM_GUIDE : String = "guide" [static]
A value for the submitFrom property. | GuidedActivity | ||
| SUBMIT_FROM_HOST : String = "host" [static]
A value for the submitFrom property. | GuidedActivity | ||
| SUBMIT_FROM_PDF : String = "pdf" [static]
A value for the submitFrom property. | GuidedActivity | ||
| SUBMIT_FROM_PRINT : String = "print" [static]
A value for the submitFrom property. | GuidedActivity | ||
| SUBMIT_FROM_USER_BUTTON : String = "userButton" [static]
A value for the submitFrom property. | GuidedActivity | ||
| VALIDATE_ON_PANEL_EXIT : String = "onPanelExit" [static]
A value for the enforceValidation property. | GuidedActivity | ||
| VALIDATE_ON_SUBMIT : String = "onSubmit" [static]
A value for the enforceValidation property. | GuidedActivity | ||
enforceValidation | property |
public var enforceValidation:String = "onSubmit"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | property |
helpText:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
[bindable] The Guide help text, in rich text format, specified in the Guide Design perspective within Workbench.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get helpText():String public function set helpText(value:String):voidhelpTitle | property |
helpTitle:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
[bindable] The Guide help title specified in the Guide Design perspective within Workbench.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get helpTitle():String public function set helpTitle(value:String):voidhelpVideo | property |
helpVideo:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
[bindable] The URL for an FLV file specified in the Guide Design perspective within Workbench.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get helpVideo():String public function set helpVideo(value:String):voidinstance | property |
instance:GuidedActivity [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns the singleton instance of this model.
Implementation
public static function get instance():GuidedActivityinteractivePdfValidate | property |
public var interactivePdfValidate:String = "'false'"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9.0.0.1 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates whether to run validation before flipping to the interactive PDF document view.
name | property |
panelTransitionDuration | property |
public var panelTransitionDuration:int = 500| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The time, in milliseconds, for the duration of the panel transition.
previewAsset | property |
public var previewAsset:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | property |
public var previewMode:String = "DOR"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | property |
public var previewUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | property |
public var previewValidate:String = "'true'"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | property |
public var startupEffectDuration:int = 500| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The time, in milliseconds, for the duration of the start-up effect.
submitAll | property |
public var submitAll:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
When false, field data in an optional panel is cleared when the panel is made invisible.
submitFrom | property |
public var submitFrom:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | property |
public var taskId:String = "null"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
TaskId passed in as a flashVar. If present is included as a custom header during submit.
SUBMIT_FROM_GUIDE | Constant |
public static const SUBMIT_FROM_GUIDE:String = "guide"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | Constant |
public static const SUBMIT_FROM_HOST:String = "host"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | Constant |
public static const SUBMIT_FROM_PDF:String = "pdf"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | Constant |
public static const SUBMIT_FROM_PRINT:String = "print"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | Constant |
public static const SUBMIT_FROM_USER_BUTTON:String = "userButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | Constant |
public static const VALIDATE_ON_PANEL_EXIT:String = "onPanelExit"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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 | Constant |
public static const VALIDATE_ON_SUBMIT:String = "onSubmit"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | 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.
Mon Apr 10 2017, 12:28 PM -07:00