WrapperHostBase

Package	com.adobe.guides.spark.wrappers.components
Class	public class WrapperHostBase
Inheritance	WrapperHostBase SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IWrapperHost, IConnectionService
Subclasses	StandardWrapperHost

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Base class for guide skinnable wrapper components.

Default MXML PropertymxmlContentFactory

Public Properties

	Property		Defined By
		accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.	UIComponent
		activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.	UIComponent
		activeViewType : String Indicates the type of communication expected, either DOR or interactive.	WrapperHostBase
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		autoLayout : Boolean If true, measurement and layout are done when the position or size of a child is changed.	SkinnableContainer
		automationDelegate : Object The delegate object that handles the automation-related functionality.	UIComponent
		automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise.	UIComponent
		automationName : String Name that can be used as an identifier for this object.	UIComponent
		automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes.	UIComponent
		automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes.	UIComponent
		automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.	UIComponent
		automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.	UIComponent
		automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise.	UIComponent
		baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		baselinePosition : Number [override] [read-only] The y-coordinate of the baseline of the first line of text of the component.	SkinnableComponent
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	DisplayObject
		cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object.	UIComponent
		cachePolicy : String Specifies the bitmap caching policy for this object.	UIComponent
		className : String [read-only] The name of this instance's class, such as "Button".	UIComponent
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system.	UIComponent
		contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system.	UIComponent
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		creationPolicy : String Content creation policy for this component.	SkinnableContainer
		currentPage : Page The current page which implements the IPanel interface.	WrapperHostBase
		currentPanel : Panel The current panel.	WrapperHostBase
		currentPanelItem : PanelItem The current panel item that has focus.	WrapperHostBase
		currentSection : Section The current section.	WrapperHostBase
		currentState : String The current view state of the component.	UIComponent
		cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers.	UIComponent
		defaultButton : IFlexDisplayObject The Button control designated as the default button for the container.	SkinnableContainerBase
		deferredContentCreated : Boolean [read-only] Contains true if deferred content has been created.	SkinnableContainer
		depth : Number Determines the order in which items inside of containers are rendered.	UIComponent
		descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.	UIComponent
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	UIComponent
		document : Object A reference to the document object associated with this UIComponent.	UIComponent
		doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events.	UIComponent
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		enabled : Boolean Whether the component can accept user interaction.	UIComponent
		errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.	UIComponent
		explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		flexContextMenu : IFlexContextMenu The context menu for this UIComponent.	UIComponent
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	UIComponent
		focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusPane : Sprite The focus pane associated with this object.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		guideConnectionActive : Boolean Indicates if a host SWF is communicating with the Guide through a local connection.	WrapperHostBase
		guideExternalInterfaceAvailable : Boolean Indicates if the guides HTML wrapper exists and contains the required guide support.	WrapperHostBase
		guideView : Boolean Indicates whether the Guide SWF or the PDF has current input and control.	WrapperHostBase
		hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus.	UIComponent
		hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix.	UIComponent
		height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		id : String ID of the component.	UIComponent
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UIComponent
		includeNavigationMinHeight : int Set the minimal height such that the navigation will collapse if the height is less than the value.	WrapperHostBase
		includeNavigationMinWidth : int Set the minimal width such that the navigation container will collapse if the width is less than the value.	WrapperHostBase
		inheritingStyles : Object The beginning of this component's chain of inheriting styles.	UIComponent
		initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).	UIComponent
		instanceIndex : int [read-only] The index of a repeated component.	UIComponent
		instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document.	UIComponent
		interactivePdfLoad : String Indicates when the load of the interactive pdf should happen.	WrapperHostBase
		interactivePdfUrl : String Provides the url to retreive the interactive pdf from.	WrapperHostBase
		is3D : Boolean [read-only] Contains true when the element is in 3D.	UIComponent
		isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object.	UIComponent
		isLoadingInteractivePdf : Boolean Indicates an interactivePdf is in the process of being loaded.	WrapperHostBase
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UIComponent
		layout : LayoutBase The layout object for this container.	SkinnableContainer
		layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.	UIComponent
		lcx : Lcx Get or sets the guide deployment model.	WrapperHostBase
		left : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box.	UIComponent
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		measuredHeight : Number The default height of the component, in pixels.	UIComponent
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UIComponent
		measuredWidth : Number The default width of the component, in pixels.	UIComponent
		metaData : Object Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.	DisplayObject
		minHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		minWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		model : IWrapperModel [read-only] The Model behind the wrapper host component.	WrapperHostBase
		moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.	UIComponent
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mxmlContent : Array [write-only] The visual content children for this Group.	SkinnableContainer
		mxmlContentFactory : IDeferredInstance [write-only] A factory object that creates the initial value for the content property.	SkinnableContainer
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		nestLevel : int Depth of this object in the containment hierarchy.	UIComponent
		nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles.	UIComponent
		numAutomationChildren : int [read-only] The number of automation children this container has.	UIComponent
		numElements : int [read-only] The number of visual elements in this container.	SkinnableContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		owner : DisplayObjectContainer The owner of this IVisualElement object.	UIComponent
		panelManager : PanelManager [read-only] The panel manager.	WrapperHostBase
		parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component.	UIComponent
		parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance.	UIComponent
		parentDocument : Object [read-only] A reference to the parent document object for this UIComponent.	UIComponent
		pdfActive : Boolean Indicates that the Guide has successfully communicated with the PDF rendition.	WrapperHostBase
		pdfAvailable : Boolean Indicates that a PDF may be available to communicate with.	WrapperHostBase
		pdfCommunicationActive : Boolean Indicates that the form guide has successfully communicated with the PDF rendition of the form.	WrapperHostBase
		pdfLoadErrorMessage : String Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF.	WrapperHostBase
		pdfProcessFocus : Boolean Flag to be set by Custom Implementation based on this class to activate focus processing.	WrapperHostBase
		pdfRequiredFallbackUrl : String Holds an optional Process URL to submit the Data to when "SubmitFromInteractivePDF" but the PDF can not be loaded.	WrapperHostBase
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	UIComponent
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	UIComponent
		performanceLog : Boolean Indicates that performance logging is active.	WrapperHostBase
		postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	UIComponent
		previewAsset : String Holds an optional Asset reference that will get mapped into the previewUrl.	WrapperHostBase
		previewAvailable : Boolean Indicates that a PDF (or other document type) may be available to render and display.	WrapperHostBase
		previewUrl : String Holds the Url to get a PDF (or other document type) to render and display.	WrapperHostBase
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	UIComponent
		repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent.	UIComponent
		repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.	UIComponent
		repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.	UIComponent
		repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent.	UIComponent
		resizeToContent : Boolean When set to true, the Guide will resize itself to take only the space needed to display its content.	WrapperHostBase
		right : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		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.	DisplayObject
		rotation : Number [override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	UIComponent
		rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		rotationZ : Number [override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number [override] Number that specifies the vertical scaling factor.	UIComponent
		scaleZ : Number [override] Number that specifies the scaling factor along the z axis.	UIComponent
		screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object.	UIComponent
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		showControlSection : Boolean Show or hide the control sections.	WrapperHostBase
		showHeaderSection : Boolean Show or hide the header section.	WrapperHostBase
		showHelpCenter : Boolean Show or hide the help center.	WrapperHostBase
		showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy.	UIComponent
		showNavHelpSection : Boolean Show or hide the navigator help section.	WrapperHostBase
		showNavigator : Boolean Show or hide the navigator.	WrapperHostBase
		showNextPrev : Boolean Show or hide the next/previous Buttons.	WrapperHostBase
		showRepeaterControls : Boolean Show or hide the repeater controls add/copy/remove.	WrapperHostBase
		showSubmitButton : Boolean Show or hide the submit button.	WrapperHostBase
		showTitleBar : Boolean Show or hide the title bar.	WrapperHostBase
		showToolBar : Boolean Show or hide the tool bar.	WrapperHostBase
		skin : UIComponent [read-only] The instance of the skin class for this component instance.	SkinnableComponent
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).	InteractiveObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		states : Array The view states that are defined for this component.	UIComponent
		styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object.	UIComponent
		styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component.	UIComponent
		styleName : Object The class style used by this component.	UIComponent
		styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors.	UIComponent
		submitAll : Boolean When false, field data in an optional panel is cleared when the panel is made invisible.	WrapperHostBase
		suggestedFocusSkinExclusions : Array [read-only] Lists the skin parts that are excluded from bitmaps captured and used to show focus.	SkinnableComponent
		systemManager : ISystemManager Returns the SystemManager object used by this component.	UIComponent
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.	UIComponent
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		toolTip : String Text to display in the ToolTip.	UIComponent
		top : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		transform : flash.geom:Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	UIComponent
		transformX : Number Sets the x coordinate for the transform center of the component.	UIComponent
		transformY : Number Sets the y coordinate for the transform center of the component.	UIComponent
		transformZ : Number Sets the z coordinate for the transform center of the component.	UIComponent
		transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.	UIComponent
		tweeningProperties : Array Array of properties that are currently being tweened on this object.	UIComponent
		uid : String A unique identifier for the object.	UIComponent
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required).	UIComponent
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.	Sprite
		validationSubField : String Used by a validator to associate a subfield with this component.	UIComponent
		verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		visible : Boolean [override] Whether or not the display object is visible.	UIComponent
		width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent
		z : Number [override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	UIComponent

Protected Properties

	Property		Defined By
		currentCSSState : String [override] [read-only] The state to be used when matching CSS pseudo-selectors.	SkinnableComponent
		hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.	UIComponent
		resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources.	UIComponent
		unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component.	UIComponent
		unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().	UIComponent

Public Methods

	Method		Defined By
		WrapperHostBase() Constructor	WrapperHostBase
		activateDocumentViewCB(error:FormBridgeError, data:String):void Call back indicating document view has activated.	WrapperHostBase
		addElement(element:IVisualElement):IVisualElement Adds a visual element to this container.	SkinnableContainer
		addElementAt(element:IVisualElement, index:int):IVisualElement Adds a visual element to this container.	SkinnableContainer
		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.	EventDispatcher
		addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance.	UIComponent
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		autoLoadPdf(event:Event = null):void Pre-loads the PDF rendition of the form within the PDFBox control area on the Guide layout.	WrapperHostBase
		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.	WrapperHostBase
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		cleanup():void Cleans up by releasing event listeners and zero out local variables.	WrapperHostBase
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		collectionChange(bAdded:Boolean, bRemoved:Boolean):void Called whenever a Repeater Panel adds/removes an instance.	WrapperHostBase
		connectionClosed():void The connection was closed.	WrapperHostBase
		connectionOpened(success:Boolean):void The connection was made, if success=false, the connection attempt failed	WrapperHostBase
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates.	UIComponent
		contentToLocal(point:Point):Point Converts a Point object from content to local coordinates.	UIComponent
		createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container.	UIComponent
		createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties that identify the child within this container.	UIComponent
		createDeferredContent():void Create the content for this component.	SkinnableContainer
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object.	UIComponent
		defaultCallback(msgId:int, request:String, error:FormBridgeError, parms:Array):void Default error message handler for communication with the PDF.	WrapperHostBase
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object.	UIComponent
		determineTextFormatFromStyles():mx.core:UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow.	UIComponent
		drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component.	UIComponent
		drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object.	UIComponent
		effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component.	UIComponent
		emailPDF(event:Event = null):void Forwards the request to email the PDF rendition of the Guide.	WrapperHostBase
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination.	UIComponent
		fieldChangeEx(boundObject:Object, som:String, type:String, value:Object):void This method is called whenever a field in the PDF is changed	WrapperHostBase
		fieldFocusIn(boundObject:Object, som:String, properties:Array, callback:Function = null):void This method is called whenever a field in the Guide gets the focus.	WrapperHostBase
		fieldFocusOut(boundObject:Object, som:String, value:String):void This method is called whenever a field in the Guide loses the focus.	WrapperHostBase
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		getActiveData(callback:Function = null):String Return the form's Active data, either from the Guide or the PDF.	WrapperHostBase
		getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index.	UIComponent
		getAutomationChildren():Array Provides the automation object list .	UIComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	UIComponent
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	UIComponent
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component.	UIComponent
		getData():String Return the form's data	WrapperHostBase
		getDraftData(callback:Function = null):String Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active.	WrapperHostBase
		getElementAt(index:int):IVisualElement Returns the visual element at the specified index.	SkinnableContainer
		getElementIndex(element:IVisualElement):int Returns the index position of a visual element.	SkinnableContainer
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UIComponent
		getFieldValue(som:String):Object Returns a field's value as an Object	WrapperHostBase
		getFocus():InteractiveObject Gets the object that currently has focus.	UIComponent
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	UIComponent
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	UIComponent
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	UIComponent
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	UIComponent
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	UIComponent
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	UIComponent
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	UIComponent
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	UIComponent
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	UIComponent
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	UIComponent
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getPdfData(callback:Function = null):void Gets the ga/xml data from the PDF.	WrapperHostBase
		getPdfFieldData(som:String, callback:Function = null):void Gets a fields data from the PDF.	WrapperHostBase
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	UIComponent
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	UIComponent
		getProperty(property:String):Object Return the requested property.	WrapperHostBase
		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.	DisplayObject
		getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.	UIComponent
		getRootValueObject():Object Return the model's root value object.	WrapperHostBase
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UIComponent
		globalToContent(point:Point):Point Converts a Point object from global to content coordinates.	UIComponent
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		gotData(error:FormBridgeError, data:String):void Answer received from the PDF providing requested data.	WrapperHostBase
		gotFocus(error:FormBridgeError, somExpression:String):void Called when a field in the interactive PDF get focus.	WrapperHostBase
		guideCreationComplete(event:Event = null):void Event handler called when the guide has been created.	WrapperHostBase
		guideValidationFailure(event:GAEvent):void Called when validation of field data for a panel fails.	WrapperHostBase
		hasCSSState():Boolean Returns true if currentCSSState is not null.	UIComponent
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent.	UIComponent
		hideDoc(event:Event = null):void Hides the Document of Record rendition and displays the Guide content.	WrapperHostBase
		hidePDF(event:Event = null):void Hides the PDF rendition and displays the Guide content.	WrapperHostBase
		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.	DisplayObject
		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.	DisplayObject
		horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.	UIComponent
		init(event:Event):void Called when the guide is initalized.	WrapperHostBase
		initialize():void Initializes the internal structure of this component.	UIComponent
		initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component.	UIComponent
		initializingGuide(guideSuperIn:UIComponent, guideThisIn:UIComponent, initDataIn:String):void Initializes the guide and prepares it for viewing.	WrapperHostBase
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	UIComponent
		invalidateLayering():void Called by a component's items to indicate that their depth property has changed.	UIComponent
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	UIComponent
		invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update.	UIComponent
		invalidateSize():void Marks a component so that its measure() method gets called during a later screen update.	UIComponent
		invalidateSkinState():void Marks the component so that the new state of the skin is set during a later screen update.	SkinnableComponent
		isFiberGuide():Boolean True if this guide is based off of a Fiber Model.	WrapperHostBase
		isGuideInitialized():Boolean Return whether or not the guide is initialized.	WrapperHostBase
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		isXfaGuide():Boolean True if this guide is based off of a XFA Model.	WrapperHostBase
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToContent(point:Point):Point Converts a Point object from local to content coordinates.	UIComponent
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState.	UIComponent
		matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type.	UIComponent
		measureHTMLText(htmlText:String):flash.text:TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		measureText(text:String):flash.text:TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UIComponent
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children.	UIComponent
		owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	UIComponent
		pageValidationFailure(event:GAEvent):void Called when validation of page fails.	WrapperHostBase
		panelItemFocusIn(panelItem:PanelItem):void This function is called when the panel item gains focus.	WrapperHostBase
		panelItemFocusOut(panelItem:PanelItem):void This method is called when the panel item looses focus.	WrapperHostBase
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	UIComponent
		pdfActiveInit():void This method is called when the PDF is initialized.	WrapperHostBase
		prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing.	UIComponent
		printPDF(event:Event = null):void Forwards the request to print the PDF rendition of the Guide.	WrapperHostBase
		ProcessExtMessage(msgparams:Array):void Handles incoming messages from the PDF via the HTML.	WrapperHostBase
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.	UIComponent
		registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners.	UIComponent
		removeAllElements():void Removes all visual elements from the container.	SkinnableContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeElement(element:IVisualElement):IVisualElement Removes the specified visual element from the child list of this container.	SkinnableContainer
		removeElementAt(index:int):IVisualElement Removes a visual element from the specified index position in the container.	SkinnableContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance.	UIComponent
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UIComponent
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		resetModel():void Reset the Model back to its initial load state.	WrapperHostBase
		resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided.	UIComponent
		resolvePreviewUrl(url:String, asset:String):String Resolves the preview URL.	WrapperHostBase
		resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().	UIComponent
		saveAsPDF(event:Event = null):void Forwards the request to save the PDF rendition of the Guide.	WrapperHostBase
		serverValidationFailure(validationResult:Array):void Called when server validation fails.	WrapperHostBase
		setActiveData(data:String, callback:Function = null):void Sets the data in the active view.	WrapperHostBase
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component.	UIComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setData(data:String):void Set the data into the form - returns false if failed.	WrapperHostBase
		setElementIndex(element:IVisualElement, index:int):void Changes the position of an existing visual element in the visual container.	SkinnableContainer
		setFieldValue(som:String, value:Object):Boolean Sets a field's value, returns success true or false	WrapperHostBase
		setFocus():void Sets the focus to this component.	UIComponent
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	UIComponent
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	UIComponent
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setPdfData(data:String, callback:Function = null):void Sets the ga/xml data into the PDF.	WrapperHostBase
		setPdfFieldData(som:String, type:String, value:String, callback:Function = null):void Sets a fields data into the PDF	WrapperHostBase
		setProperty(property:String, value:Object):Boolean Set the property, returns false if the operation failed	WrapperHostBase
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRootValueObject(object:Object):void Sets the model's root value object.	WrapperHostBase
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	UIComponent
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	UIComponent
		showDoc(event:Event = null):void Displays the Document of Record rendition of the form within the PDFBox control area on the Guide layout.	WrapperHostBase
		showPanelFullGuide():Boolean Return true if the panel request that the Guide is to show only panel content.	WrapperHostBase
		showPDF(event:Event = null):void Displays the PDF rendition of the form within the PDFBox control area on the Guide layout.	WrapperHostBase
		SizeDocumentView(event:Event):void Shows the PDF.	WrapperHostBase
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startGuide():void Start rendering the pages of the guide.	WrapperHostBase
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object.	DisplayObjectContainer
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		styleChanged(styleProp:String):void Detects changes to style properties.	UIComponent
		stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized.	UIComponent
		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.	WrapperHostBase
		submitDataWithCB(callback:Function):Boolean Submits the data to the server - return true if the submit was performed - returns false if validations fail	WrapperHostBase
		submitFromPDF():void This function displays the PDF rendition within the PDFBox control on the Guide layout.	WrapperHostBase
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.	UIComponent
		swapElements(element1:IVisualElement, element2:IVisualElement):void Swaps the index of the two specified visual elements.	SkinnableContainer
		swapElementsAt(index1:int, index2:int):void Swaps the visual elements at the two specified index positions in the container.	SkinnableContainer
		toggleView2(type:String, callback:Function = null):void Transfers data to or from and displays or hides the PDF or document	WrapperHostBase
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexSprite
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	UIComponent
		transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.	UIComponent
		validateDisplayList():void Validates the position and size of children and draws other visuals.	UIComponent
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UIComponent
		validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method.	UIComponent
		validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.	UIComponent
		validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.	UIComponent
		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.	EventDispatcher

Protected Methods

	Method		Defined By
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.	UIComponent
		attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect.	UIComponent
		attachSkin():void Create the skin for the component.	SkinnableComponent
		canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped.	UIComponent
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		clearSkinParts():void Clear out references to skin parts.	SkinnableComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createChildren():void [override] Create content children, if the creationPolicy property is not equal to none.	SkinnableContainer
		createDynamicPartInstance(partName:String):Object Create an instance of a dynamic skin part.	SkinnableComponent
		createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used.	UIComponent
		createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory.	UIComponent
		detachSkin():void Destroys and removes the skin for this component.	SkinnableComponent
		dispatchPropertyChangeEvent(prop:String, oldValue:, value:):void Helper method for dispatching a PropertyChangeEvent when a property is updated.	UIComponent
		findSkinParts():void Find the skin parts in the skin class and assign them to the properties of the component.	SkinnableComponent
		focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus.	UIComponent
		focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus.	UIComponent
		getCurrentSkinState():String [override] Returns the name of the state to be applied to the skin.	SkinnableContainerBase
		getDynamicPartAt(partName:String, index:int):Object Returns a specific instance of a dynamic part.	SkinnableComponent
		initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.	UIComponent
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	UIComponent
		invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).	UIComponent
		isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus.	UIComponent
		keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event.	UIComponent
		keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event.	UIComponent
		measure():void Calculates the default size, and optionally the default minimum size, of the component.	UIComponent
		numDynamicParts(partName:String):int Returns the number of instances of a dynamic part.	SkinnableComponent
		partAdded(partName:String, instance:Object):void [override] Called when a skin part is added.	SkinnableContainer
		partRemoved(partName:String, instance:Object):void [override] Called when an instance of a skin part is being removed.	SkinnableContainer
		removeDynamicPartInstance(partName:String, instance:Object):void Remove an instance of a dynamic part.	SkinnableComponent
		resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	UIComponent
		setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction.	UIComponent
		stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component.	UIComponent
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Draws the object and/or sizes and positions its children.	UIComponent

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
add	Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.	UIComponent
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
contentCreationComplete	Dispatched after the content for this component has been created.	SkinnableContainer
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the currentState property changes, but before the view state changes.	UIComponent
cut	Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
dragComplete	Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.	UIComponent
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
effectStop	Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.	UIComponent
elementAdd	Dispatched when a visual element is added to the content holder.	SkinnableContainer
elementRemove	Dispatched when a visual element is removed from the content holder.	SkinnableContainer
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
enterState	Dispatched after the component has entered a view state.	UIComponent
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
exitState	Dispatched just before the component exits a view state.	UIComponent
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
gestureLongPress	Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gesturePan	Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureRotate	Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureSwipe	Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureTap	Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureZoom	Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
proximityBegin	Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.	InteractiveObject
proximityEnd	Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.	InteractiveObject
proximityMove	Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.	InteractiveObject
proximityOut	Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityOver	Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOut	Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOver	Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).	InteractiveObject
releaseOutside	Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.	InteractiveObject
remove	Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.	UIComponent
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched when the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
selectAll	Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
softKeyboardActivate	Dispatched immediately after the soft keyboard is raised.	InteractiveObject
softKeyboardActivating	Dispatched immediately before the soft keyboard is raised.	InteractiveObject
softKeyboardDeactivate	Dispatched immediately after the soft keyboard is lowered.	InteractiveObject
stateChangeComplete	Dispatched after the component has entered a new state and any state transition animation to that state has finished playing.	UIComponent
stateChangeInterrupted	Dispatched when a component interrupts a transition to its current state in order to switch to a new state.	UIComponent
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.	UIComponent
touchBegin	Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).	InteractiveObject
touchEnd	Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).	InteractiveObject
touchInteractionEnd	A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.	UIComponent
touchInteractionStart	A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.	UIComponent
touchInteractionStarting	A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.	UIComponent
touchMove	Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.	InteractiveObject
touchOut	Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).	InteractiveObject
touchOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOut	Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchTap	Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
updateComplete	Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

	Description	Defined By
