| 包 | ga.controls |
| 接口 | public interface IWrapperHost extends IEventDispatcher , IUIComponent , IStyleClient , IConnectionService , IFlexDisplayObject , ISimpleStyleClient , IBitmapDrawable , IEventDispatcher |
| 实现器 | Wrapper, WrapperHostBase |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
公共属性
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。 | IFlexDisplayObject | |
| activeViewType : String
Indicates the type of communication expected, either DOR or interactive. | IWrapperHost | ||
| alpha : Number
表示指定对象的 Alpha 透明度值。 | IFlexDisplayObject | |
| baselinePosition : Number [只读]
组件第一行文本的基线的 y 坐标。 | IUIComponent | |
| blendMode : String
BlendMode 类中的一个值，用于指定要使用的混合模式。 | IFlexDisplayObject | |
| cacheAsBitmap : Boolean
如果设置为 true，则 Flash 运行时将缓存显示对象的内部位图表示形式。 | IFlexDisplayObject | |
| className : String [只读]
组件类的名称。 | IStyleClient | |
| currentPage : Page [只读]
The current page which implements the IPanel interface. | IWrapperHost | ||
| currentPanel : Panel [只读]
The current panel. | IWrapperHost | ||
| currentPanelItem : PanelItem [只读]
The current panel item that has focus. | IWrapperHost | ||
| currentSection : Section [只读]
The current section. | IWrapperHost | ||
| document : Object
对与此组件关联的文档对象的引用。 | IUIComponent | |
| enabled : Boolean
组件是否可以接受用户交互。 | IUIComponent | |
| explicitHeight : Number
在组件坐标中显式指定的组件高度（以像素为单位）。 | IUIComponent | |
| explicitMaxHeight : Number [只读]
在组件坐标中指定组件最大高度的数字（以像素为单位）。 | IUIComponent | |
| explicitMaxWidth : Number [只读]
在组件坐标中指定组件最大宽度的数字（以像素为单位）。 | IUIComponent | |
| explicitMinHeight : Number [只读]
在组件坐标中指定组件最小高度的数字（以像素为单位）。 | IUIComponent | |
| explicitMinWidth : Number [只读]
在组件坐标中指定组件最小宽度的数字（以像素为单位）。 | IUIComponent | |
| explicitWidth : Number
在组件坐标中显式指定的组件宽度（以像素为单位）。 | IUIComponent | |
| filters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。 | IFlexDisplayObject | |
| focusPane : Sprite
在组件中共享并用作绘制焦点指示符的叠加层的单个 Sprite 对象。 | IUIComponent | |
| guideConnectionActive : Boolean
Indicates if a host SWF is communicating with the Guide through a local connection. | IWrapperHost | ||
| guideExternalInterfaceAvailable : Boolean
Indicates if the guides HTML wrapper exists and contains the required guide support. | IWrapperHost | ||
| guideView : Boolean
Indicates whether the Guide SWF or the PDF has current input and control. | IWrapperHost | ||
| height : Number
表示显示对象的高度，以像素为单位。 | IFlexDisplayObject | |
| includeInLayout : Boolean
指定此组件是否包含在父容器的布局中。 | IUIComponent | |
| inheritingStyles : Object
包含此组件的可继承样式的对象。 | IStyleClient | |
| interactivePdfLoad : String
Indicates when the load of the interactive pdf should happen. | IWrapperHost | ||
| interactivePdfUrl : String
Provides the url to retreive the interactive pdf from. | IWrapperHost | ||
| isLoadingInteractivePdf : Boolean
Indicates an interactivePdf is in the process of being loaded. | IWrapperHost | ||
| isPopUp : Boolean
PopUpManager 将其设置为 true 以指示已弹出该组件。 | IUIComponent | |
| lcx : Lcx
Get or sets the guide deployment model. | IWrapperHost | ||
| loaderInfo : LoaderInfo [只读]
返回一个 LoaderInfo 对象，其中包含加载此显示对象所属的文件的相关信息。 | IFlexDisplayObject | |
| mask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。 | IFlexDisplayObject | |
| maxHeight : Number [只读]
在组件坐标中指定组件最大高度的数字（以像素为单位）。 | IUIComponent | |
| maxWidth : Number [只读]
在组件坐标中指定组件最大宽度的数字（以像素为单位）。 | IUIComponent | |
| measuredHeight : Number [只读]
此对象的测量高度。 | IFlexDisplayObject | |
| measuredMinHeight : Number
组件的默认最小高度（以像素为单位）。 | IUIComponent | |
| measuredMinWidth : Number
组件的默认最小宽度（以像素为单位）。 | IUIComponent | |
| measuredWidth : Number [只读]
此对象的测量宽度。 | IFlexDisplayObject | |
| minHeight : Number [只读]
在组件坐标中指定组件最小高度的数字（以像素为单位）。 | IUIComponent | |
| minWidth : Number [只读]
在组件坐标中指定组件最小宽度的数字（以像素为单位）。 | IUIComponent | |
| mouseX : Number [只读]
表示此鼠标或用户输入设备位置的 x 坐标，以像素为单位。 | IFlexDisplayObject | |
| mouseY : Number [只读]
表示此鼠标或用户输入设备位置的 y 坐标，以像素为单位。 | IFlexDisplayObject | |
| name : String
表示 DisplayObject 的实例名称。 | IFlexDisplayObject | |
| nonInheritingStyles : Object
包含此组件的不可继承样式的对象。 | IStyleClient | |
| opaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。 | IFlexDisplayObject | |
| owner : DisplayObjectContainer
此 IVisualElement 对象的所有者。 | IUIComponent | |
| panelManager : PanelManager [只读]
The panel manager. | IWrapperHost | ||
| parent : DisplayObjectContainer [只读]
表示包含此显示对象的 DisplayObjectContainer 对象。 | IFlexDisplayObject | |
| pdfActive : Boolean
Indicates that the Guide has successfully communicated with the PDF rendition. | IWrapperHost | ||
| pdfAvailable : Boolean
Indicates that a PDF may be available to communicate with. | IWrapperHost | ||
| pdfCommunicationActive : Boolean
Indicates that the form guide has successfully communicated with the PDF rendition
of the form. | IWrapperHost | ||
| pdfLoadErrorMessage : String
Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF. | IWrapperHost | ||
| pdfProcessFocus : Boolean
Flag to be set by Custom Implementation based on this class to activate focus processing. | IWrapperHost | ||
| pdfRequiredFallbackUrl : String
Holds an optional Process URL to submit the Data to when "SubmitFromInteractivePDF" but the PDF can not be loaded. | IWrapperHost | ||
| percentHeight : Number
以组件父项大小百分比的方式指定组件高度的数字。 | IUIComponent | |
| percentWidth : Number
以组件父项大小百分比形式指定其宽度的数字。 | IUIComponent | |
| performanceLog : Boolean
Indicates that performance logging is active. | IWrapperHost | ||
| previewAsset : String
Holds an optional Asset reference that will get mapped into the previewUrl. | IWrapperHost | ||
| previewAvailable : Boolean
Indicates that a PDF (or other document type) may be available to render and display. | IWrapperHost | ||
| previewUrl : String
Holds the Url to get a PDF (or other document type) to render and display. | IWrapperHost | ||
| resizeToContent : Boolean
When set to true, the Guide will resize itself to take only
the space needed to display its content. | IWrapperHost | ||
| root : DisplayObject [只读]
对于加载的 SWF 文件中的显示对象，root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。 | IFlexDisplayObject | |
| rotation : Number
表示 DisplayObject 实例距其原始方向的旋转程度，以度为单位。 | IFlexDisplayObject | |
| scale9Grid : Rectangle
当前有效的缩放网格。 | IFlexDisplayObject | |
| scaleX : Number
表示从注册点开始应用的对象的水平缩放比例（百分比）。 | IFlexDisplayObject | |
| scaleY : Number
表示从对象注册点开始应用的对象的垂直缩放比例（百分比）。 | IFlexDisplayObject | |
| scrollRect : Rectangle
显示对象的滚动矩形范围。 | IFlexDisplayObject | |
| showControlSection : Boolean
Show or hide the control sections. | IWrapperHost | ||
| showHeaderSection : Boolean
Show or hide the header section. | IWrapperHost | ||
| showHelpCenter : Boolean
Show or hide the help center. | IWrapperHost | ||
| showNavHelpSection : Boolean
Show or hide the navigator help section. | IWrapperHost | ||
| showNavigator : Boolean
Show or hide the navigator. | IWrapperHost | ||
| showNextPrev : Boolean
Show or hide the next/previous Buttons. | IWrapperHost | ||
| showRepeaterControls : Boolean
Show or hide the repeater controls add/copy/remove. | IWrapperHost | ||
| showSubmitButton : Boolean
Show or hide the submit button. | IWrapperHost | ||
| showTitleBar : Boolean
Show or hide the title bar. | IWrapperHost | ||
| showToolBar : Boolean
Show or hide the tool bar. | IWrapperHost | ||
| stage : Stage [只读]
显示对象的舞台。 | IFlexDisplayObject | |
| styleDeclaration : CSSStyleDeclaration
具有此对象声明的内嵌样式的样式声明。 | IStyleClient | |
| styleName : Object
该对象的样式值的源。 | ISimpleStyleClient | |
| submitAll : Boolean [只读]
When false, field data in an optional panel is cleared when the panel is made invisible. | IWrapperHost | ||
| systemManager : ISystemManager
对此组件的 SystemManager 对象的引用。 | IUIComponent | |
| transform : flash.geom:Transform
一个对象，具有与显示对象的矩阵、颜色转换和像素范围有关的属性。 | IFlexDisplayObject | |
| tweeningProperties : Array
由 EffectManager 使用。 | IUIComponent | |
| visible : Boolean
显示对象是否可见。 | IFlexDisplayObject | |
| width : Number
表示显示对象的宽度，以像素为单位。 | IFlexDisplayObject | |
| x : Number
表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。 | IFlexDisplayObject | |
| y : Number
表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。 | IFlexDisplayObject | |
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
Call back indicating document view has activated. | IWrapperHost | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。 | IEventDispatcher | |
Pre-loads the PDF rendition of the form within the PDFBox control area on the Guide layout. | IWrapperHost | ||
Calls the html to passthrough message to the PDF or to specified function in the HTML. | IWrapperHost | ||
Cleans up by releasing event listeners and zero out local variables. | IWrapperHost | ||
|
删除此组件实例的样式属性。 | IStyleClient | |
Called whenever a Repeater Panel adds/removes an instance. | IWrapperHost | ||
|
The connection was closed. | IConnectionService | |
|
The connection was made, if success=false, the connection attempt failed
| IConnectionService | |
Default error message handler for communication with the PDF. | IWrapperHost | ||
|
将事件调度到事件流中。 | IEventDispatcher | |
Forwards the request to email the PDF rendition of the Guide. | IWrapperHost | ||
This method is called whenever a field in the PDF is changed
| IWrapperHost | ||
This method is called whenever a field in the Guide gets the focus. | IWrapperHost | ||
This method is called whenever a field in the Guide loses the focus. | IWrapperHost | ||
|
Return the form's Active data, either from the Guide or the PDF. | IConnectionService | |
|
返回一个矩形，该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。 | IFlexDisplayObject | |
|
为应用于该组件的类型选择器返回 CSSStyleDeclaration 对象数组，如果不存在则返回 null。 | IStyleClient | |
|
Return the form's data
| IConnectionService | |
|
Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. | IConnectionService | |
|
确定是使用显式高度还是测量高度的一种简便方法
| IUIComponent | |
|
确定是使用显式宽度还是测量宽度的一种简便方法
| IUIComponent | |
|
Returns a field's value as an Object
| IConnectionService | |
Gets the ga/xml data from the PDF. | IWrapperHost | ||
Gets a fields data from the PDF. | IWrapperHost | ||
|
Return the requested property. | IConnectionService | |
|
返回一个矩形，该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界，但不包括形状上的任何笔触。 | IFlexDisplayObject | |
Get the root value object returning the actual object instance. | IWrapperHost | ||
|
获取已在此组件的样式查找链中的某个位置设置过的样式属性。 | IStyleClient | |
|
将 point 对象从舞台（全局）坐标转换为显示对象的（本地）坐标。 | IFlexDisplayObject | |
Answer received from the PDF providing requested data. | IWrapperHost | ||
Called when a field in the interactive PDF get focus. | IWrapperHost | ||
Event handler called when the guide has been created. | IWrapperHost | ||
Called when validation of field data for a panel fails. | IWrapperHost | ||
|
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | IEventDispatcher | |
Hides the Document of Record rendition and displays the Guide content. | IWrapperHost | ||
Hides the PDF rendition and displays the Guide content. | IWrapperHost | ||
|
计算显示对象的边框，以确定它是否与 obj 显示对象的边框重叠或相交。 | IFlexDisplayObject | |
|
计算显示对象，以确定它是否与 x 和 y 参数指定的点重叠或相交。 | IFlexDisplayObject | |
Called when the guide is initalized. | IWrapperHost | ||
|
初始化对象。 | IUIComponent | |
Initializes the guide and prepares it for viewing. | IWrapperHost | ||
True if this guide is based off of a Fiber Model. | IWrapperHost | ||
Return whether or not the guide is initialized. | IWrapperHost | ||
True if this guide is based off of a XFA Model. | IWrapperHost | ||
|
将 point 对象从显示对象的（本地）坐标转换为舞台（全局）坐标。 | IFlexDisplayObject | |
|
将此对象移动到指定的 x 和 y 坐标。 | IFlexDisplayObject | |
|
向该组件的子项传送样式更改。 | IStyleClient | |
|
如果 owner 属性链从 child 指向此 UIComponent，则返回 true。 | IUIComponent | |
Called when validation of page fails. | IWrapperHost | ||
This method is called whenever a panelItem in the Guide loses focus. | IWrapperHost | ||
This method is called whenever a panelItem in the Guide gets the focus
| IWrapperHost | ||
|
当在父项中添加或删除 UIComponent 对象时由 Flex 调用。 | IUIComponent | |
This method is called when the PDF is initialized. | IWrapperHost | ||
Forwards the request to print the PDF rendition of the Guide. | IWrapperHost | ||
Handles incoming messages from the PDF via the HTML. | IWrapperHost | ||
|
设置内部样式缓存值，以便 getStyle() 方法可以起作用。 | IStyleClient | |
|
将 EffectManager 注册为每个效果事件的事件侦听器之一。 | IStyleClient | |
|
从 EventDispatcher 对象中删除侦听器。 | IEventDispatcher | |
Reset the Model back to its initial load state. | IWrapperHost | ||
Resolves the preview URL. | IWrapperHost | ||
Forwards the request to save the PDF rendition of the Guide. | IWrapperHost | ||
Called when server validation fails. | IWrapperHost | ||
Sets the data in the active view. | IWrapperHost | ||
|
设置此对象的实际大小。 | IFlexDisplayObject | |
|
Set the data into the form - returns false if failed. | IConnectionService | |
|
Sets a field's value, returns success true or false
| IConnectionService | |
Sets the ga/xml data into the PDF. | IWrapperHost | ||
Sets a fields data into the PDF
| IWrapperHost | ||
|
Set the property, returns false if the operation failed
| IConnectionService | |
Set the root value object passing in the actual object instance. | IWrapperHost | ||
|
对此组件实例设置样式属性。 | IStyleClient | |
|
当 visible 属性发生更改时调用。 | IUIComponent | |
Displays the Document of Record rendition of the form within the PDFBox control area on the Guide layout. | IWrapperHost | ||
Returns whether or not the current panel is being shown in full screen mode. | IWrapperHost | ||
Displays the PDF rendition of the form within the PDFBox control area on the Guide layout. | IWrapperHost | ||
Shows the PDF. | IWrapperHost | ||
Start rendering the pages of the guide. | IWrapperHost | ||
|
当样式属性的值发生更改时调用。 | ISimpleStyleClient | |
|
Performs the submit action based on the value of the Submit From
option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. | IConnectionService | |
|
Submits the data to the server - return true if the submit was performed
- returns false if validations fail
| IConnectionService | |
This function displays the PDF rendition within the PDFBox control on the Guide layout. | IWrapperHost | ||
Transfers data to or from and displays or hides the PDF or document
| IWrapperHost | ||
|
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | IEventDispatcher | |
属性详细信息
activeViewType | 属性 |
activeViewType:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates the type of communication expected, either DOR or interactive.
实现
public function get activeViewType():String public function set activeViewType(value:String):voidcurrentPage | 属性 |
currentPanel | 属性 |
currentPanel:Panel [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
The current panel.
实现
public function get currentPanel():PanelcurrentPanelItem | 属性 |
currentSection | 属性 |
guideConnectionActive | 属性 |
guideConnectionActive:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates if a host SWF is communicating with the Guide through a local connection.
实现
public function get guideConnectionActive():Boolean public function set guideConnectionActive(value:Boolean):voidguideExternalInterfaceAvailable | 属性 |
guideExternalInterfaceAvailable:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates if the guides HTML wrapper exists and contains the required guide support. This check should be used instead of 'ExternalInterface.available'.
实现
public function get guideExternalInterfaceAvailable():Boolean public function set guideExternalInterfaceAvailable(value:Boolean):voidguideView | 属性 |
guideView:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates whether the Guide SWF or the PDF has current input and control.
The value of this flag is set according to the following rules:
- True when Guide has ownership.
- False when the PDF has ownership and is currently visible to a user.
实现
public function get guideView():Boolean public function set guideView(value:Boolean):voidinteractivePdfLoad | 属性 |
interactivePdfLoad:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates when the load of the interactive pdf should happen.
实现
public function get interactivePdfLoad():String public function set interactivePdfLoad(value:String):voidinteractivePdfUrl | 属性 |
interactivePdfUrl:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Provides the url to retreive the interactive pdf from.
实现
public function get interactivePdfUrl():String public function set interactivePdfUrl(value:String):voidisLoadingInteractivePdf | 属性 |
isLoadingInteractivePdf:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates an interactivePdf is in the process of being loaded.
实现
public function get isLoadingInteractivePdf():Boolean public function set isLoadingInteractivePdf(value:Boolean):voidlcx | 属性 |
lcx:Lcx| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Get or sets the guide deployment model.
实现
public function get lcx():Lcx public function set lcx(value:Lcx):voidpanelManager | 属性 |
panelManager:PanelManager [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
The panel manager.
实现
public function get panelManager():PanelManagerpdfActive | 属性 |
pdfActive:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates that the Guide has successfully communicated with the PDF rendition. of the form.
实现
public function get pdfActive():Boolean public function set pdfActive(value:Boolean):voidpdfAvailable | 属性 |
pdfAvailable:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates that a PDF may be available to communicate with.
实现
public function get pdfAvailable():Boolean public function set pdfAvailable(value:Boolean):voidpdfCommunicationActive | 属性 |
pdfCommunicationActive:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates that the form guide has successfully communicated with the PDF rendition of the form.
实现
public function get pdfCommunicationActive():Boolean public function set pdfCommunicationActive(value:Boolean):voidpdfLoadErrorMessage | 属性 |
pdfLoadErrorMessage:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF.
实现
public function get pdfLoadErrorMessage():String public function set pdfLoadErrorMessage(value:String):voidpdfProcessFocus | 属性 |
pdfProcessFocus:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Flag to be set by Custom Implementation based on this class to activate focus processing.
实现
public function get pdfProcessFocus():Boolean public function set pdfProcessFocus(value:Boolean):voidpdfRequiredFallbackUrl | 属性 |
pdfRequiredFallbackUrl:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Holds an optional Process URL to submit the Data to when "SubmitFromInteractivePDF" but the PDF can not be loaded. A Post to the Server URL is done and the Guide is replaced with the returned content.
实现
public function get pdfRequiredFallbackUrl():String public function set pdfRequiredFallbackUrl(value:String):voidperformanceLog | 属性 |
previewAsset | 属性 |
previewAsset:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Holds an optional Asset reference that will get mapped into the previewUrl.
实现
public function get previewAsset():String public function set previewAsset(value:String):voidpreviewAvailable | 属性 |
previewAvailable:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Indicates that a PDF (or other document type) may be available to render and display.
实现
public function get previewAvailable():Boolean public function set previewAvailable(value:Boolean):voidpreviewUrl | 属性 |
previewUrl:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Holds the Url to get a PDF (or other document type) to render and display.
实现
public function get previewUrl():String public function set previewUrl(value:String):voidresizeToContent | 属性 |
resizeToContent:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
When set to true, the Guide will resize itself to take only the space needed to display its content. When set to false the Guide will attempt to take 100% of its parent size.
实现
public function get resizeToContent():Boolean public function set resizeToContent(value:Boolean):voidshowControlSection | 属性 |
showHeaderSection | 属性 |
showHelpCenter | 属性 |
showNavHelpSection | 属性 |
showNavHelpSection:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Show or hide the navigator help section.
实现
public function get showNavHelpSection():Boolean public function set showNavHelpSection(value:Boolean):voidshowNavigator | 属性 |
showNextPrev | 属性 |
showRepeaterControls | 属性 |
showRepeaterControls:Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Show or hide the repeater controls add/copy/remove.
实现
public function get showRepeaterControls():Boolean public function set showRepeaterControls(value:Boolean):voidshowSubmitButton | 属性 |
showTitleBar | 属性 |
showToolBar | 属性 |
submitAll | 属性 |
方法详细信息
activateDocumentViewCB | () | 方法 |
public function activateDocumentViewCB(error:FormBridgeError, data:String):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Call back indicating document view has activated.
参数
error:FormBridgeError — Specifies the form bridge error.
| |
data:String — Specifies the data received from the document view.
|
autoLoadPdf | () | 方法 |
public function autoLoadPdf(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Pre-loads the PDF rendition of the form within the PDFBox control area on the Guide layout. If no PDF was rendered with the Guide, this function does not perform an action. This function is called automatically if the Guide is set to SubmitFrom InteractivePdf or PrintForm.
参数
event:Event (default = null) |
CallHtml | () | 方法 |
public function CallHtml(exFunc:String, param1:String, param2:String, param3:String, param4:String):String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Calls the html to passthrough message to the PDF or to specified function in the HTML.
参数
exFunc:String — Specifies the function to execute.
| |
param1:String — Specifies the first parameter.
| |
param2:String — Specifies the second parameter.
| |
param3:String — Specifies the third parameter.
| |
param4:String — Specifies the forth parameter.
|
String — String
|
cleanup | () | 方法 |
public function cleanup():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Cleans up by releasing event listeners and zero out local variables.
collectionChange | () | 方法 |
public function collectionChange(bAdded:Boolean, bRemoved:Boolean):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Called whenever a Repeater Panel adds/removes an instance.
参数
bAdded:Boolean — Specify true if an item has been added to a collection.
| |
bRemoved:Boolean — Specify true if an item has been removed from a collection.
|
defaultCallback | () | 方法 |
public function defaultCallback(msgId:int, request:String, error:FormBridgeError, parms:Array):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Default error message handler for communication with the PDF.
参数
msgId:int — Specifies the message identifier.
| |
request:String — Specifies the message request.
| |
error:FormBridgeError — Specifies the form bridge error.
| |
parms:Array — Specifies the message parameters.
|
emailPDF | () | 方法 |
public function emailPDF(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Forwards the request to email the PDF rendition of the Guide. If no PDF was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
fieldChangeEx | () | 方法 |
public function fieldChangeEx(boundObject:Object, som:String, type:String, value:Object):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This method is called whenever a field in the PDF is changed
参数
boundObject:Object — Specifies the object in the data model corresponding to changed item.
| |
som:String — Specifies the som expression for the changed item.
| |
type:String — Specifies the type of change.
| |
value:Object — Specifies the value of the field item.
|
fieldFocusIn | () | 方法 |
public function fieldFocusIn(boundObject:Object, som:String, properties:Array, callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This method is called whenever a field in the Guide gets the focus.
参数
boundObject:Object — Specifies the object in the data model corresponding to the focused item
| |
som:String — Specifies the som expression for the item with focus.
| |
properties:Array — Specifies additional properties of the item with focus.
| |
callback:Function (default = null) |
fieldFocusOut | () | 方法 |
public function fieldFocusOut(boundObject:Object, som:String, value:String):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This method is called whenever a field in the Guide loses the focus.
参数
boundObject:Object — Specifies the object in the data model corresponding to the focused item.
| |
som:String — Specifies the som expression for the item with focus.
| |
value:String — Specifies the value of the field that lost focus.
|
getPdfData | () | 方法 |
public function getPdfData(callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Gets the ga/xml data from the PDF.
参数
callback:Function (default = null) |
getPdfFieldData | () | 方法 |
public function getPdfFieldData(som:String, callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Gets a fields data from the PDF.
参数
som:String — Specifies expression for the field data to be retrieved.
| |
callback:Function (default = null) |
getRootValueObject | () | 方法 |
gotData | () | 方法 |
public function gotData(error:FormBridgeError, data:String):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Answer received from the PDF providing requested data.
参数
error:FormBridgeError — Specifies the error received from FormBridge.
| |
data:String — Specifies the data received from the PDF file.
|
gotFocus | () | 方法 |
public function gotFocus(error:FormBridgeError, somExpression:String):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Called when a field in the interactive PDF get focus.
参数
error:FormBridgeError — Specifies the form bridge error.
| |
somExpression:String — Specifies somExpression of the field with focus on the PDF.
|
guideCreationComplete | () | 方法 |
public function guideCreationComplete(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Event handler called when the guide has been created.
参数
event:Event (default = null) |
guideValidationFailure | () | 方法 |
public function guideValidationFailure(event:GAEvent):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Called when validation of field data for a panel fails.
参数
event:GAEvent — Specifies the guideValidationFailure event.
|
hideDoc | () | 方法 |
public function hideDoc(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Hides the Document of Record rendition and displays the Guide content. If no Document of Record was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
hidePDF | () | 方法 |
public function hidePDF(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Hides the PDF rendition and displays the Guide content. Any data the user entered into the fields on the PDF rendition automatically appear in the corresponding Guide fields. If no PDF was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
init | () | 方法 |
initializingGuide | () | 方法 |
public function initializingGuide(guideSuperIn:UIComponent, guideThisIn:UIComponent, initDataIn:String):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Initializes the guide and prepares it for viewing.
参数
guideSuperIn:UIComponent — Specifies the component that will be the immediate parent of the guide.
| |
guideThisIn:UIComponent — Specifies the top level application.
| |
initDataIn:String — Specifies the prefill data.
|
isFiberGuide | () | 方法 |
isGuideInitialized | () | 方法 |
isXfaGuide | () | 方法 |
pageValidationFailure | () | 方法 |
panelItemFocusIn | () | 方法 |
public function panelItemFocusIn(panelItem:PanelItem):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This method is called whenever a panelItem in the Guide loses focus.
参数
panelItem:PanelItem — Specifies the panelItem that has received focus.
|
panelItemFocusOut | () | 方法 |
public function panelItemFocusOut(panelItem:PanelItem):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This method is called whenever a panelItem in the Guide gets the focus
参数
panelItem:PanelItem — the panelItem that has lost focus
|
pdfActiveInit | () | 方法 |
public function pdfActiveInit():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This method is called when the PDF is initialized.
printPDF | () | 方法 |
public function printPDF(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Forwards the request to print the PDF rendition of the Guide. If no PDF was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
ProcessExtMessage | () | 方法 |
resetModel | () | 方法 |
public function resetModel():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Reset the Model back to its initial load state.
resolvePreviewUrl | () | 方法 |
public function resolvePreviewUrl(url:String, asset:String):String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Resolves the preview URL.
参数
url:String — Specifies the URL to be resolved.
| |
asset:String — Specifies the asset to be used for preview.
|
String — String
|
saveAsPDF | () | 方法 |
public function saveAsPDF(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Forwards the request to save the PDF rendition of the Guide. If no PDF was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
serverValidationFailure | () | 方法 |
setActiveData | () | 方法 |
public function setActiveData(data:String, callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Sets the data in the active view.
If a callback function is provided, this method sets the data in the active view whether it's the Guide or the PDF. If no callback function is provided, this function immediately sets the data in the Guide. The callback function requires two string parameters, error:String and data:String. If error is not null, then the method failed. The data parameter is always null.
参数
data:String — Specifies the active data to be set.
| |
callback:Function (default = null) |
setPdfData | () | 方法 |
public function setPdfData(data:String, callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Sets the ga/xml data into the PDF.
参数
data:String — Specifies the XML string containing the data for the PDF.
| |
callback:Function (default = null) |
setPdfFieldData | () | 方法 |
public function setPdfFieldData(som:String, type:String, value:String, callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Sets a fields data into the PDF
参数
som:String — Specifies the expression for the field data to be set.
| |
type:String — Specifies the type of data.
| |
value:String — Specifies the value of data.
| |
callback:Function (default = null) |
setRootValueObject | () | 方法 |
public function setRootValueObject(object:Object):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Set the root value object passing in the actual object instance.
参数
object:Object — Specifies the instance of the root value object to be set.
|
showDoc | () | 方法 |
public function showDoc(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Displays the Document of Record rendition of the form within the PDFBox control area on the Guide layout. If no DOR was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
showPanelFullGuide | () | 方法 |
public function showPanelFullGuide():Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Returns whether or not the current panel is being shown in full screen mode.
返回Boolean — true if the current panel is being shown in full screen mode, otherwise false.
|
showPDF | () | 方法 |
public function showPDF(event:Event = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Displays the PDF rendition of the form within the PDFBox control area on the Guide layout. If no PDF was rendered with the Guide, this function does not perform an action.
参数
event:Event (default = null) |
SizeDocumentView | () | 方法 |
startGuide | () | 方法 |
public function startGuide():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Start rendering the pages of the guide.
submitFromPDF | () | 方法 |
public function submitFromPDF():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
This function displays the PDF rendition within the PDFBox control on the Guide layout. A user must click the appropriate submit button to complete the data submission.
If no PDF was rendered with the Guide, this function sends the data to the Document Server which renders the form as a PDF, and returns it to the user to complete the submission.
toggleView2 | () | 方法 |
public function toggleView2(type:String = null, callback:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 运行时版本: | AIR 1.0, Flash Player 10.2 |
Transfers data to or from and displays or hides the PDF or document
参数
type:String (default = null) | |
callback:Function (default = null) |
Tue Jun 12 2018, 11:04 AM Z