GuidedActivity - Adobe ActionScript® 3 (AS3 ADEP Guides) API 参考

包	ga.model
类	public class GuidedActivity
继承	GuidedActivity Section Node ArrayCollection ListCollectionView Proxy

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

The GuidedActivity class contains Guide properties.

默认 MXML 属性source

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		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 视图用来消除不符合函数条件的项目的函数。	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 [静态] [只读] 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 [只读] 此视图中的项目数。	ListCollectionView
		list : IList 此集合视图所封装的 IList。	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 将应用于 ICollectionView 的 ISort。	ListCollectionView
		source : Array 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

受保护的属性

隐藏继承的受保护属性

显示继承的受保护属性

	属性		由以下参数定义
		localIndex : Array 视图经过排序或过滤后，localIndex 属性会在排序或过滤后（已排序、已缩减）的视图中包含按排序顺序显示的项目的数组。	ListCollectionView

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addAll(addList:IList):void 向当前列表添加一组项目，将它们按传入顺序放置在列表的末尾。	ListCollectionView
		addAllAt(addList:IList, index:int):void 向当前列表添加一组项目，将它们放置在传递给函数的索引指定的位置。	ListCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	ListCollectionView
		addItem(item:Object):void 向列表末尾添加指定项目。	ListCollectionView
		addItemAt(item:Object, index:int):void 在指定的索引处添加项目。	ListCollectionView
		contains(item:Object):Boolean 返回指示视图是否包含指定对象的信息。	ListCollectionView
		createCursor():IViewCursor 创建使用此视图的新 IViewCursor。	ListCollectionView
		disableAutoUpdate():void 防止视图调度对集合本身和集合中的项目的更改。	ListCollectionView
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	ListCollectionView
		enableAutoUpdate():void 启用自动更新。	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object 获取指定索引处的项目。	ListCollectionView
		getItemIndex(item:Object):int 如果项目位于列表中（这样的话 getItemAt(index) == item），则返回该项目的索引。	ListCollectionView
		getQualifiedDataRef(object:Object):String Returns a fully qualified data reference for the current section's instance.	Section
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	ListCollectionView
		initDataProvider():void Sets the instance manager and the data provider for this repeating panel	Section
		initialized(document:Object, id:String):void 如果 ListCollectionView 是使用 MXML 标签创建的，则由 MXML 编译器自动调用。	ListCollectionView
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void 通知视图，某个项目已更新。	ListCollectionView
		refresh():Boolean 将排序和滤镜应用到视图。	ListCollectionView
		removeAll():void 删除列表中的所有项目。	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	ListCollectionView
		removeItemAt(index:int):Object 删除指定索引处的项目并返回该项目。	ListCollectionView
		setItemAt(item:Object, index:int):Object 在指定的索引处放置项目。	ListCollectionView
		toArray():Array 返回与 IList 实现的填充顺序相同的 Array。	ListCollectionView
		toString():String 将此视图的内容输出到字符串并返回该字符串。	ListCollectionView
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	ListCollectionView

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	事件		摘要	由以下参数定义
		collectionChange	以某种方式更新 ICollectionView 后调度。	ListCollectionView

公共常量

	常量		由以下参数定义
		SUBMIT_FROM_GUIDE : String = "guide" [静态] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_HOST : String = "host" [静态] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_PDF : String = "pdf" [静态] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_PRINT : String = "print" [静态] A value for the submitFrom property.	GuidedActivity
		SUBMIT_FROM_USER_BUTTON : String = "userButton" [静态] A value for the submitFrom property.	GuidedActivity
		VALIDATE_ON_PANEL_EXIT : String = "onPanelExit" [静态] A value for the enforceValidation property.	GuidedActivity
		VALIDATE_ON_SUBMIT : String = "onSubmit" [静态] A value for the enforceValidation property.	GuidedActivity

属性详细信息

enforceValidation

属性

public var enforceValidation:String = "onSubmit"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

属性

helpText:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

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

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get helpText():String
public function set helpText(value:String):void

helpTitle

属性

helpTitle:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

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

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get helpTitle():String
public function set helpTitle(value:String):void

helpVideo

属性

helpVideo:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

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

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get helpVideo():String
public function set helpVideo(value:String):void

instance

属性

instance:GuidedActivity [只读]

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

Returns the singleton instance of this model.

实现
public static function get instance():GuidedActivity

interactivePdfValidate

属性

public var interactivePdfValidate:String = "'false'"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9.0.0.1

运行时版本:

AIR 1.0, Flash Player 10.2

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

name

属性

name:String

实现
public function get name():String
public function set name(value:String):void

panelTransitionDuration

属性

public var panelTransitionDuration:int = 500

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

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

previewAsset

属性

public var previewAsset:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

属性

public var previewMode:String = "DOR"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

属性

public var previewUrl:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

属性

public var previewValidate:String = "'true'"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

属性

public var startupEffectDuration:int = 500

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

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

submitAll

属性

public var submitAll:Boolean = true

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

AIR 1.0, Flash Player 10.2

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

submitFrom

属性

public var submitFrom:String

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

属性

public var taskId:String = "null"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 10

运行时版本:

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

常量

public static const SUBMIT_FROM_GUIDE:String = "guide"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

常量

public static const SUBMIT_FROM_HOST:String = "host"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

常量

public static const SUBMIT_FROM_PDF:String = "pdf"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

常量

public static const SUBMIT_FROM_PRINT:String = "print"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

常量

public static const SUBMIT_FROM_USER_BUTTON:String = "userButton"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

常量

public static const VALIDATE_ON_PANEL_EXIT:String = "onPanelExit"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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

常量

public static const VALIDATE_ON_SUBMIT:String = "onSubmit"

语言版本:

ActionScript 3.0

产品版本:

Adobe Digital Enterprise Platform Document Services - Guides 9

运行时版本:

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.

法律声明 | 在线隐私策略

GuidedActivity - AS3 ADEP Guides

类 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