alignmentBaseline	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the baseline to which the dominant baseline aligns.	SkinnableContainer
baseline	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position.	UIComponent
baselineShift	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Amount to shift the baseline.	SkinnableContainer
blockProgression	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies a vertical or horizontal progression of line placement.	SkinnableContainer
bottom	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.	UIComponent
breakOpportunity	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls where lines are allowed to break when breaking wrapping text into multiple lines.	SkinnableContainer
cffHinting	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of CFF hinting used for this text.	SkinnableContainer
clearFloats	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls how text wraps around a float.	SkinnableContainer
color	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of the text.	SkinnableContainer
digitCase	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of digit case used for this text.	SkinnableContainer
digitWidth	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Type of digit width used for this text.	SkinnableContainer
direction	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the default bidirectional embedding level of the text.	SkinnableContainer
dominantBaseline	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies which element baseline snaps to the `alignmentBaseline` to determine the vertical position of the element on the line.	SkinnableContainer
errorColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails.	UIComponent
errorSkin	Type: Class Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Name of the skin class to use for this component when a validation error occurs.	SkinnableComponent
firstBaselineOffset	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the baseline position of the first line in the container.	SkinnableContainer
focusedTextSelectionColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is enabled and has focus.	SkinnableContainer
focusSkin	Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle.	UIComponent
fontFamily	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The name of the font to use, or a comma-separated list of font names.	SkinnableContainer
fontLookup	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Font lookup to use.	SkinnableContainer
fontSize	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Height of the text, in pixels.	SkinnableContainer
fontStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is italic font.	SkinnableContainer
fontWeight	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is boldface.	SkinnableContainer
horizontalCenter	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component.	UIComponent
inactiveTextSelectionColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is disabled.	SkinnableContainer
interactionMode	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component.	UIComponent
justificationRule	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Rule used to justify text in a paragraph.	SkinnableContainer
justificationStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The style used for justification of the paragraph.	SkinnableContainer
kerning	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The style used for justification of the paragraph.	SkinnableContainer
layoutDirection	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component.	UIComponent
leadingModel	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the leading model, which is a combination of leading basis and leading direction.	SkinnableContainer
left	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.	UIComponent
ligatureLevel	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls which of the ligatures that are defined in the font may be used in the text.	SkinnableContainer
lineHeight	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Leading controls for the text.	SkinnableContainer
lineThrough	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 If true, applies strikethrough, a line drawn through the middle of the text.	SkinnableContainer
listAutoPadding	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 This specifies an auto indent for the start edge of lists when the padding value of the list on that side is `auto`.	SkinnableContainer
listStylePosition	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 This controls the placement of a list item marker relative to the list item.	SkinnableContainer
listStyleType	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 This controls the appearance of items in a list.	SkinnableContainer
locale	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The locale of the text.	SkinnableContainer
paragraphEndIndent	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount to indent the paragraph's end edge.	SkinnableContainer
paragraphSpaceAfter	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of space to leave after the paragraph.	SkinnableContainer
paragraphSpaceBefore	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of space to leave before the paragraph.	SkinnableContainer
paragraphStartIndent	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount to indent the paragraph's start edge.	SkinnableContainer
renderingMode	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The rendering mode used for this text which applies only to embedded fonts.	SkinnableContainer
right	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.	UIComponent
showErrorSkin	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid	UIComponent
showErrorTip	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it	UIComponent
skinClass	Type: Class Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Name of the skin class to use for this component.	SkinnableComponent
tabStops	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the tab stops associated with the paragraph.	SkinnableContainer
textAlign	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alignment of text within a container.	SkinnableContainer
textAlignLast	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alignment of the last line in the paragraph relative to the container in justified text.	SkinnableContainer
textAlpha	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha (transparency) value for the text.	SkinnableContainer
textDecoration	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is underlined.	SkinnableContainer
textIndent	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Offset of first line of text from the left side of the container.	SkinnableContainer
textJustify	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies options for justifying text.	SkinnableContainer
textRotation	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines the number of degrees to rotate this text.	SkinnableContainer
top	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.	UIComponent
touchDelay	Type: Number Format: Time CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.5 When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state.	SkinnableContainer
trackingLeft	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of tracking (manual kerning) to be applied to the left of each character.	SkinnableContainer
trackingRight	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of tracking (manual kerning) to be applied to the right of each character.	SkinnableContainer
typographicCase	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of typographic case used for this text.	SkinnableContainer
unfocusedTextSelectionColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is enabled but does not have focus.	SkinnableContainer
verticalCenter	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component.	UIComponent
whiteSpaceCollapse	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Collapses or preserves whitespace when importing text into a TextFlow.	SkinnableContainer
wordSpacing	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.5, AIR 2.0 Specifies the spacing between words to use during justification.	SkinnableContainer

