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 [只读] 组件第一行文本的基线的 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

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		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 删除此组件实例的样式属性。	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 为应用于该组件的类型选择器返回 CSSStyleDeclaration 对象数组，如果不存在则返回 null。	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 确定是使用显式高度还是测量高度的一种简便方法	IUIComponent
		getExplicitOrMeasuredWidth():Number 确定是使用显式宽度还是测量宽度的一种简便方法	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):* 获取已在此组件的样式查找链中的某个位置设置过的样式属性。	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 初始化对象。	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 将此对象移动到指定的 x 和 y 坐标。	IFlexDisplayObject
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void 向该组件的子项传送样式更改。	IStyleClient
		owns(displayObject:DisplayObject):Boolean 如果 owner 属性链从 child 指向此 UIComponent，则返回 true。	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 当在父项中添加或删除 UIComponent 对象时由 Flex 调用。	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 设置内部样式缓存值，以便 getStyle() 方法可以起作用。	IStyleClient
		registerEffects(effects:Array):void 将 EffectManager 注册为每个效果事件的事件侦听器之一。	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 设置此对象的实际大小。	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 对此组件实例设置样式属性。	IStyleClient
		setVisible(value:Boolean, noEvent:Boolean = false):void 当 visible 属性发生更改时调用。	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 当样式属性的值发生更改时调用。	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