| 套件 | 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 [唯讀]
The y-coordinate of the baseline
of the first line of text of the component. | IUIComponent | |
| blendMode : String
來自 BlendMode 類別的值，會指定要使用何種混合模式。 | IFlexDisplayObject | |
| cacheAsBitmap : Boolean
如果設定為 true，Flash 執行階段會快取顯示物件的內部點陣圖表示法。 | IFlexDisplayObject | |
| className : String [唯讀]
The name of the component class. | 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
A reference to the document object associated with this component. | IUIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | IUIComponent | |
| explicitHeight : Number
The explicitly specified height for the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMaxHeight : Number [唯讀]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMaxWidth : Number [唯讀]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMinHeight : Number [唯讀]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitMinWidth : Number [唯讀]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| explicitWidth : Number
The explicitly specified width for the component,
in pixels, as the component's coordinates. | IUIComponent | |
| filters : Array
索引的陣列，其中包含目前和顯示物件相關的每個濾鏡物件。 | IFlexDisplayObject | |
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | 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
Specifies whether this component is included in the layout of the
parent container. | IUIComponent | |
| inheritingStyles : Object
An object containing the inheritable styles for this component. | 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
Set to true by the PopUpManager to indicate
that component has been popped up. | IUIComponent | |
| lcx : Lcx
Get or sets the guide deployment model. | IWrapperHost | ||
| loaderInfo : LoaderInfo [唯讀]
會傳回 LoaderInfo 物件，其中包含關於載入此顯示物件所屬之檔案的資訊。 | IFlexDisplayObject | |
| mask : DisplayObject
呼叫之顯示物件會以指定的 mask 物件遮蓋。 | IFlexDisplayObject | |
| maxHeight : Number [唯讀]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| maxWidth : Number [唯讀]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| measuredHeight : Number [唯讀]
The measured height of this object. | IFlexDisplayObject | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | IUIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | IUIComponent | |
| measuredWidth : Number [唯讀]
The measured width of this object. | IFlexDisplayObject | |
| minHeight : Number [唯讀]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| minWidth : Number [唯讀]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | |
| mouseX : Number [唯讀]
指出滑鼠或使用者輸入裝置位置的 x 座標，以像素為單位。 | IFlexDisplayObject | |
| mouseY : Number [唯讀]
指出滑鼠或使用者輸入裝置位置的 y 座標，以像素為單位。 | IFlexDisplayObject | |
| name : String
指出 DisplayObject 的實體名稱。 | IFlexDisplayObject | |
| nonInheritingStyles : Object
An object containing the noninheritable styles for this component. | IStyleClient | |
| opaqueBackground : Object
會指定顯示物件是否不透明，並具有特定背景顏色。 | IFlexDisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | 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
Number that specifies the height of a component as a
percentage of its parent's size. | IUIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a
percentage of its parent's size. | 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
The style declaration that holds the inline styles declared by this
object. | IStyleClient | |
| styleName : Object
The source of this object's style values. | ISimpleStyleClient | |
| submitAll : Boolean [唯讀]
When false, field data in an optional panel is cleared when the panel is made invisible. | IWrapperHost | ||
| systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | |
| transform : flash.geom:Transform
這是一個物件，具有和顯示物件的矩陣、顏色轉換和像素邊界有關的屬性。 | IFlexDisplayObject | |
| tweeningProperties : Array
Used by 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 | ||
|
Deletes a style property from this component instance. | 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 | |
|
Returns an Array of CSSStyleDeclaration objects for the type selector
that applies to this component, or null if none exist. | 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 | |
|
A convenience method for determining whether to use the
explicit or measured height
| IUIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| 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 | ||
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | 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 | ||
|
Initialize the object. | 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 | |
|
Moves this object to the specified x and y coordinates. | IFlexDisplayObject | |
|
Propagates style changes to the children of this component. | IStyleClient | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | 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 | ||
|
Called by Flex when a UIComponent object is added to or removed from a parent. | 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 | ||
|
Sets up the internal style cache values so that the getStyle()
method functions. | IStyleClient | |
|
Registers the EffectManager as one of the event listeners for each effect event. | 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 | ||
|
Sets the actual size of this object. | 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 | ||
|
Sets a style property on this component instance. | IStyleClient | |
|
Called when the visible property changes. | 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 | ||
|
Called when the value of a style property is changed. | 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 | () | 方法 |
public function ProcessExtMessage(msgparams:Array):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| 執行階段版本: | AIR 1.0, Flash Player 10.2 |
Handles incoming messages from the PDF via the HTML.
參數
msgparams:Array — Specifies the parameters coming from the PDF.
|
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, 03:47 PM Z