Spark Theme Styles

Click for more information on styles

	Description	Defined By
accentColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Accent color used by component skins.	SkinnableContainer
alternatingItemColors	Type: Array Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The colors to use for the backgrounds of the items in the list.	SkinnableContainer
backgroundAlpha	Type: Number CSS Inheritance: No Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha level of the background for this component.	SkinnableContainer
backgroundColor	Type: uint Format: Color CSS Inheritance: No Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Background color of a component.	SkinnableContainer
chromeColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The main color for a component.	SkinnableComponent
contentBackgroundAlpha	Type: Number CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The alpha of the content background for this component.	SkinnableContainer
contentBackgroundColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of the content background for this component.	SkinnableContainer
focusColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of focus ring when the component is in focus.	SkinnableContainer
rollOverColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of the highlights when the mouse is over the component.	SkinnableContainer
symbolColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of any symbol of a component.	SkinnableContainer

Mobile Theme Styles

Click for more information on styles

	Description	Defined By
accentColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Accent color used by component skins.	SkinnableContainer
alternatingItemColors	Type: Array Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The colors to use for the backgrounds of the items in the list.	SkinnableContainer
backgroundAlpha	Type: Number CSS Inheritance: No Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha level of the background for this component.	SkinnableContainer
backgroundColor	Type: uint Format: Color CSS Inheritance: No Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Background color of a component.	SkinnableContainer
chromeColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The main color for a component.	SkinnableComponent
contentBackgroundAlpha	Type: Number CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The alpha of the content background for this component.	SkinnableContainer
contentBackgroundColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of the content background for this component.	SkinnableContainer
downColor	Type: uint Format: Color CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.5 Color of the background of an item renderer when it is being pressed down If `downColor` is set to `undefined`, `downColor` is not used. The default value for the Spark theme is `undefined`.	SkinnableContainer
focusColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of focus ring when the component is in focus.	SkinnableContainer
leading	Type: Number Format: Length CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.0 Additional vertical space between lines of text.	SkinnableContainer
letterSpacing	Type: Number CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.0 The number of additional pixels to appear between each character.	SkinnableContainer
symbolColor	Type: uint Format: Color CSS Inheritance: Yes Theme: spark, mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of any symbol of a component.	SkinnableContainer
textShadowAlpha	Type: Number CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha of text shadows.	SkinnableContainer
textShadowColor	Type: uint Format: Color CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of text shadows.	SkinnableContainer

Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.

