ga.controls.Wrapper (Livecycle)

Public Properties

	Property		Defined By
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		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.	Container
		automationDelegate : Object The delegate object that handles the automation-related functionality.	UIComponent
		automationName : String	UIComponent
		automationTabularData : Object [read-only]	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
		baselinePosition : Number [read-only] The vertical distance (in pixels) between the top of the container and the baseline of the first line of text.	Container
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		borderMetrics : EdgeMetrics [read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.	Container
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash Player caches an internal bitmap representation of the display object.	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
		childDescriptors : Array [read-only] Array of UIComponentDescriptor objects produced by the MXML compiler.	Container
		className : String [read-only] The name of this instance's class, such as "Button".	UIComponent
		clipContent : Boolean Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.	Container
		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.	Container
		contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system.	Container
		contextMenu : ContextMenu Specifies the context menu associated with this object.	InteractiveObject
		creationIndex : int Specifies the order to instantiate and draw the children of the container.	Container
		creationPolicy : String The child creation policy for this Container.	Container
		currentPage : Page [read-only] The current page which implements the IPanel interface.	Wrapper
		currentSection : Section [read-only] The current section.	Wrapper
		currentState : String The current view state of the component.	UIComponent
		data : Object The data property lets you pass a value to the component when you use it in an item renderer or item editor.	Container
		defaultButton : IFlexDisplayObject The Button control designated as the default button for the container.	Container
		descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.	UIComponent
		direction : String The direction in which this Box container lays out its children.	Box
		document : Object A reference to the document object associated with this UIComponent.	UIComponent
		doubleClickEnabled : Boolean 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 will be 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 Number that specifies the maximum height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxWidth : Number Number that specifies the maximum width of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMinHeight : Number Number that specifies the minimum height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMinWidth : Number Number that specifies the minimum width of the component, in pixels, in the component's coordinates.	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
		focusEnabled : Boolean Indicates whether the component can receive focus when clicked on.	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 = false Indicates if a host SWF is communicating with the form guide through a local connection.	Wrapper
		guideView : Boolean = true Indicates whether the form guide SWF or the PDF has current input and control.	Wrapper
		height : Number 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
		horizontalLineScrollSize : Number Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.	Container
		horizontalPageScrollSize : Number Number of pixels to move when the track in the horizontal scroll bar is pressed.	Container
		horizontalScrollBar : ScrollBar The horizontal scrollbar used in this container.	Container
		horizontalScrollPolicy : String Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.	Container
		horizontalScrollPosition : Number The current position of the horizontal scroll bar.	Container
		icon : Class The Class of the icon displayed by some navigator containers to represent this Container.	Container
		id : String ID of the component.	UIComponent
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UIComponent
		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
		instance : Wrapper [static] [read-only] The singleton instance of the wrapper.	Wrapper
		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
		isDocument : Boolean [read-only] Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.	UIComponent
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UIComponent
		label : String The text displayed by some navigator containers to represent this Container.	Container
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		maxHeight : Number Number that specifies the maximum height of the component, in pixels, in the component's coordinates.	UIComponent
		maxHorizontalScrollPosition : Number [read-only] The largest possible value for the horizontalScrollPosition property.	Container
		maxVerticalScrollPosition : Number [read-only] The largest possible value for the verticalScrollPosition property.	Container
		maxWidth : Number Number that specifies the maximum width of the component, in pixels, in the component's coordinates.	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
		minHeight : Number Number that specifies the minimum height of the component, in pixels, in the component's coordinates.	UIComponent
		minWidth : Number Number that specifies the minimum width of the component, in pixels, in the component's coordinates.	UIComponent
		moduleFactory : IFlexModuleFactory	UIComponent
		mouseChildren : Boolean Determines whether or not the children of the object are mouse enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		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]	UIComponent
		numChildren : int [read-only] Number of child components in this container.	Container
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		owner : DisplayObjectContainer The owner of this UIComponent.	UIComponent
		pageManager : PageManager [read-only] The page manager.	Wrapper
		parent : DisplayObjectContainer [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 = false Indicates that the form guide has successfully communicated with the PDF.	Wrapper
		percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size.	UIComponent
		percentWidth : Number Number that specifies the width of a component as a percentage of its parent's size.	UIComponent
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	UIComponent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		rawChildren : IChildList [read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property.	Container
		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
		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 Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number Number that specifies the vertical scaling percentage.	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
		showInAutomationHierarchy : Boolean	UIComponent
		showSubmitButton : Boolean = true Indicates whether to show the submit button on the last panel.	Wrapper
		soundTransform : 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
		styleName : Object The class style used by this component.	UIComponent
		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
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		toolTip : String Text to display in the ToolTip.	UIComponent
		transform : Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		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 mouse 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
		verticalLineScrollSize : Number Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed.	Container
		verticalPageScrollSize : Number Number of pixels to scroll when the track in the vertical scroll bar is pressed.	Container
		verticalScrollBar : ScrollBar The vertical scrollbar used in this container.	Container
		verticalScrollPolicy : String Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.	Container
		verticalScrollPosition : Number The current position of the vertical scroll bar.	Container
		viewMetrics : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom.	Container
		viewMetricsAndPadding : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom.	Container
		visible : Boolean Controls the visibility of this UIComponent.	UIComponent
		width : Number Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		x : Number Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		y : Number Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent

	Property	Defined By
		actualCreationPolicy : String The creation policy of this container.	Container
		unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component All of a component's drawing and child layout should be done within a bounding rectangle of this height, which is also passed as an argument to updateDisplayList().	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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Wrapper() Constructor	Wrapper
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject to this Container.	Container
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject to this Container.	Container
		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
		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
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		connectionClosed():void This method is called when the local connection with the host SWF has been closed.	Wrapper
		connectionOpened(success:Boolean):void This method is called when a host SWF has attempted to perform a local connection with the form guide.	Wrapper
		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.	Container
		contentToLocal(point:Point):Point Converts a Point object from content to local coordinates.	Container
		createAutomationIDPart(child:IAutomationObject):Object	UIComponent
		createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.	Container
		createComponentsFromDescriptors(recurse:Boolean = true):void Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.	Container
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void	UIComponent
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void	UIComponent
		determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean	UIComponent
		drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component.	UIComponent
		drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void Programatically draws a rectangle into this skin's Graphics object.	UIComponent
		effectFinished(effectInst:EffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:EffectInstance):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 form guide.	Wrapper
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void Executes all the data bindings on this Container.	Container
		executeChildBindings(recurse:Boolean):void Executes the bindings into this Container's child UIComponent objects.	Container
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		getActiveData(callback:Function = null):String Retrieves the XML data from the active view.	Wrapper
		getAutomationChildAt(index:int):IAutomationObject	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
		getChildAt(index:int):DisplayObject Gets the nth child component object.	Container
		getChildByName(name:String):DisplayObject Returns the child whose name property is the specified String.	Container
		getChildIndex(child:DisplayObject):int Gets the zero-based index of a specific child.	Container
		getChildren():Array Returns an Array of DisplayObject objects consisting of the content children of the container.	Container
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		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
		getFocus():InteractiveObject Gets the object that currently has focus.	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
		getProperty(property:String):Object This method is called when the host SWF gets a property from the form guide through a local connection.	Wrapper
		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
		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.	Container
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		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
		hidePDF(event:Event = null):void Hides the PDF rendition and displays the form guide content.	Wrapper
		hitTestObject(obj:DisplayObject):Boolean Evaluates the display object to see if it overlaps or intersects with 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
		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
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	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
		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
		localToContent(point:Point):Point Converts a Point object from local to content coordinates.	Container
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which may 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):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField 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 Propagate 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
		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.	Wrapper
		pixelsToPercent(pxl:Number):Number Method used to convert number of pixels to a percentage relative to the contents of this container.	Box
		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 form guide.	Wrapper
		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, register the EffectManager as one of the event listeners.	UIComponent
		removeAllChildren():void Removes all children from the child list of this container.	Container
		removeChild(child:DisplayObject):DisplayObject Removes a child DisplayObject from the child list of this Container.	Container
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the child list of this Container at the specified index.	Container
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		replayAutomatableEvent(event:Event):Boolean	UIComponent
		resolveAutomationIDPart(criteria:Object):Array	UIComponent
		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 form guide.	Wrapper
		setActiveData(data:String, callback:Function = null):void Sets the data in the active view.	Wrapper
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setChildIndex(child:DisplayObject, newIndex:int):void Sets the index of a particular child.	Container
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setProperty(property:String, value:Object):Boolean This method is called when the host SWF sets a property on the form guide through a local connection.	Wrapper
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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
		showPDF(event:Event = null):void Displays the PDF rendition of the form within the PDFBox control on the form guide layout.	Wrapper
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stopDrag():void Ends the startDrag() method.	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 Guide Builder.	Wrapper
		submitFromPDF():void This function displays the PDF rendition within the PDFBox control on the form guide layout.	Wrapper
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.	UIComponent
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toString():String Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexSprite
		validateDisplayList():void	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	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

	Method	Defined By
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		attachOverlay():void Used internally by the Dissolve Effect to add the overlay to the chrome of a container.	Container
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createBorder():void Creates the container's border skin if it is needed and does not already exist.	Container
		createChildren():void Create child objects of the component.	UIComponent
		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
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	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
		layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Respond to size changes by setting the positions and sizes of this container's borders.	Container
		measure():void Calculates the default sizes and minimum and maximum values of the Box container.	Box
		scrollChildren():void Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.	Container
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Sets the size and position of each child of the Box container.	Box

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	Dispatched when Flash Player 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() or addChildAt() 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
childAdd	Dispatched after a child has been added to a container.	Container
childIndexChange	Dispatched after the index (among the container children) of a container child changes.	Container
childRemove	Dispatched before a child of a container is removed.	Container
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	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
dataChange	Dispatched when the data property changes.	Container
deactivate	Dispatched when Flash Player loses operating 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
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
enterFrame	Dispatched when the playhead is entering a new frame.	DisplayObject
enterState	Dispatched after the component has returned to the root view state.	UIComponent
exitState	Dispatched before the component exits from the root view state.	UIComponent
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
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
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance in the Flash Player window.	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 in the Flash Player window.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance in the Flash Player window.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance in the Flash Player window.	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
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
remove	Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() 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	Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched when the component is resized.	UIComponent
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
scroll	Dispatched when the user manually scrolls the container.	Container
show	Dispatched when an object's state changes from invisible to visible.	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
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 will 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
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

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
backgroundAlpha	Type: Number CSS Inheritance: no Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style.	Container
backgroundAttachment	Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport (`"fixed"`) or scrolls along with the content (`"scroll"`).	Container
backgroundColor	Type: uint Format: Color CSS Inheritance: no Background color of a component.	Container
backgroundDisabledColor	Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled.	Container
backgroundImage	Type: Object Format: File CSS Inheritance: no Background image of a component.	Container
backgroundSize	Type: String CSS Inheritance: no Scales the image specified by `backgroundImage` to different percentage sizes.	Container
barColor	Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar.	Container
borderColor	Type: uint Format: Color CSS Inheritance: no Color of the border.	Container
borderSides	Type: String CSS Inheritance: no Bounding box sides.	Container
borderSkin	Type: Class CSS Inheritance: no The border skin of the component.	Container
borderStyle	Type: String CSS Inheritance: no Bounding box style.	Container
borderThickness	Type: Number Format: Length CSS Inheritance: no Bounding box thickness.	Container
bottom	Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its parent container.	UIComponent
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label.	Container
cornerRadius	Type: Number Format: Length CSS Inheritance: no Radius of component corners.	Container
disabledColor	Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled.	Container
disabledOverlayAlpha	Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled.	Container
dropShadowColor	Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow.	Container
dropShadowEnabled	Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow.	Container
errorColor	Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.	UIComponent
fontAntiAliasType	Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields.	Container
fontFamily	Type: String CSS Inheritance: yes Name of the font to use.	Container
fontGridFitType	Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls.	Container
fontSharpness	Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls.	Container
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels.	Container
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font.	Container
fontThickness	Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls.	Container
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface.	Container
horizontalAlign	Type: String CSS Inheritance: no Horizontal alignment of children in the container.	Box
horizontalCenter	Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the center of the component's parent container to the center of the component.	UIComponent
horizontalGap	Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction.	Box
horizontalScrollBarStyleName	Type: String CSS Inheritance: no The name of the horizontal scrollbar style.	Container
kerning	Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`).	Container
left	Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's parent container to the left edge of the component.	UIComponent
letterSpacing	Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character.	Container
paddingBottom	Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's bottom border and the bottom of its content area.	Box
paddingLeft	Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's left border and the left edge of its content area.	Container
paddingRight	Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's right border and the right edge of its content area.	Container
paddingTop	Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and the top of its content area.	Box
right	Type: Number Format: Length CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its parent container.	UIComponent
shadowDirection	Type: String CSS Inheritance: no Direction of the drop shadow.	Container
shadowDistance	Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow.	Container
textAlign	Type: String CSS Inheritance: yes Alignment of text within a container.	Container
textDecoration	Type: String CSS Inheritance: no Determines whether the text is underlined.	Container
textIndent	Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels.	Container
themeColor	Type: uint Format: Color CSS Inheritance: yes Theme color of a component.	UIComponent
top	Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the top edge of the component's parent container to the top edge of the component.	UIComponent
verticalAlign	Type: String CSS Inheritance: no Vertical alignment of children in the container.	Box
verticalCenter	Type: Number Format: Length CSS Inheritance: no The vertical distance in pixels from the center of the component's parent container to the center of the component.	UIComponent
verticalGap	Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction.	Box
verticalScrollBarStyleName	Type: String CSS Inheritance: no The name of the vertical scrollbar style.	Container

	Constant	Defined By
		DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property.	UIComponent
		DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property.	UIComponent
		DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property.	UIComponent
		DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property.	UIComponent

Property Detail

currentPage

property

currentPage:Page [read-only]

The current page which implements the IPanel interface.

This property can be used as the source for data binding.

Implementation
public function get currentPage():Page

currentSection

property

currentSection:Section [read-only]

The current section.

This property can be used as the source for data binding.

Implementation
public function get currentSection():Section

guideConnectionActive

property

public var guideConnectionActive:Boolean = false

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

This property can be used as the source for data binding.

guideView

property

public var guideView:Boolean = true

Indicates whether the form guide SWF or the PDF has current input and control.

The value of this flag is set according to the following rules:

True when form guide has ownership.
False when the PDF has ownership and is currently visible to a user.

This property can be used as the source for data binding.

instance

property

instance:Wrapper [read-only]

The singleton instance of the wrapper.

Implementation
public static function get instance():Wrapper

pageManager

property

pageManager:PageManager [read-only]

The page manager.

Implementation
public function get pageManager():PageManager

pdfActive

property

public var pdfActive:Boolean = false

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

This property can be used as the source for data binding.

showSubmitButton

property

public var showSubmitButton:Boolean = true

Indicates whether to show the submit button on the last panel. This variable is set through local connection.

This property can be used as the source for data binding.

Constructor Detail

Wrapper

()

Constructor

public function Wrapper()

Constructor

Method Detail

connectionClosed

()

method

public function connectionClosed():void

This method is called when the local connection with the host SWF has been closed.

connectionOpened

()

method

public function connectionOpened(success:Boolean):void

This method is called when a host SWF has attempted to perform a local connection with the form guide.

Parameters

success:Boolean

emailPDF

()

method

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

Forwards the request to email the PDF rendition of the form guide. If no PDF was rendered with the form guide, this function does not perform an action.

Parameters

event:Event (default = null)

getActiveData

()

method

public function getActiveData(callback:Function = null):String

Retrieves the XML data from the active view.

If a callback function is provided, the data is retrieved from the active view whether it's the form guide or the PDF. If no calback function is provided, this function immediately returns the data from the form guide. The callback function requires two string parameters, error:String and data:String. If error is not null, then the data parameter is undefined.

Parameters

callback:Function (default = null)

Returns

String

getProperty

()

method

public function getProperty(property:String):Object

This method is called when the host SWF gets a property from the form guide through a local connection. The following properties are supported: ShowSubmitButton" and SubmitFrom.

Parameters

property:String

Returns

Object

hidePDF

()

method

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

Hides the PDF rendition and displays the form guide content. Any data the user entered into the fields on the PDF rendition automatically appear in the corresponding form guide fields. If no PDF was rendered with the form guide, this function does not perform an action.

Parameters

event:Event (default = null)

pdfActiveInit

()

method

public function pdfActiveInit():void

This method is called when the PDF is initialized.

printPDF

()

method

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

Forwards the request to print the PDF rendition of the form guide. If no PDF was rendered with the form guide, this function does not perform an action.

Parameters

event:Event (default = null)

saveAsPDF

()

method

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

Forwards the request to save the PDF rendition of the form guide. If no PDF was rendered with the form guide, this function does not perform an action.

Parameters

event:Event (default = null)

setActiveData

()

method

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

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

	`callback:Function` (default = `null`)

setProperty

()

method

public function setProperty(property:String, value:Object):Boolean

This method is called when the host SWF sets a property on the form guide through a local connection. The following properties are supported: ShowSubmitButton and SubmitFrom.

Parameters

	`property:String`

	`value:Object`

Returns

Boolean

showPDF

()

method

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

Displays the PDF rendition of the form within the PDFBox control on the form guide layout. If no PDF was rendered with the form guide, this function does not perform an action.

Parameters

event:Event (default = null)

submitData

()

method

public function submitData():Boolean

Performs the submit action based on the value of the Submit From option in Guide Builder. This method returns true if the submission performs successfully.

SubmitFrom option	Behavior
Guide	Submits the form guide data to the LiveCycle ES server.
PDF	Displays the PDF rendition of the form guide. A user then clicks the appropriate submit button on the PDF form.
Printed Form	Displays the PDF rendition of the form 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 form guide. This option transfer control of the form guide submission to the hosting application. In this case, a user clicks a button within the hosting application, for example the Complete button within LiveCycle WorkSpace ES, to submit the form guide data.

Returns

Boolean

submitFromPDF

()

method

public function submitFromPDF():void

This function displays the PDF rendition within the PDFBox control on the form guide layout. A user must click the appropriate submit button to complete the data submission.

If no PDF was rendered with the form guide, this function sends the data to the LiveCycle ES server which renders the form as a PDF, and returns it to the user to complete the submission.

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/ga/controls/Wrapper.html

Livecycle ES API Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
Wrapper	Properties \| Methods \| Events \| Styles \| Effects \| Constants

	Effect		Description	Defined By
		addedEffect	Triggering Event: added
		creationCompleteEffect	Triggering Event: creationComplete
		hideEffect	Triggering Event: hide
		mouseDownEffect	Triggering Event: mouseDown
		mouseUpEffect	Triggering Event: mouseUp
		moveEffect	Triggering Event: move
		removedEffect	Triggering Event: removed
		resizeEffect	Triggering Event: resize
		rollOutEffect	Triggering Event: rollOut
		rollOverEffect	Triggering Event: rollOver
		showEffect	Triggering Event: show

Package	ga.controls
Class	public class Wrapper
Inheritance	Wrapper Box Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object