IWrapperHost - Adobe ActionScript® 3 (AS3 ADEP Guides) API 參考

套件	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

Interface that must be implemented by all guide wrapper components.

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		activateDocumentViewCB(error:FormBridgeError, data:String):void 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
		autoLoadPdf(event:Event = null):void Pre-loads the PDF rendition of the form within the PDFBox control area on the Guide layout.	IWrapperHost
		CallHtml(exFunc:String, param1:String, param2:String, param3:String, param4:String):String Calls the html to passthrough message to the PDF or to specified function in the HTML.	IWrapperHost
		cleanup():void Cleans up by releasing event listeners and zero out local variables.	IWrapperHost
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	IStyleClient
		collectionChange(bAdded:Boolean, bRemoved:Boolean):void Called whenever a Repeater Panel adds/removes an instance.	IWrapperHost
		connectionClosed():void The connection was closed.	IConnectionService
		connectionOpened(success:Boolean):void The connection was made, if success=false, the connection attempt failed	IConnectionService
		defaultCallback(msgId:int, request:String, error:FormBridgeError, parms:Array):void Default error message handler for communication with the PDF.	IWrapperHost
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	IEventDispatcher
		emailPDF(event:Event = null):void Forwards the request to email the PDF rendition of the Guide.	IWrapperHost
		fieldChangeEx(boundObject:Object, som:String, type:String, value:Object):void This method is called whenever a field in the PDF is changed	IWrapperHost
		fieldFocusIn(boundObject:Object, som:String, properties:Array, callback:Function = null):void This method is called whenever a field in the Guide gets the focus.	IWrapperHost
		fieldFocusOut(boundObject:Object, som:String, value:String):void This method is called whenever a field in the Guide loses the focus.	IWrapperHost
		getActiveData(callback:Function = null):String Return the form's Active data, either from the Guide or the PDF.	IConnectionService
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle 傳回可定義顯示物件區域 (相對於 targetCoordinateSpace 物件的座標系統) 的矩形。	IFlexDisplayObject
		getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.	IStyleClient
		getData():String Return the form's data	IConnectionService
		getDraftData(callback:Function = null):String Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active.	IConnectionService
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	IUIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	IUIComponent
		getFieldValue(som:String):Object Returns a field's value as an Object	IConnectionService
		getPdfData(callback:Function = null):void Gets the ga/xml data from the PDF.	IWrapperHost
		getPdfFieldData(som:String, callback:Function = null):void Gets a fields data from the PDF.	IWrapperHost
		getProperty(property:String):Object Return the requested property.	IConnectionService
		getRect(targetCoordinateSpace:DisplayObject):Rectangle 根據 targetCoordinateSpace 參數所定義的座標系統，並排除形狀上的任何筆畫，傳回可定義顯示物件邊界的矩形。	IFlexDisplayObject
		getRootValueObject():Object Get the root value object returning the actual object instance.	IWrapperHost
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	IStyleClient
		globalToLocal(point:Point):Point 將 point 物件從「舞台」(全域) 座標轉換成顯示物件的 (區域) 座標。	IFlexDisplayObject
		gotData(error:FormBridgeError, data:String):void Answer received from the PDF providing requested data.	IWrapperHost
		gotFocus(error:FormBridgeError, somExpression:String):void Called when a field in the interactive PDF get focus.	IWrapperHost
		guideCreationComplete(event:Event = null):void Event handler called when the guide has been created.	IWrapperHost
		guideValidationFailure(event:GAEvent):void Called when validation of field data for a panel fails.	IWrapperHost
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	IEventDispatcher
		hideDoc(event:Event = null):void Hides the Document of Record rendition and displays the Guide content.	IWrapperHost
		hidePDF(event:Event = null):void Hides the PDF rendition and displays the Guide content.	IWrapperHost
		hitTestObject(obj:DisplayObject):Boolean 評估顯示物件的範圍框，看它是否與 obj 顯示物件的範圍框重疊或相交。	IFlexDisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean 評估顯示物件，看它是否與 x 和 y 參數所指定的點重疊或相交。	IFlexDisplayObject
		init(event:Event):void Called when the guide is initalized.	IWrapperHost
		initialize():void Initialize the object.	IUIComponent
		initializingGuide(guideSuperIn:UIComponent, guideThisIn:UIComponent, initDataIn:String):void Initializes the guide and prepares it for viewing.	IWrapperHost
		isFiberGuide():Boolean True if this guide is based off of a Fiber Model.	IWrapperHost
		isGuideInitialized():Boolean Return whether or not the guide is initialized.	IWrapperHost
		isXfaGuide():Boolean True if this guide is based off of a XFA Model.	IWrapperHost
		localToGlobal(point:Point):Point 將 point 物件從顯示物件的 (區域) 座標轉換成「舞台」(全域) 座標。	IFlexDisplayObject
		move(x:Number, y:Number):void Moves this object to the specified x and y coordinates.	IFlexDisplayObject
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this component.	IStyleClient
		owns(displayObject:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	IUIComponent
		pageValidationFailure(event:GAEvent):void Called when validation of page fails.	IWrapperHost
		panelItemFocusIn(panelItem:PanelItem):void This method is called whenever a panelItem in the Guide loses focus.	IWrapperHost
		panelItemFocusOut(panelItem:PanelItem):void This method is called whenever a panelItem in the Guide gets the focus	IWrapperHost
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	IUIComponent
		pdfActiveInit():void This method is called when the PDF is initialized.	IWrapperHost
		printPDF(event:Event = null):void Forwards the request to print the PDF rendition of the Guide.	IWrapperHost
		ProcessExtMessage(msgparams:Array):void Handles incoming messages from the PDF via the HTML.	IWrapperHost
		regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions.	IStyleClient
		registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event.	IStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	IEventDispatcher
		resetModel():void Reset the Model back to its initial load state.	IWrapperHost
		resolvePreviewUrl(url:String, asset:String):String Resolves the preview URL.	IWrapperHost
		saveAsPDF(event:Event = null):void Forwards the request to save the PDF rendition of the Guide.	IWrapperHost
		serverValidationFailure(validationResult:Array):void Called when server validation fails.	IWrapperHost
		setActiveData(data:String, callback:Function = null):void Sets the data in the active view.	IWrapperHost
		setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object.	IFlexDisplayObject
		setData(data:String):void Set the data into the form - returns false if failed.	IConnectionService
		setFieldValue(som:String, value:Object):Boolean Sets a field's value, returns success true or false	IConnectionService
		setPdfData(data:String, callback:Function = null):void Sets the ga/xml data into the PDF.	IWrapperHost
		setPdfFieldData(som:String, type:String, value:String, callback:Function = null):void Sets a fields data into the PDF	IWrapperHost
		setProperty(property:String, value:Object):Boolean Set the property, returns false if the operation failed	IConnectionService
		setRootValueObject(object:Object):void Set the root value object passing in the actual object instance.	IWrapperHost
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	IStyleClient
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	IUIComponent
		showDoc(event:Event = null):void Displays the Document of Record rendition of the form within the PDFBox control area on the Guide layout.	IWrapperHost
		showPanelFullGuide():Boolean Returns whether or not the current panel is being shown in full screen mode.	IWrapperHost
		showPDF(event:Event = null):void Displays the PDF rendition of the form within the PDFBox control area on the Guide layout.	IWrapperHost
		SizeDocumentView(event:Event):void Shows the PDF.	IWrapperHost
		startGuide():void Start rendering the pages of the guide.	IWrapperHost
		styleChanged(styleProp:String):void Called when the value of a style property is changed.	ISimpleStyleClient
		submitData():Boolean 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
		submitDataWithCB(callback:Function):Boolean Submits the data to the server - return true if the submit was performed - returns false if validations fail	IConnectionService
		submitFromPDF():void This function displays the PDF rendition within the PDFBox control on the Guide layout.	IWrapperHost
		toggleView2(type:String = null, callback:Function = null):void Transfers data to or from and displays or hides the PDF or document	IWrapperHost
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	IEventDispatcher

屬性詳細資訊

方法詳細資訊

法律聲明 | 線上隱私權政策

	`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.

	`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.

	`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.

	`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`) — Specifies the function to call when the field has focus.

	`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`) — function called with the field data has been set.

	`error:FormBridgeError` — Specifies the form bridge error.

	`data:String` — Specifies the data received from the document view.

	`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.

	`som:String` — Specifies expression for the field data to be retrieved.

	`callback:Function` (default = `null`) — Specifies the function to call when the field data has been retrieved.

	`error:FormBridgeError` — Specifies the form bridge error.

	`somExpression:String` — Specifies somExpression of the field with focus on the PDF.

	`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.

	`url:String` — Specifies the URL to be resolved.

	`asset:String` — Specifies the asset to be used for preview.

	`data:String` — Specifies the active data to be set.

	`callback:Function` (default = `null`) — Specifies the function called when the data is set.

	`data:String` — Specifies the XML string containing the data for the PDF.

	`callback:Function` (default = `null`) — Specifies the function to call when the data has been set.

	`type:String` (default = `null`) — Specifies the type of view.

	`callback:Function` (default = `null`) — Specifies the function to call when the view has been toggled.

IWrapperHost - AS3 ADEP Guides

套件x

語言元素

附錄

套件 ga.controls

activeViewType

currentPage

currentPanel

currentPanelItem

currentSection

guideConnectionActive

guideExternalInterfaceAvailable

guideView

interactivePdfLoad

interactivePdfUrl

isLoadingInteractivePdf

lcx

panelManager

pdfActive

pdfAvailable

pdfCommunicationActive

pdfLoadErrorMessage

pdfProcessFocus

pdfRequiredFallbackUrl

performanceLog

previewAsset

previewAvailable

previewUrl

resizeToContent

showControlSection

showHeaderSection

showHelpCenter

showNavHelpSection

showNavigator

showNextPrev

showRepeaterControls

showSubmitButton

showTitleBar

showToolBar

submitAll

activateDocumentViewCB

autoLoadPdf

CallHtml

cleanup

collectionChange

defaultCallback

emailPDF

fieldChangeEx

fieldFocusIn

fieldFocusOut

getPdfData

getPdfFieldData

getRootValueObject

gotData

gotFocus

guideCreationComplete

guideValidationFailure

hideDoc

hidePDF

init

initializingGuide

isFiberGuide

isGuideInitialized

isXfaGuide

pageValidationFailure

panelItemFocusIn

panelItemFocusOut

pdfActiveInit

printPDF

ProcessExtMessage

resetModel

resolvePreviewUrl

saveAsPDF

serverValidationFailure

setActiveData

setPdfData

setPdfFieldData

setRootValueObject

showDoc

showPanelFullGuide