Click for more information on skins

	Skin Part		Description	Defined By
		contentGroup:Group	Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 An optional skin part that defines the Group where the content children get pushed into and laid out.	SkinnableContainer

Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.

Click for more information on skins

	Skin State		Description	Defined By
		disabled	Disabled State Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5	SkinnableContainerBase
		normal	Normal State Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5	SkinnableContainerBase

Effects

Click for more information on effects

	Description	Defined By
addedEffect	Triggering Event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering Event: creationComplete Played when the component is created.	UIComponent
focusInEffect	Triggering Event: focusIn Played when the component gains keyboard focus.	UIComponent
focusOutEffect	Triggering Event: focusOut Played when the component loses keyboard focus.	UIComponent
hideEffect	Triggering Event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering Event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering Event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering Event: move Played when the component is moved.	UIComponent
removedEffect	Triggering Event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering Event: resize Played when the component is resized.	UIComponent
rollOutEffect	Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering Event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering Event: show Played when the component becomes visible.	UIComponent

Public Constants

	Constant		Defined By

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

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
public function set currentPage(value:Page):void

currentPanel

property

currentPanel:Panel

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
public function set currentPanel(value:Panel):void

currentPanelItem

property

currentPanelItem:PanelItem

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
public function set currentPanelItem(value:PanelItem):void

