BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: Retrieving Data from Server...
Retrieving Data from Server...
ga.model 

GuidedActivity  - AS3 ADEP Document Services
(Beta)
Packagega.model
Classpublic class GuidedActivity
InheritanceGuidedActivity Inheritance Section Inheritance Node Inheritance ArrayCollection Inheritance ListCollectionView Inheritance Proxy

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

The GuidedActivity class contains Guide properties.

Default MXML Propertysource


Public Properties
 PropertyDefined By
 InheriteddataRef : String
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
 InheritedfilterFunction : 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 LiveCycle Workbench ES2.
GuidedActivity
  helpTitle : String
[bindable] The Guide help title specified in the Guide Design perspective within LiveCycle Workbench ES2.
GuidedActivity
  helpVideo : String
[bindable] The URL for an FLV file specified in the Guide Design perspective within LiveCycle Workbench ES2.
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
 Inherited_itemInstance : Object
Section
 Inheritedlength : int
[read-only] The number of items in this view.
ListCollectionView
 Inheritedlist : 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
 InheritedsectionId : String
Section
 Inheritedsort : ISort
The ISort that will be applied to the ICollectionView.
ListCollectionView
 Inheritedsource : 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
Protected Properties
 PropertyDefined By
 InheritedlocalIndex : Array
When the view is sorted or filtered the localIndex property contains an array of items in the sorted or filtered (ordered, reduced) view, in the sorted order.
ListCollectionView
Public Methods
 MethodDefined By
 Inherited
addAll(addList:IList):void
Adds a list of items to the current list, placing them at the end of the list in the order they are passed.
ListCollectionView
 Inherited
addAllAt(addList:IList, index:int):void
Adds a list of items to the current list, placing them at the position index passed in to the function.
ListCollectionView
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
ListCollectionView
 Inherited
addItem(item:Object):void
Adds the specified item to the end of the list.
ListCollectionView
 Inherited
addItemAt(item:Object, index:int):void
Adds the item at the specified index.
ListCollectionView
 Inherited
contains(item:Object):Boolean
Returns whether the view contains the specified object.
ListCollectionView
 Inherited
createCursor():IViewCursor
Creates a new IViewCursor that works with this view.
ListCollectionView
 Inherited
disableAutoUpdate():void
Prevents changes to the collection itself and items within the collection from being dispatched by the view.
ListCollectionView
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
ListCollectionView
 Inherited
enableAutoUpdate():void
Enables auto-updating.
ListCollectionView
 Inherited
getItemAt(index:int, prefetch:int = 0):Object
Gets the item at the specified index.
ListCollectionView
 Inherited
getItemIndex(item:Object):int
Returns the index of the item if it is in the list such that getItemAt(index) == item.
ListCollectionView
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
ListCollectionView
 Inherited
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag.
ListCollectionView
 Inherited
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Notifies the view that an item has been updated.
ListCollectionView
 Inherited
refresh():Boolean
Applies the sort and filter to the view.
ListCollectionView
 Inherited
removeAll():void
Remove all items from the list.
ListCollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
ListCollectionView
 Inherited
removeItemAt(index:int):Object
Removes the item at the specified index and returns it.
ListCollectionView
 Inherited
setItemAt(item:Object, index:int):Object
Places the item at the specified index.
ListCollectionView
 Inherited
toArray():Array
Returns an Array that is populated in the same order as the IList implementation.
ListCollectionView
 Inherited
toString():String
Prints the contents of this view to a string and returns it.
ListCollectionView
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
ListCollectionView
Events
Click for more information on events
 Event Summary Defined By
 Inherited
collectionChange
Dispatched when the ICollectionView has been updated in some way.ListCollectionView
Public Constants
 ConstantDefined 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
Property Detail

enforceValidation

property
public var enforceValidation:String = "onSubmit"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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

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):void

helpTitle

property 
helpTitle:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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

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):void

helpVideo

property 
helpVideo:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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

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):void

instance

property 
instance:GuidedActivity  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Returns the singleton instance of this model.



Implementation
    public static function get instance():GuidedActivity

interactivePdfValidate

property 
public var interactivePdfValidate:String = "'false'"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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

name

property 
name:String



Implementation
    public function get name():String
    public function set name(value:String):void

panelTransitionDuration

property 
public var panelTransitionDuration:int = 500

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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

Constant Detail

SUBMIT_FROM_GUIDE

Constant
public static const SUBMIT_FROM_GUIDE:String = "guide"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

A value for the submitFrom property. This value is set by the Submit From option in the Guide Design perspective within LiveCycle Workbench ES2, 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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

A value for the enforceValidation property. This value is set by the Enforce Validation option in the Guide Design perspective within LiveCycle Workbench ES2, 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 Experience Services - Document Services ES2
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

A value for the enforceValidation property. This value is set by the Enforce Validation option in the Guide Design perspective within LiveCycle Workbench ES2, and indicates that validation is performed when the submit button is clicked.




© 2015 Adobe Systems Incorporated. All rights reserved.
Wed Nov 21 2018, 06:34 AM -08:00
 
[an error occurred while processing this directive]

 

Legal Notices | Online Privacy Policy