IWrapperHost

Package	ga.controls
Interface	public interface IWrapperHost extends IEventDispatcher , IUIComponent , IStyleClient , IConnectionService , IFlexDisplayObject , ISimpleStyleClient , IBitmapDrawable , IEventDispatcher
Implementors	Wrapper, WrapperHostBase

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Interface that must be implemented by all guide wrapper components.

Public Properties

	Property		Defined By
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	IFlexDisplayObject
		activeViewType : String Indicates the type of communication expected, either DOR or interactive.	IWrapperHost
		alpha : Number Indicates the alpha transparency value of the object specified.	IFlexDisplayObject
		baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component.	IUIComponent
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	IFlexDisplayObject
		cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object.	IFlexDisplayObject
		className : String [read-only] The name of the component class.	IStyleClient
		currentPage : Page [read-only] The current page which implements the IPanel interface.	IWrapperHost
		currentPanel : Panel [read-only] The current panel.	IWrapperHost
		currentPanelItem : PanelItem [read-only] The current panel item that has focus.	IWrapperHost
		currentSection : Section [read-only] 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 [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMaxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMinHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMinWidth : Number [read-only] 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 An indexed array that contains each filter object currently associated with the display object.	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 Indicates the height of the display object, in pixels.	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 [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	IFlexDisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	IFlexDisplayObject
		maxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.	IUIComponent
		maxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.	IUIComponent
		measuredHeight : Number [read-only] 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 [read-only] The measured width of this object.	IFlexDisplayObject
		minHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.	IUIComponent
		minWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.	IUIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	IFlexDisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	IFlexDisplayObject
		name : String Indicates the instance name of the DisplayObject.	IFlexDisplayObject
		nonInheritingStyles : Object An object containing the noninheritable styles for this component.	IStyleClient
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	IFlexDisplayObject
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IUIComponent
		panelManager : PanelManager [read-only] The panel manager.	IWrapperHost
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	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 [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	IFlexDisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	IFlexDisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	IFlexDisplayObject
		scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point.	IFlexDisplayObject
		scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.	IFlexDisplayObject
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	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 [read-only] The Stage of the display object.	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 [read-only] 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 An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	IFlexDisplayObject
		tweeningProperties : Array Used by EffectManager.	IUIComponent
		visible : Boolean Whether or not the display object is visible.	IFlexDisplayObject
		width : Number Indicates the width of the display object, in pixels.	IFlexDisplayObject
		x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	IFlexDisplayObject
		y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	IFlexDisplayObject

Public Methods

	Method		Defined By
		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 Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	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 Dispatches an event into the event flow.	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 Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	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 Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	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 Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	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 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	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 Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	IFlexDisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	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 Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	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 Removes a listener from the EventDispatcher object.	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 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	IEventDispatcher

Property Detail

activeViewType

property

activeViewType:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates the type of communication expected, either DOR or interactive.

Implementation
public function get activeViewType():String
public function set activeViewType(value:String):void

currentPage

property

currentPage:Page [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The current page which implements the IPanel interface.

Implementation
public function get currentPage():Page

Related API Elements

ga.model.IPanel

currentPanel

property

currentPanel:Panel [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The current panel.

Implementation
public function get currentPanel():Panel

currentPanelItem

property

currentPanelItem:PanelItem [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The current panel item that has focus.

Implementation
public function get currentPanelItem():PanelItem

currentSection

property

currentSection:Section [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The current section.

Implementation
public function get currentSection():Section

guideConnectionActive

property

guideConnectionActive:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates if a host SWF is communicating with the Guide through a local connection.

Implementation
public function get guideConnectionActive():Boolean
public function set guideConnectionActive(value:Boolean):void

guideExternalInterfaceAvailable

property

guideExternalInterfaceAvailable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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

Implementation
public function get guideExternalInterfaceAvailable():Boolean
public function set guideExternalInterfaceAvailable(value:Boolean):void

guideView

property

guideView:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Implementation
public function get guideView():Boolean
public function set guideView(value:Boolean):void

interactivePdfLoad

property

interactivePdfLoad:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates when the load of the interactive pdf should happen.

Implementation
public function get interactivePdfLoad():String
public function set interactivePdfLoad(value:String):void

interactivePdfUrl

property

interactivePdfUrl:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Provides the url to retreive the interactive pdf from.

Implementation
public function get interactivePdfUrl():String
public function set interactivePdfUrl(value:String):void

isLoadingInteractivePdf

property

isLoadingInteractivePdf:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates an interactivePdf is in the process of being loaded.

Implementation
public function get isLoadingInteractivePdf():Boolean
public function set isLoadingInteractivePdf(value:Boolean):void

lcx

property

lcx:Lcx

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Get or sets the guide deployment model.

Implementation
public function get lcx():Lcx
public function set lcx(value:Lcx):void

panelManager

property

panelManager:PanelManager [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

The panel manager.

Implementation
public function get panelManager():PanelManager

pdfActive

property

pdfActive:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates that the Guide has successfully communicated with the PDF rendition. of the form.

Implementation
public function get pdfActive():Boolean
public function set pdfActive(value:Boolean):void

pdfAvailable

property

pdfAvailable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates that a PDF may be available to communicate with.

Implementation
public function get pdfAvailable():Boolean
public function set pdfAvailable(value:Boolean):void

pdfCommunicationActive

property

pdfCommunicationActive:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates that the form guide has successfully communicated with the PDF rendition of the form.

Implementation
public function get pdfCommunicationActive():Boolean
public function set pdfCommunicationActive(value:Boolean):void

pdfLoadErrorMessage

property

pdfLoadErrorMessage:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Implementation
public function get pdfLoadErrorMessage():String
public function set pdfLoadErrorMessage(value:String):void

pdfProcessFocus

property

pdfProcessFocus:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Flag to be set by Custom Implementation based on this class to activate focus processing.

Implementation
public function get pdfProcessFocus():Boolean
public function set pdfProcessFocus(value:Boolean):void

pdfRequiredFallbackUrl

property

pdfRequiredFallbackUrl:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Implementation
public function get pdfRequiredFallbackUrl():String
public function set pdfRequiredFallbackUrl(value:String):void

performanceLog

property

performanceLog:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates that performance logging is active.

Implementation
public function get performanceLog():Boolean
public function set performanceLog(value:Boolean):void

previewAsset

property

previewAsset:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Holds an optional Asset reference that will get mapped into the previewUrl.

Implementation
public function get previewAsset():String
public function set previewAsset(value:String):void

previewAvailable

property

previewAvailable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Indicates that a PDF (or other document type) may be available to render and display.

Implementation
public function get previewAvailable():Boolean
public function set previewAvailable(value:Boolean):void

previewUrl

property

previewUrl:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Holds the Url to get a PDF (or other document type) to render and display.

Implementation
public function get previewUrl():String
public function set previewUrl(value:String):void

resizeToContent

property

resizeToContent:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Implementation
public function get resizeToContent():Boolean
public function set resizeToContent(value:Boolean):void

showControlSection

property

showControlSection:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the control sections.

Implementation
public function get showControlSection():Boolean
public function set showControlSection(value:Boolean):void

showHeaderSection

property

showHeaderSection:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the header section.

Implementation
public function get showHeaderSection():Boolean
public function set showHeaderSection(value:Boolean):void

showHelpCenter

property

showHelpCenter:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the help center.

Implementation
public function get showHelpCenter():Boolean
public function set showHelpCenter(value:Boolean):void

showNavHelpSection

property

showNavHelpSection:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the navigator help section.

Implementation
public function get showNavHelpSection():Boolean
public function set showNavHelpSection(value:Boolean):void

showNavigator

property

showNavigator:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the navigator.

Implementation
public function get showNavigator():Boolean
public function set showNavigator(value:Boolean):void

showNextPrev

property

showNextPrev:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the next/previous Buttons.

Implementation
public function get showNextPrev():Boolean
public function set showNextPrev(value:Boolean):void

showRepeaterControls

property

showRepeaterControls:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the repeater controls add/copy/remove.

Implementation
public function get showRepeaterControls():Boolean
public function set showRepeaterControls(value:Boolean):void

showSubmitButton

property

showSubmitButton:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the submit button.

Implementation
public function get showSubmitButton():Boolean
public function set showSubmitButton(value:Boolean):void

showTitleBar

property

showTitleBar:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the title bar.

Implementation
public function get showTitleBar():Boolean
public function set showTitleBar(value:Boolean):void

showToolBar

property

showToolBar:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Show or hide the tool bar.

Implementation
public function get showToolBar():Boolean
public function set showToolBar(value:Boolean):void

submitAll

property

submitAll:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

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

Implementation
public function get submitAll():Boolean

Method Detail

activateDocumentViewCB

()

method

public function activateDocumentViewCB(error:FormBridgeError, data:String):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Call back indicating document view has activated.

Parameters

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

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

autoLoadPdf

()

method

public function autoLoadPdf(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the load PDF event.

CallHtml

()

method

public function CallHtml(exFunc:String, param1:String, param2:String, param3:String, param4:String):String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Calls the html to passthrough message to the PDF or to specified function in the HTML.

Parameters

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

Returns

String — String

cleanup

()

method

public function cleanup():void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Cleans up by releasing event listeners and zero out local variables.

collectionChange

()

method

public function collectionChange(bAdded:Boolean, bRemoved:Boolean):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Called whenever a Repeater Panel adds/removes an instance.

Parameters

	`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

()

method

public function defaultCallback(msgId:int, request:String, error:FormBridgeError, parms:Array):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Default error message handler for communication with the PDF.

Parameters

	`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

()

method

public function emailPDF(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the emailPDF event.

fieldChangeEx

()

method

public function fieldChangeEx(boundObject:Object, som:String, type:String, value:Object):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

This method is called whenever a field in the PDF is changed

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.

fieldFocusIn

()

method

public function fieldFocusIn(boundObject:Object, som:String, properties:Array, callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

This method is called whenever a field in the Guide gets the focus.

Parameters

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

fieldFocusOut

()

method

public function fieldFocusOut(boundObject:Object, som:String, value:String):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

This method is called whenever a field in the Guide loses the focus.

Parameters

	`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

()

method

public function getPdfData(callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Gets the ga/xml data from the PDF.

Parameters

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

getPdfFieldData

()

method

public function getPdfFieldData(som:String, callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Gets a fields data from the PDF.

Parameters

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

getRootValueObject

()

method

public function getRootValueObject():Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Get the root value object returning the actual object instance.

Returns

Object — an instance of the root value object.

gotData

()

method

public function gotData(error:FormBridgeError, data:String):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Answer received from the PDF providing requested data.

Parameters

	`error:FormBridgeError` — Specifies the error received from FormBridge.

	`data:String` — Specifies the data received from the PDF file.

gotFocus

()

method

public function gotFocus(error:FormBridgeError, somExpression:String):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Called when a field in the interactive PDF get focus.

Parameters

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

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

guideCreationComplete

()

method

public function guideCreationComplete(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Event handler called when the guide has been created.

Parameters

event:Event (default = null) — Specifies the completion event.

guideValidationFailure

()

method

public function guideValidationFailure(event:GAEvent):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Called when validation of field data for a panel fails.

Parameters

event:GAEvent — Specifies the guideValidationFailure event.

hideDoc

()

method

public function hideDoc(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the hideDoc event.

hidePDF

()

method

public function hidePDF(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the hidePDF event.

init

()

method

public function init(event:Event):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Called when the guide is initalized.

Parameters

event:Event — the initializing event

Related API Elements

GAEvent.INITIALIZED

initializingGuide

()

method

public function initializingGuide(guideSuperIn:UIComponent, guideThisIn:UIComponent, initDataIn:String):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Initializes the guide and prepares it for viewing.

Parameters

	`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

()

method

public function isFiberGuide():Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

True if this guide is based off of a Fiber Model.

Returns

Boolean — Boolean

isGuideInitialized

()

method

public function isGuideInitialized():Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Return whether or not the guide is initialized.

Returns

Boolean — Boolean

isXfaGuide

()

method

public function isXfaGuide():Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

True if this guide is based off of a XFA Model.

Returns

Boolean — Boolean

pageValidationFailure

()

method

public function pageValidationFailure(event:GAEvent):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Called when validation of page fails.

Parameters

event:GAEvent — Specifies a pageValidationFailure event.

panelItemFocusIn

()

method

public function panelItemFocusIn(panelItem:PanelItem):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

This method is called whenever a panelItem in the Guide loses focus.

Parameters

panelItem:PanelItem — Specifies the panelItem that has received focus.

panelItemFocusOut

()

method

public function panelItemFocusOut(panelItem:PanelItem):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

This method is called whenever a panelItem in the Guide gets the focus

Parameters

panelItem:PanelItem — the panelItem that has lost focus

pdfActiveInit

()

method

public function pdfActiveInit():void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

This method is called when the PDF is initialized.

printPDF

()

method

public function printPDF(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the printPDF event.

ProcessExtMessage

()

method

public function ProcessExtMessage(msgparams:Array):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Handles incoming messages from the PDF via the HTML.

Parameters

msgparams:Array — Specifies the parameters coming from the PDF.

resetModel

()

method

public function resetModel():void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Reset the Model back to its initial load state.

resolvePreviewUrl

()

method

public function resolvePreviewUrl(url:String, asset:String):String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Resolves the preview URL.

Parameters

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

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

Returns

String — String

saveAsPDF

()

method

public function saveAsPDF(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the saveAsPDF event.

serverValidationFailure

()

method

public function serverValidationFailure(validationResult:Array):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Called when server validation fails.

Parameters

validationResult:Array — Specifies an array of validation errors.

setActiveData

()

method

public function setActiveData(data:String, callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

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

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

setPdfData

()

method

public function setPdfData(data:String, callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Sets the ga/xml data into the PDF.

Parameters

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

setPdfFieldData

()

method

public function setPdfFieldData(som:String, type:String, value:String, callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Sets a fields data into the PDF

Parameters

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

setRootValueObject

()

method

public function setRootValueObject(object:Object):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Set the root value object passing in the actual object instance.

Parameters

object:Object — Specifies the instance of the root value object to be set.

showDoc

()

method

public function showDoc(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — the showDoc event

showPanelFullGuide

()

method

public function showPanelFullGuide():Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Returns whether or not the current panel is being shown in full screen mode.

Returns

Boolean — true if the current panel is being shown in full screen mode, otherwise false.

showPDF

()

method

public function showPDF(event:Event = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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.

Parameters

event:Event (default = null) — Specifies the showPDF event.

SizeDocumentView

()

method

public function SizeDocumentView(event:Event):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Shows the PDF.

Parameters

event:Event — Specifies the SizeDocumentView event.

startGuide

()

method

public function startGuide():void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Start rendering the pages of the guide.

submitFromPDF

()

method

public function submitFromPDF():void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

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

()

method

public function toggleView2(type:String = null, callback:Function = null):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Transfers data to or from and displays or hides the PDF or document

Parameters

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

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

Legal Notices | Online Privacy Policy

IWrapperHost - AS3 ADEP Guides

Classes x

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

showPDF

SizeDocumentView

startGuide