currentSection

property

currentSection:Section

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
public function set currentSection(value:Section):void

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

includeNavigationMinHeight

property

includeNavigationMinHeight:int

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 minimal height such that the navigation will collapse if the height is less than the value.

Implementation
public function get includeNavigationMinHeight():int
public function set includeNavigationMinHeight(value:int):void

includeNavigationMinWidth

property

includeNavigationMinWidth:int

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 minimal width such that the navigation container will collapse if the width is less than the value.

Implementation
public function get includeNavigationMinWidth():int
public function set includeNavigationMinWidth(value:int):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

model

property

model:IWrapperModel [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 Model behind the wrapper host component.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get model():IWrapperModel

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

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
public function set submitAll(value:Boolean):void

Constructor Detail

WrapperHostBase

()

Constructor

public function 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

Constructor

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.

connectionClosed

()

method

public function connectionClosed():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

The connection was closed.

connectionOpened

()

method

public function connectionOpened(success: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

The connection was made, if success=false, the connection attempt failed

Parameters

success:Boolean — the status of the open request

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.

getActiveData

()

method

public function getActiveData(callback:Function = null):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

Return the form's Active data, either from the Guide or the PDF. PDF requires a callback.

Parameters

callback:Function (default = null) — the function to be called when an asynchronous operation is required to retrieve the data, as when the PDF is active.

Returns

String — String

getData

()

method

public function getData():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

Return the form's data

Returns

String — String

getDraftData

()

method

public function getDraftData(callback:Function = null):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

Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. PDF requires a callback).

Parameters

callback:Function (default = null) — the function to be called when an asynchronous operation is required to retrieve the data, as when the PDF is active.

Returns

String — String

getFieldValue

()

method

public function getFieldValue(som:String):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

Returns a field's value as an Object

Parameters

som:String — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")

Returns

Object — Object

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.

getProperty

()

method

public function getProperty(property:String):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

Return the requested property. Sypported properties are: showSubmitButton = "true"|"false"

Parameters

property:String — the name of the property to retieve a value from

Returns

Object — Object

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

Return the model's root value object.

Returns

Object — the root value object of the model.

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

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 function is called when the panel item gains focus.

Parameters

panelItem:PanelItem — instance of the PanelItem which has lost 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 when the panel item looses focus. This is available here in case an extension wants to override this behaviour does nothing otherwise.

Parameters

panelItem:PanelItem — instance of the PanelItem which 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.

setData

()

method

public function setData(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

Set the data into the form - returns false if failed. Throws an exception if the data is not valid XML.

Parameters

data:String — the content to be used as the current data

setFieldValue

()

method

public function setFieldValue(som:String, value:Object):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

Sets a field's value, returns success true or false

Parameters

	`som:String` — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")

	`value:Object` — the value to assign to the targeted item

Returns

Boolean — Boolean

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.

setProperty

()

method

public function setProperty(property:String, value:Object):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

Set the property, returns false if the operation failed

Parameters

	`property:String` — the name of the property to retieve a value from

	`value:Object` — the value to set the provided property with. Object types must match

Returns

Boolean — Boolean

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

Sets the model's root value object.

Parameters

object:Object — root value object to set into the model.

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

Return true if the panel request that the Guide is to show only panel content. Return false otherwise.

Returns

Boolean — true if only panel content is to be shown, false otherwise.

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.

submitData

()

method

public function submitData():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

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. This method returns true if the submission performs successfully.

SubmitFrom option	Behavior
Guide	Submits the Guide data to the Document Server.
PDF	Displays the PDF rendition of the Guide. A user then clicks the appropriate submit button on the PDF form.
Printed Form	Displays the PDF rendition of the Guide. A user then prints the PDF and submits the form manually.
Hosted Application	The submit button does not display on the last panel of the Guide. This option transfer control of the Guide submission to the hosting application. In this case, a user clicks a button within the hosting application, for example the Complete button within Adobe Digital Enterprise Platform Document Services - Workspace 10.0, to submit the Guide data.

Returns

Boolean — Boolean

submitDataWithCB

()

method

public function submitDataWithCB(callback:Function):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

Submits the data to the server - return true if the submit was performed - returns false if validations fail

Parameters

callback:Function — the function to be called when the submit is an asynchronous operation (default)

Returns

Boolean — Boolean

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, 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 = `NaN`) — 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

WrapperHostBase - AS3 ADEP Guides

Classes x

activeViewType

currentPage

currentPanel

currentPanelItem

currentSection

guideConnectionActive

guideExternalInterfaceAvailable

guideView

includeNavigationMinHeight

includeNavigationMinWidth

interactivePdfLoad

interactivePdfUrl

isLoadingInteractivePdf

lcx

model

panelManager

pdfActive

pdfAvailable

pdfCommunicationActive

pdfLoadErrorMessage

pdfProcessFocus

pdfRequiredFallbackUrl

performanceLog

previewAsset

previewAvailable

previewUrl

resizeToContent

showControlSection

showHeaderSection

showHelpCenter

showNavHelpSection

showNavigator

showNextPrev

showRepeaterControls

showSubmitButton

showTitleBar

showToolBar

submitAll

WrapperHostBase

activateDocumentViewCB

autoLoadPdf

CallHtml

cleanup

collectionChange

connectionClosed

connectionOpened

defaultCallback

emailPDF

fieldChangeEx

fieldFocusIn

fieldFocusOut

getActiveData

getData

getDraftData

getFieldValue

getPdfData

getPdfFieldData

getProperty

getRootValueObject

gotData

gotFocus

guideCreationComplete

guideValidationFailure

hideDoc

hidePDF

init

initializingGuide

isFiberGuide

isGuideInitialized

isXfaGuide

pageValidationFailure

panelItemFocusIn

panelItemFocusOut

pdfActiveInit

printPDF

ProcessExtMessage

resetModel

resolvePreviewUrl